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

Refactor command execution and help #502

Merged
merged 5 commits into from
Jun 29, 2017
Merged

Conversation

sagebind
Copy link
Member

  • Copy and improve help text, and convert it to AsciiDoc files
  • Evaluate commands dynamically

Why AsciiDoc? It supports definition lists, and Markdown doesn't. The source AsciiDoc formatting also required much less work to transform into something that looks good in the terminal.

If we could handle aliases in some way, we could remove the switch statement altogether and compute the list of available commands by listing the files in $OMF_PATH/pkg/omf/functions/cli.

@sagebind sagebind added cli Related to CLI documentation Related to documentation labels Apr 24, 2017
@sagebind sagebind self-assigned this May 8, 2017
- Copy and improve help text, and convert it to AsciiDoc files
- Evaluate commands dynamically
@sagebind sagebind force-pushed the feature/portable-help-text branch 2 times, most recently from 133803c to f8afc20 Compare June 17, 2017 21:28
@derekstavis
Copy link
Member

Just checkouted the branch. Awesome work!! Looks very beautiful!!

I don't know if was intentional, but I see :: appended to every command or switch in omf help:

screen shot 2017-06-25 at 18 24 38

@sagebind
Copy link
Member Author

@derekstavis Oh boy, that's not supposed to happen! I'll look into the AsciiDoc parser and see if there's a bug.

@sagebind
Copy link
Member Author

sagebind commented Jun 26, 2017

Darn BSD incompatibilities... that's what I get for not testing on OS X as well as Linux.

That visual glitch is fixed now.

@sagebind sagebind added this to the v6 milestone Jun 28, 2017
@derekstavis
Copy link
Member

It works now!! Getting back to review!

@derekstavis
Copy link
Member

Wow, it works awesomely well. Extra points for the comments in the sed chain 😛

LGTM :shipit:

@sagebind
Copy link
Member Author

Sweet; merging into master!

@sagebind sagebind merged commit 37748db into master Jun 29, 2017
@sagebind sagebind deleted the feature/portable-help-text branch January 4, 2019 02:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cli Related to CLI documentation Related to documentation priority: normal Normal priority
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants