Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vivaxy/vscode-conventional-commits
💬Conventional Commits for VSCode.
https://github.com/vivaxy/vscode-conventional-commits
conventional-changelog conventional-commits standard-version vscode vscode-extension
Last synced: 3 months ago
JSON representation
💬Conventional Commits for VSCode.
- Host: GitHub
- URL: https://github.com/vivaxy/vscode-conventional-commits
- Owner: vivaxy
- License: mit
- Created: 2020-03-24T12:30:37.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-10-24T17:04:21.000Z (3 months ago)
- Last Synced: 2024-10-26T06:45:25.527Z (3 months ago)
- Topics: conventional-changelog, conventional-commits, standard-version, vscode, vscode-extension
- Language: TypeScript
- Homepage: https://marketplace.visualstudio.com/items?itemName=vivaxy.vscode-conventional-commits
- Size: 2.9 MB
- Stars: 323
- Watchers: 4
- Forks: 35
- Open Issues: 57
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# VSCode Conventional Commits
[](https://marketplace.visualstudio.com/items?itemName=vivaxy.vscode-conventional-commits)
[](https://marketplace.visualstudio.com/items?itemName=vivaxy.vscode-conventional-commits)
[](https://marketplace.visualstudio.com/items?itemName=vivaxy.vscode-conventional-commits)
[](https://marketplace.visualstudio.com/items?itemName=vivaxy.vscode-conventional-commits)
[](https://opencollective.com/vscode-conventional-commits)
[Conventional Commits](https://www.conventionalcommits.org/) for VSCode.
## Features
This extension helps you to fill in commit message according to
[Conventional Commits](https://www.conventionalcommits.org/).
- Support
[commitlint configs](https://commitlint.js.org/#/reference-configuration). See
[Supported Commitlint Rules](#supported-commitlint-rules) for details.
- Support auto commit and push after typing messages. See
[Commit Workflow](#commit-workflow) for details.
- Support project level scope management.
- Support [gitmojis](https://gitmoji.carloscuesta.me/).
- Support VSCode workspaces.
## Usage
You can access VSCode Conventional Commits in two ways:
1. `Command + Shift + P` or `Ctrl + Shift + P`, enter `Conventional Commits`,
and press `Enter`.
2. Click the icon on the Source Control menu. See the image below.
### Extension Configuration
| name | description | default |
| :-----------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :------: |
| `conventionalCommits.autoCommit` | Control whether the extension should commit files after: forming the message or closing the editor tab.
When `#git.enableSmartCommit#` enabled and `#git.smartCommitChanges#` was set to `all`, It allows to commit all changes when there are no staged changes.
And set `#git.postCommitCommand#` to `sync` to run `git.sync` after commit. | true |
| `conventionalCommits.emojiFormat` | Specify which format will be shown in the `gitmoji`. | code |
| `conventionalCommits.gitmoji` | Control whether the extension should prompt for a `gitmoji`. | true |
| `conventionalCommits.lineBreak` | Specify which word will be treated as line breaks in the `body`.
Blank means no line breaks. | "" |
| `conventionalCommits.promptBody` | Control whether the extension should prompt for the `body` section. | true |
| `conventionalCommits.promptFooter` | Control whether the extension should prompt for the `footer` section. | true |
| `conventionalCommits.promptCI` | Control whether the extension should prompt for skipping CI run. | false |
| `conventionalCommits.promptScopes` | Control whether the extension should prompt for the `scope` section. | true |
| `conventionalCommits.scopes` | Specify available selections in the `scope` section. | [] |
| `conventionalCommits.showEditor` | Control whether the extension should show the commit message as a text document in a separate tab. | false |
| `conventionalCommits.showNewVersionNotes` | Control whether the extension should show the new version notes. | true |
| `conventionalCommits.silentAutoCommit` | Control that auto commit should be silent, without focusing source control panel. | false |
| `conventionalCommits.editor.keepAfterSave` | Control whether the extension should keep the editor tab open after saving the commit message. | false |
| `conventionalCommits.storeScopesGlobally` | Control whether the extension should store the defined scopes within your user settings. Uncheck to store in workspace settings. | false |
## Commit Workflow
The recommended workflow automatically add, commit and push files by default.
If you want the extension to only fill in the message, disable `autoCommit`
configuration.
### The Recommended Workflow
1. Active the extension.
2. Type messages.
The extension will automatically add the changed files, perform the commit and
push the commit to remote.
### How To Configure `autoCommit`
1. Enable `Settings > conventionalCommits.autoCommit` configuration of the
extension. _The extension enables `Settings > conventionalCommits.autoCommit`
by default._
2. Enable `Settings > git.enableSmartCommit` and set
`Settings > git.smartCommitChanges` to `all` to commit all changes when there
are no staged changes.
3. Set `Settings > git.postCommitCommand` to `sync` to run `git.sync` after
commit.
### Supported [Commitlint Rules](https://commitlint.js.org/#/reference-rules)
- [x] `body-full-stop`
- [ ] `body-leading-blank`
- [x] `body-max-length`
- [ ] `body-max-line-length`
- [x] `body-min-length`
- [ ] `footer-leading-blank`
- [x] `footer-max-length`
- [ ] `footer-max-line-length`
- [x] `footer-min-length`
- [x] `header-case`
- [x] `header-full-stop`
- [x] `header-max-length`
- [x] `header-min-length`
- [ ] `references-empty`
- [x] `scope-enum`
- [x] `scope-case`
- [x] `scope-empty`
- [x] `scope-max-length`
- [x] `scope-min-length`
- [x] `subject-case`
- [x] `subject-empty`
- [x] `subject-full-stop`
- [x] `subject-max-length`
- [x] `subject-min-length`
- [x] `type-enum`
- [x] `type-case`
- [x] `type-empty`
- [x] `type-max-length`
- [x] `type-min-length`
- [ ] `signed-off-by`
## 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.
Or `\\n` in JSON format.
**Q:** How do I resolve `repo not found` error?
**A:** See issue discussion
[#15](https://github.com/vivaxy/vscode-conventional-commits/issues/15#issuecomment-633161627).
**Q:** How do I use `commitlint` in `showEditor` mode?
**A:** The extension - [vscode-commitlint] will helpful!
[vscode-commitlint]: https://github.com/joshbolduc/vscode-commitlint
## Troubleshooting
1. Switch to the VSCode `OUTPUT` tab, select `Conventional Commits`.
2. Copy all the output. Before sharing it, make sure you have removed all
private information.
## Contribution
1. The vscode task needs to install the extension -
[vscode-tsl-problem-matcher].
2. The effect of code changes needs to reactivate the extension. Just restart
the task.
[vscode-tsl-problem-matcher]:
https://github.com/eamodio/vscode-tsl-problem-matcher
## Team Members
- [vivaxy](https://github.com/vivaxy)
- [yi_Xu](https://github.com/yi-Xu-0100)
## Financial Contributors
Become a financial contributor and help us sustain our community.
[[Contribute](https://opencollective.com/vscode-conventional-commits/contribute)]
### Individuals
### Organizations
Support this project with your organization. Your logo will show up here with a
link to your website.
[[Contribute](https://opencollective.com/vscode-conventional-commits/contribute)]
## Related Projects
- [gacp](https://github.com/vivaxy/gacp)
- [Commit Tagger](https://github.com/Mongkii/Commit-Tagger)
- [vscode-commitizen](https://github.com/KnisterPeter/vscode-commitizen)
- [Commit Message Editor](https://github.com/bendera/vscode-commit-message-editor)
- [commitji](https://github.com/jmaicaaan/commitji)
- [idea-conventional-commit](https://github.com/lppedd/idea-conventional-commit)
- [Git-commit-plugin For Vscode](https://github.com/RedJue/git-commit-plugin)