-
-
Notifications
You must be signed in to change notification settings - Fork 53
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
RegisterCommands method #706
Conversation
☁️ Nx Cloud ReportCI is running/has finished running commands for commit dfdf7cd. As they complete they will appear below. Click to see the status, the terminal output, and the build insights. 📂 See all runs for this branch ✅ Successfully ran 2 targetsSent with 💌 from NxCloud. |
🦋 Changeset detectedLatest commit: dfdf7cd The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
export abstract class CommandRunner { | ||
static registerCommands(meta: string = CommandMeta): CommandRunnerClass[] { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could we call this registerWithSubCommands
? That way the intent is clear. The code is actually really clean, and if the command is clear enough then I don't see why we can't add it in. Thanks for adding the tests too, showing it works is really nice.
The only other thing I would ask is can you update the documentation? Just a new section in the Commander
section would do
Oh, also, would you mind running |
3b17d2c
to
6e260dd
Compare
…ner and registerWithSubCommands
6e260dd
to
0d01cef
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A couple of grammatical revisions. Thanks for all the work!
Co-authored-by: Jay McDoniel <[email protected]>
Co-authored-by: Jay McDoniel <[email protected]>
Co-authored-by: Jay McDoniel <[email protected]>
If everything (save for the sending coverage) passes, this PR will be great! Thanks again. |
Thank you for reviews, in fact, I'm not native English speaker, so I apologize for many grammatical mistakes. I have no idea to fix CI / send-coverage, so could I ask you how to fix it? BTW, I really think this library is awesome and I have been making many our command line tools standalone and want it more known widely especially in my country, Japan. It can be used not for nest application but for command line tools builder. If you don't mind it, could you let me translate docs in ja locale when I have time? |
It's just because of a missing API token for Codacy. Don't worry about it :) |
Go for it! So long as you don't mind helping maintain them as well when changes happen 😄 I use AstroDocs for the documentation, which has multiple language support already built in. |
So, Is there nothing I should change in this PR?
Sorry for I'm not familiar to nx e2e test, but do I still have something to have to add extra configuration to do this?
Thanks! I'll try it. |
Nah, it's all good |
Close #705.
I also add two sections named with Command Runner and Regsitere Commands to your docs and fix links broken I found in 4a3dd2d.
apps/docs/pages/commander.md
apps/docs/pages/api.md