Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Custom help command #69

Open
grasmash opened this issue Jan 19, 2017 · 7 comments
Open

Custom help command #69

grasmash opened this issue Jan 19, 2017 · 7 comments

Comments

@grasmash
Copy link
Contributor

Having separate short and long form strings for command information would be useful.

The short, existing string should be displayed when commands are listed. The long form string should be displayed when a user asks for help with the command.

The annotation would look like this:

* @description Short description of the command.
* @help This text is output when the user types `command --help` and is intended to provided more detailed information.
@grasmash grasmash changed the title Add @longdescription or @help annotation Add @help annotation Jan 19, 2017
@grasmash
Copy link
Contributor Author

It looks like this annotation may already exist, but it isn't documented and doesn't appear to work in the proposed way.

@greg-1-anderson
Copy link
Member

Symfony Console's help command is not very extensible. Work to replace it is underway.

@grasmash
Copy link
Contributor Author

@greg-1-anderson Symfony's console component does support separate help and description text. I can submit a PR for support. But, are you going to continue to use that component? I don't want to do the work if it will be replaced :)

@greg-1-anderson
Copy link
Member

I'm planning to replace the help command, not all of Symfony Console. If there is a mistake in the current handling of the help text, a PR to fix it would be appreciated. I'd like the replacement help command to parallel the standard help command as closely as possible, so correct behavior in the baseline code would be good to have.

@weitzman
Copy link
Member

weitzman commented Feb 5, 2017

Nice. Would be great to list associated Topics in a new help command.

@weitzman weitzman changed the title Add @help annotation Custom help command Mar 14, 2017
@weitzman
Copy link
Member

Work has started on a custom Help command which will hopefully upstream in annotated-command - drush-ops/drush#2670

@greg-1-anderson
Copy link
Member

Just a note that Drush has a custom help command that is working pretty well. Drush's version of list does not support list <commandgroup> at the moment. At some point when we have feature parity we can bring this work into annotated command.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants