Git Commit Plugin For VS Code

Automatically generate git commit messages

Requirements

VS Code 1.42.0 or higher.
VS Code's built-in Git plugin

Format

This extension follows the Angular Team Commit Specification, as follows:

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

See info on the fields below.

Type

Must be one of the following:

Type	Description
feat	A new feature
fix	A bug fix
docs	Documentation only changes
style:	Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
refactor	A code change that neither fixes a bug nor adds a feature
perf	A code change that improves performance
test	Adding missing or correcting existing tests
chore	Changes to the build process or auxiliary tools and libraries such as documentation generation

Scope

The scope could be anything specifying place of the commit change. For example $location, $browser, $compile, $rootScope, ngHref, ngClick, ngView, etc...

You can use * when the change affects more than a single scope.

Subject

The subject contains succinct description of the change:

use the imperative, present tense: "change" not "changed" nor "changes"
don't capitalize first letter
no dot (.) at the end

Body

Just as in the subject, use the imperative, present tense: "change" not "changed" nor "changes". The body should include the motivation for the change and contrast this with previous behavior.

Footer

The footer should contain any information about Breaking Changes and is also the place to reference GitHub issues that this commit closes.

Breaking Changes should start with the word BREAKING CHANGE: with a space or two newlines. The rest of the commit message is then used for this.

A detailed explanation can be found in this document.

Quick Start

Install the plugin
Use the command shortcut showGitCommit to open the command window or Click the icon on the git plugin navigation bar
Enter the commit information, which automatically generates a commit message that conforms to the specification

Locale Support

The plugin will automatically switch the language description based on the vscode language environment.

Support Language

en-US as default
zh-CN
ja-JP

Settings Options

GitCommitPlugin.ShowEmoji: whether to show emoji, default true.
```
{
  "GitCommitPlugin.ShowEmoji": true
}
```

GitCommitPlugin.CustomCommitType: customize the commit type, default null.

{ 
  "GitCommitPlugin.CustomCommitType": [
    "customTypeName"
  ]
}

[
   {
       // If there are duplicate keys, rewrite the config，otherwise add As a new configuration addition
       "key": "customTypeKey", 
       "label": "customTypeName",
       "detail": "customTypeDetail",
       "icon":"customIcon"
   }
]

GitCommitPlugin.MaxSubjectWords: customize the maximum number of words on the subject, default 20.
```
{
  "GitCommitPlugin.MaxSubjectWords": 20
}
```

GitCommitPlugin.Template: customize the git commit template.

{
  "GitCommitPlugin.Templates": [
    {
        "templateName": "Angular",
        "templateContent": "<icon><space><type>(<scope>):<space><subject><enter><body><enter><footer>"
    },
    {
        "templateName": "git-cz",
        "templateContent": "<type>(<scope>):<space><icon><space><subject><enter><body><enter><footer>",
         // Set as default commit template
        "default":true
    }
  ]
}

License

Released under MIT by @RedJue.

torlinone / git-commit-plugin Goto Github PK

git-commit-plugin's Introduction

Git Commit Plugin For VS Code

Requirements

Format

Type

Scope

Subject

Body

Footer

Quick Start

Locale Support

Settings Options

License

git-commit-plugin's People

Contributors

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent