This tool generates smart TODO comments for Git changes to nudge users to document them before commit.
npm install git-smart-commitThis tool generates smart TODO comments for Git changes to nudge users to document them before commit.
- Run npm install git-smart-commit into your app and then follow the steps.
Click below to watch the video
- Make changes to your code
- Do git add .
- Do git commit -m "your message"
- The script will catch your message, run its own inspection to ask you to document the changes you have made.
- It won't commit your changes until all the changes have been documented in this git commit.
- If all goes well, script checks your message format and proceed to commit.
- This is how the script appends the smart comment at the line where changes were made.
- All you have to do is replace TODO with FIX|DEBUG|INFO and enter your message to match the allowed format.
Make sure that your system has all these installed pre-hand.
1. Git
2. Sed
3. Node
1. Make any small change in any of your file
2. ``git add .`
3. git commit -m "your message"`
4. Notice the changes you have made in your files and document them
5. That's it! Push the changes to your branch.
I have added some add-on commands that give you full control over this package:
1. Pause : Pauses the commit validation until you restart. Good when you don't want to validate something.
`
npm run pause-smart-commit
2. Restart : Restarts the paused smart commit package.
`
npm run restart-smart-commit
3. Un-install : Removes the smart commit validation from git and allow you to work normally.
`
npm run uninstall-smart-commit
4. Install : Installs the smart commit validation back into git
`
npm run install-smart-commit
1. Linux
2. Mac
1. Test and adapt to windows
2. Add more file support for comments
3. Integrate ChatGPT for smart commit message to assist better.
Sagar Chauhan works as a Senior Product Manager - Technology at Greenhonchos.
In his spare time, he hunts bug as a Bug Bounty Hunter.
Follow him at Instagram, Twitter, Facebook,
Github