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

The root git plan command should show help, instead of running a subcommand #65

Closed
rorybyrne opened this issue Mar 23, 2021 · 2 comments
Labels
discussion Discussions about the project or implementation
Milestone

Comments

@rorybyrne
Copy link
Owner

This may be controversial, but I think that running git plan should simply trigger the help output (like git). This forces users to be explicit and type git plan list or git plan add. We could offer advice in the README on how to useful aliases for git-plan.

@rorybyrne rorybyrne added the discussion Discussions about the project or implementation label Mar 23, 2021
@rorybyrne
Copy link
Owner Author

Not gonna lie, one of the big motivations behind this is to simplify the tool's architecture and avoid having to (e.g.) share argparse --flags across multiple commands.

@rorybyrne rorybyrne added this to the v0.2.0 milestone Mar 26, 2021
@rorybyrne
Copy link
Owner Author

I decided against this in the end, because I found a way to implement it elegantly.

rorybyrne added a commit that referenced this issue Mar 27, 2021
What does this commit do?
=========================
* Chooses a default subcommand (list/add) in cli.py, instead of via
a default "plan.py" subcommand
* Deletes "plan.py"
* Adds comments to "cli.py"
* Removes the help command

Why are we doing this?
======================
* To simplify the architecture of the CLI
* Adds a test

Notes
=====
Closes #51
Closes #65
rorybyrne added a commit that referenced this issue Mar 27, 2021
What does this commit do?
=========================
* Chooses a default subcommand (list/add) in cli.py, instead of via
a default "plan.py" subcommand
* Deletes "plan.py"
* Adds `-a` flag to list plans on all branches
* Adds comments to "cli.py"
* Removes the help command

Why are we doing this?
======================
* To simplify the architecture of the CLI
* Adds a test

Notes
=====
Closes #51
Closes #65
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discussion Discussions about the project or implementation
Projects
None yet
Development

No branches or pull requests

1 participant