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

Add help flag to CLI and error handling for unknown flags and arguments #377

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

taphill
Copy link

@taphill taphill commented May 2, 2023

Thank you for helping out! ✨

We really appreciate your commitment to improving Architect

To maintain a high standard of quality in our releases, before merging every pull request we ask that you've completed the following:

  • Forked the repo and created your branch from master
  • Made sure tests pass (run npm it from the repo root)
  • Expanded test coverage related to your changes:
    • Added and/or updated unit tests (if appropriate)
    • Added and/or updated integration tests (if appropriate)
  • Updated relevant documentation:
  • Summarized your changes in changelog.md
  • Linked to any related issues, PRs, etc. below that may relate to, consume, or necessitate these changes

Please also be sure to completed the CLA (if you haven't already).

Learn more about contributing to Architect here.

Thanks again!

@taphill
Copy link
Author

taphill commented May 2, 2023

I mentioned the idea of adding these features to the CLI in discord and wanted to open a PR for it to start getting some initial feedback.

There were a couple of questions I had about flags which seem to be valid, but that I couldn't find any information about (unless I just wasn't looking in the right place):

  • debug
  • dirty
  • eject

Do we want to update the docs and the new --help flag with information about these flags?

Also, within the src/cli/flags.js there seems to be a TODO floating around here. With some guidance, I'd be happy to clean that up since I'm in the file making changes.

@brianleroux
Copy link
Member

this lgtm but I'll leave it to @ryanblock to merge up and ship --- I don't remember what debug does but dirty was the original term we used for direct deployment and eject was the term we used prior to --dry-run for emitting cloudformation. I think we want to keep those aliases around but I'm not dying on that hill either.

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

Successfully merging this pull request may close these issues.

2 participants