Add help command? #86
Conversation
There was a problem hiding this comment.
@IanLee1521 this is a great idea. Thanks for starting the conversation and submitting a PR :)
I'm down to merge this in, though I added a couple of comments for tweaks we could make. Another thought, which doesn't necessarily need to be implemented in this PR, is to add a brief description of each command, for example -
git rebase - Reapply commits on top of another base tip
Though I can see how that might clutter up the output of the help command. Alternatively we could have a --help flag for each individual command with the description of the command and the flags we support in the tool.
|
|
||
| if (entry.trim() === 'help' || entry.trim() === 'help()') { | ||
| this.info('pres() = Turn on presenter mode') | ||
| this.info('undo = Undo the last git command') |
There was a problem hiding this comment.
could also add clear = restore to initial state
| this.info('`git branch`') | ||
| this.info('`git checkout`') | ||
| this.info('`git cherry_pick`') | ||
| this.info('`git clean`') |
There was a problem hiding this comment.
I actually think we should remove git clean from the tool, seeing as how it removes untracked files in the working directory and this tool is only concerned with the commit graph
There was a problem hiding this comment.
@kuychaco , would an alternate approach be to add the git add functionality, which would make some sort of dirty indicator on the commit and then leave in git clean, and also making git reset --hard without a ref do the right thing of clearing the dirty bit?
...
I guess that would get into the realm of needing to manage unstaged and untracked files though... Yeah, perhaps you're right. :) Arguably that could be a separate pull request though?
4 participants
Would a
help()command be ... helpful?I started some work as a proof of concept, but not sure if it's desirable. Might be incomplete at the moment, and it's currently a manual process to add new / missing commands. Not sure if there is a way to introspect in JS to get the functions, but that might be a better way...?
Anyways, just demonstrating an idea, and opening up a conversation.