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

Generate nice help text #4

Open
pionl opened this issue Mar 28, 2022 · 0 comments
Open

Generate nice help text #4

pionl opened this issue Mar 28, 2022 · 0 comments

Comments

@pionl
Copy link

pionl commented Mar 28, 2022

Generate help text when calling ws --help.

  • first render flows
  • then show actions
  • then show "internal" commands

Something like this:

  • description could be gray
  • ignore "default"
  • tries to align the "description" in same line
  • tries generate runs by returning "targets". Append to existing text.
  • if createTargets is used nothing is generated in runs text
  • XX if name is not set, use directory name.
Welcome to wrkflow workspace CLI for XX project. 

Usage:

ws ................ Runs default tasks in your config (change this description `workspace.flows.default.options.description = 'XX')`.
ws install ...... Setup the current workspace with the install command. Great for new users. 
ws check ...... Runs npm:format, npm:lint
ws npm:format .... Runs npm script.


Contacts:
    Admin: [email protected]
    Dev: [email protected]

If the we are in directory without workspace config and no "action" show different help text:

Welcome to wrkflow workspace CLI. 

Usage:
ws install <git-repository-url> ..... Install existing workspace from given repository.
ws init ........................................... Initialize new workspace in current directory

ws w:def ....................................... Copies current Typescript definitions to your project
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: High priority
Development

No branches or pull requests

1 participant