VSCode Conventional Commits
Conventional Commits for VSCode.
Features
This extension helps you to fill in commit message according to
Conventional Commits.
- Respect commitlint configs.
- Support auto commit and push after typing messages. See
Commit Workflow for details.
- Support project level scope management.
- Support gitmojis.
- Support VSCode workspaces.
Usage
You can access VSCode Conventional Commits in two ways:
Command + Shift + P or Ctrl + Shift + P, enter Conventional Commits,
and press Enter.- Click the icon on the Source Control menu. See the image below.
Commit Workflow
The recommended workflow automatically add, commit and push files by default.
If you only want the extension to fill in the message, disable autoCommit
configuration.
The Recommended Workflow
- Active the extension.
- Type messages.
The extension will automatically add the changed files, perform the commit and
push the commit to remote.
- Enable
autoCommit configuration of the extension. The extension enables
autoCommit by default.
- Enable
git.enableSmartCommit and set git.smartCommitChanges to all to
commit all changes when there are no staged changes.
- Set
Settings > git.postCommitCommand to sync to run git.sync after
commit.
Troubleshooting
- Switch to the VSCode
OUTPUT tab, select Conventional Commits.
- Copy all the output. Before sharing it, make sure you have omitted some
private date.
FAQ
Q: How do I add a line break in messages?
A: Set lineBreak configuration to \n. When you're typing, enter \n as
a line break.
Q: How do I resolve repo not found error?
A: See issue discussion
#15.
