Comments (3)
Commander does support multiple lines in descriptions; for example, this script is pretty close to what you describe:
require 'commander/import'
program :name, 'Foo Bar'
program :version, '1.0.0'
program :description, <<DESC
Author:
ABC did most of the work
DEF also worked on this
DESC
However, the help formatter currently doesn't do anything to preserve indentation for multiline strings, so the indentation is not consistent between the first line and the following lines.
If you're interested in making a patch to fix this, I would look at the help formatter ERB files: https://github.com/visionmedia/commander/blob/master/lib/commander/help_formatters/terminal/help.erb#L7
https://github.com/visionmedia/commander/blob/master/lib/commander/help_formatters/terminal/command_help.erb#L15
And maybe implement an indentation helper in https://github.com/visionmedia/commander/blob/master/lib/commander/help_formatters/terminal.rb or https://github.com/visionmedia/commander/blob/master/lib/commander/help_formatters/base.rb
from commander.
Thanks for the rapid reply, I’ll have a look and submit something.
Allen.
From: Gabriel Gilder [mailto:[email protected]]
Sent: June-02-13 3:06 PM
To: visionmedia/commander
Cc: Allen Mitchell
Subject: Re: [commander] Multiple line in description, help details.... (#54)
Commander does support multiple lines in descriptions; for example, this script is pretty close to what you describe:
require 'commander/import'
program :name, 'Foo Bar'
program :version, '1.0.0'
program :description, <<DESC
Author:
ABC did most of the work
DEF also worked on this
DESC
However, the help formatter currently doesn't do anything to preserve indentation for multiline strings, so the indentation is not consistent between the first line and the following lines.
If you're interested in making a patch to fix this, I would look at the help formatter ERB files: https://github.com/visionmedia/commander/blob/master/lib/commander/help_formatters/terminal/help.erb#L7
https://github.com/visionmedia/commander/blob/master/lib/commander/help_formatters/terminal/command_help.erb#L15
And maybe implement an indentation helper in https://github.com/visionmedia/commander/blob/master/lib/commander/help_formatters/terminal.rb or https://github.com/visionmedia/commander/blob/master/lib/commander/help_formatters/base.rb
—
Reply to this email directly or view it on GitHub #54 (comment) . https://github.com/notifications/beacon/e-O88Xs4RTqNMWG2z6uql_mCjMoEak12wqS-jxTra8TI8GX8j8m0lpbYFNu_rSRJ.gif
No virus found in this message.
Checked by AVG - www.avg.com http://www.avg.com
Version: 2013.0.3343 / Virus Database: 3184/6376 - Release Date: 06/02/13
from commander.
Fixed here: 9ea5c0f
from commander.
Related Issues (20)
- Upgrade to rubocop 0.29.1; bump gem HOT 2
- Unable to build a automatic test tool that tests the commander Js's command action with a return value. HOT 1
- Mandatory options? HOT 9
- Highlight code in README.rdoc plz HOT 1
- Question : ctrl-c and listener HOT 1
- The `find` statement fails on Windows HOT 2
- c.option '-f', '--foo-bar' ... dash in option name issue HOT 1
- add support for option terminator -- HOT 1
- Can't figure out how to use commander using the "Modular" style HOT 5
- when specifying options, the "--no" version of a flag must appear after the flag HOT 2
- Use HighLine menu system HOT 4
- post-argument-parsing hook HOT 11
- -t and --trace confused HOT 1
- Support for pry HOT 9
- Ruby warning: circular require considered harmful HOT 1
- --help should display the command flags/options of the default command HOT 2
- Using `always_trace!` should hide the `--trace` option in the help output HOT 2
- Option parsing error (incomplete option name) HOT 4
- Able to access options set by global_option() outside of the command block HOT 9
- Default help formatter hard limits command length to 20 characters HOT 3
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from commander.