Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 427 Commits
.github		.github
.husky		.husky
.vscode		.vscode
assets		assets
src		src
.gitignore		.gitignore
.prettierignore		.prettierignore
.prettierrc		.prettierrc
.vscodeignore		.vscodeignore
CHANGELOG.md		CHANGELOG.md
LICENSE		LICENSE
README.md		README.md
package.json		package.json
package.nls.json		package.nls.json
package.nls.zh-cn.json		package.nls.zh-cn.json
prepare.js		prepare.js
renovate.json		renovate.json
tsconfig.json		tsconfig.json
webpack.config.js		webpack.config.js
yarn.lock		yarn.lock

Repository files navigation

VSCode Conventional Commits

Conventional Commits for VSCode.

Features

This extension helps you to fill in commit message according toConventional Commits.

Supportcommitlint configs. SeeSupported Commitlint Rules for details.
Support auto commit and push after typing messages. SeeCommit Workflow for details.
Support project level scope management.
Supportgitmojis.
Support VSCode workspaces.

Usage

You can access VSCode Conventional Commits in two ways:

Command + Shift + P orCtrl + Shift + P, enterConventional Commits,and pressEnter.
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, disableautoCommitconfiguration.

The Recommended Workflow

Active the extension.
Type messages.

The extension will automatically add the changed files, perform the commit andpush the commit to remote.

How To Configure`autoCommit`

EnableSettings > conventionalCommits.autoCommit configuration of theextension.The extension enablesSettings > conventionalCommits.autoCommitby default.
EnableSettings > git.enableSmartCommit and setSettings > git.smartCommitChanges toall to commit all changes when thereare no staged changes.
SetSettings > git.postCommitCommand tosync to rungit.sync aftercommit.

SupportedCommitlint Rules

body-full-stop
body-leading-blank
body-max-length
body-max-line-length
body-min-length
footer-leading-blank
footer-max-length
footer-max-line-length
footer-min-length
header-case
header-full-stop
header-max-length
header-min-length
references-empty
scope-enum
scope-case
scope-empty
scope-max-length
scope-min-length
subject-case
subject-empty
subject-full-stop
subject-max-length
subject-min-length
type-enum
type-case
type-empty
type-max-length
type-min-length
signed-off-by

FAQ

Q: How do I add a line break in messages?

A: SetlineBreak configuration to\n. When you're typing, enter\n asa line break.

Or\\n in JSON format.

Q: How do I resolverepo not found error?

A: See issue discussion#15.

Q: How do I usecommitlint inshowEditor mode?

A: The extension -vscode-commitlint will helpful!

Troubleshooting

Switch to the VSCodeOUTPUT tab, selectConventional Commits.
Copy all the output. Before sharing it, make sure you have removed allprivate information.

Contribution

The vscode task needs to install the extension -vscode-tsl-problem-matcher.
The effect of code changes needs to reactivate the extension. Just restartthe task.