WIP: Batch #2 - Githubissues

zph commented 3 years ago

WIP & TBD.

Context in #3 and https://github.com/toumorokoshi/tome/pull/4 which contains Batch #1 of changes.

This PR are proposed changes subject to revision as we refine the good ergonomic concepts into what will merge and ship 🗡️ .

Current CLI output for tome --help

Each subcommand has its own targeted help: tome exec --help

Then running a subcommand: tome commands --directory ./example

List of changes:

TBD

TODO for merge:

[ ] Merge and deploy #4
[ ] Review and agree on cli interface
[ ] Verify autogenerated autocompletions
[ ] Manual regression testing
[ ] Passing CI and linting

toumorokoshi commented 3 years ago

Looks like this also includes changes from #4. How about a review after #4 is merged?

toumorokoshi commented 3 years ago

@zph it looks like there's some conflicts that keep the diff from showing vs the newly-merged code, so I can a code review once that's merged in.

Regarding the UX of the CLI itself: Here are my high level design considerations and thoughts:

huge +1 to having some argparse library, to enable better help and CLI for the tome command itself.
are there any backwards-incompatible changes from the previous version of tome?
are there any backwards-incompatible changes from sub?
what sort of commands will be provided to the tome instance, vs the tome cli itself. e.g. {your-command} --help is automatically provided, as is {your command} help {foo} since I believe sub provided the same functionality.

Given these considerations, I'm wondering if we should perhaps start with a design.md-style file to start to align on these philosophical choices and strategies? If you agree, I can author one with some thoughts.

zph commented 3 years ago

A design doc together sounds great. I can reply and fill in details there later today 👍

toumorokoshi commented 3 years ago

thanks for the changes! I'll take a closer look at the code in the next couple days, especially now that #13 is in.

zph commented 3 years ago

@toumorokoshi Perfect. I'll tag you here when I get a chance to get back to it... likely later this week or during weekend 😄. Until then no need to spend time reviewing as it may undergo moderate change to match our spec in #13 .

zph commented 3 years ago

Update, I didn't get to work on it this weekend but will as schedule allows 🤗

toumorokoshi commented 3 years ago

Now worries, thanks for the update and staying in touch!

On Tue, Apr 13, 2021 at 8:37 AM Zander Hill @.***> wrote:

Update, I didn't get to work on it this weekend but will as schedule allows 🤗

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/toumorokoshi/tome/pull/5#issuecomment-818834311, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAC7QSEIHJKYPOMN4D3RRNLTIRQMLANCNFSM4ZL7MBWQ .

toumorokoshi commented 2 years ago

@zph happy new year! My cycles are starting to free up, so I think I want to take the step to try to get tome to 1.0 and start trying to get some buzz on it.

Is it alright with you if I move forward with the design that we discussed? If you still have the cycles to contribute you're more than welcome, but don't want to burden you if you have other things going on.

zph commented 2 years ago

@toumorokoshi I'm excited to hear that you're freeing up for more Tome! I'm in strong support of you carrying on with the design we discussed :D.

I can't offer to do much on it myself right now, but I could definitely exchange a few messages or look over code in a PR if you want me involved.

Happy New Year!

PS - I know a friend who's using this for their commandline tooling and can see if they're free to also try out an RC once it's near v1.0.

toumorokoshi commented 2 years ago

@toumorokoshi I'm excited to hear that you're freeing up for more Tome! I'm in strong support of you carrying on with the design we discussed :D.

I can't offer to do much on it myself right now, but I could definitely exchange a few messages or look over code in a PR if you want me involved.

Happy New Year!

PS - I know a friend who's using this for their commandline tooling and can see if they're free to also try out an RC once it's near v1.0.

Sounds great and thanks for all of your help! I'll send some pings once I scope the 1.0 milestone.

Nattle commented 2 years ago

Just wanted to pop in and say that I use tome all the time. I have 3 separate commands that I use for work stuff in different scopes and another tome that I used for my personal stuff.

I appreciate all the work!

toumorokoshi commented 2 years ago

Hello! I think all of the changes that would have been introduced in this PR have been incorporated in the main branch (use of clap, new reserved commands, fish support).

With that, I think we can close this PR out. Thanks for all the help!

toumorokoshi / tome

WIP: Batch #2 #5