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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support for printing the used version of the generator #150

Closed
pomek opened this issue Apr 25, 2023 · 1 comment 路 Fixed by #151
Closed

Support for printing the used version of the generator #150

pomek opened this issue Apr 25, 2023 · 1 comment 路 Fixed by #151
Assignees
Labels
intro Good first ticket. squad:devops Issue to be handled by the Devops team. type:improvement This issue reports a possible enhancement of an existing feature.
Milestone

Comments

@pomek
Copy link
Member

pomek commented Apr 25, 2023

馃摑 Provide a description of the improvement

馃幆 Goals

  • To learn a consumer the used pkg-gen version.

馃摋 Story

  • Given: I am a developer who wants to learn which version of the tool I use.
  • When: I execute npx ckeditor5-package-generator --help
  • Or: I execute npx ckeditor5-package-generator --version
  • Then: I would like to see the version number.

馃挕 Hints

  • The --help flag could print in the footer section.

     npx ckeditor5-package-generator --help
     Usage: ckeditor5-package-generator [options] [packageName]
     
     Arguments:
       packageName           name of the package (@scope/ckeditor5-*)
     
     Options:
       -v, --verbose         output additional logs (default: false)
       --dev                 execution of the script in the development mode (default: false)
       --use-npm             whether use npm to install packages (default: false)
       --use-yarn            whether use yarn to install packages (default: false)
       --lang <lang>         programming language to use
       --plugin-name <name>  optional custom plugin name
       --version             ...
       -h, --help            display help for command
     
     Version: 1.0.0
  • The --version flag could display it and finish the process.

     npx ckeditor5-package-generator --version
     1.0.0

If you'd like to see this improvement implemented, add a 馃憤 reaction to this post.

@pomek pomek added squad:devops Issue to be handled by the Devops team. type:improvement This issue reports a possible enhancement of an existing feature. labels Apr 25, 2023
@pomek
Copy link
Member Author

pomek commented May 9, 2023

commander supports the #version() method so we can use it.

@pomek pomek added the intro Good first ticket. label May 9, 2023
@przemyslaw-zan przemyslaw-zan self-assigned this May 10, 2023
@CKEditorBot CKEditorBot added the status:in-progress Set automatically when an issue lands in the "In progress" column. We are working on it. label May 10, 2023
pomek added a commit that referenced this issue May 12, 2023
Feature (generator): The tool will now display its version when used with `-V`/`--version` option. The version will also be displayed on the `-h`/`--help` message. Closes #150.
@CKEditorBot CKEditorBot removed the status:in-progress Set automatically when an issue lands in the "In progress" column. We are working on it. label May 12, 2023
@CKEditorBot CKEditorBot added this to the iteration 64 milestone May 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
intro Good first ticket. squad:devops Issue to be handled by the Devops team. type:improvement This issue reports a possible enhancement of an existing feature.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants