redjue / git-commit-plugin Goto Github PK

View Code? Open in Web Editor NEW

167.0 5.0 45.0 2.28 MB

Automatically generate git commit

Home Page: https://marketplace.visualstudio.com/items?itemName=redjue.git-commit-plugin

License: MIT License

TypeScript 100.00%

git vscode-extension commit specification hacktoberfest

git-commit-plugin's Introduction

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
zh-HK
zh-TW
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.MaxSubjectCharacters: customize the maximum number of words on the subject, default 20.
```
{
  "GitCommitPlugin.MaxSubjectCharacters": 20
}
```
GitCommitPlugin.FillSubjectWithCurrent: whether to fill the subject with the current commit message, default false.
```
{
  "GitCommitPlugin.FillSubjectWithCurrent": false
}
```

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.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

_白云苍狗 💻	_冷空气 📖	_{Hancel Lin} 💻	_Keriy 💻	_{Arthur Meyniel} 💻	_haryoiro 📖	_Tom 📖
_风过无痕 💻	_whwnow 💻	_{Michael Currin} 📖	_odinsam 💻	_tys1128 📖	_mlzzen 💻	_zeye 💻
_Moeyua 💻

This project follows the all-contributors specification. Contributions of any kind welcome!

git-commit-plugin's People

Contributors

Stargazers

Watchers

git-commit-plugin's Issues

gitk can`t work

I installed this plug and push some commits. Everything is going well. But "gitk" can`t work, how to deal with it?

emoji位置

能否提供选项把emoji的放冒号后面
类似下图这样

不然我用standard-version没法显示

无法自动填充vscode git commit消息栏

无论是只填Subject或是Subject Scope等二三者均填写，都无法在点选Complete后自动填充。
系统：Windows 11 21H2 22000.434
VSCode：1.63.2 (system setup)

Submitting '<Subject>' text exceeds 20 characters will clear the input box

Submitting text exceeds 20 chars will leave the input box and pop up an error message:

Users can acknowledge the issue but cannot recover their previous input content anymore.

Repro steps:

Input something more than 20 characters in the <Subject> section
Press Enter to submit it
My input text disappeared and lost

Expected behavior:

Need to keep the exceeded text and let user modify it until it's less than 20 chars
It will be nice to have an indicator to know how many characters have been input

完成 commint修改后可不可以直接提交?

我发现两点可以优化的地方:

写完commit 信息之后选择完成后不会自动提交能自动提交会更方便.
写完一项可以自动把下一项未写的提为第一项可以减少选择的时间会更方便

一个问题:

使用这个插件如何强制验证 commit是否符合规则?

感谢,辛苦!

默认名字配置可编辑

feat这类默认配置的名字希望可以更具需要替换，因为更具公司开发规范，有些单词不一样，例如我们的就是feature，默认的无法隐藏，又怕其他人误点。

Englisch translation

Hi guys!

I love your plugin so far it is totally cool and helps a lot to write better commits. Would it be possible to have a english translation of the helper text? :-)

Thanks a lot!

因为这个插件有图标,我的commitlint好像不支持有图标?

看了这个插件不错,有图标很舒服但是我装的commitlint 不支持图标怎么修改commitlint 的配置文件呢

remote host 上不能自动填充 commit

vscode: 1.43.2
git-commit-plugin: 0.0.4
remote development: 0.20.0

本地打开的 vscode 插件工作正常

使用 remote development 插件打开 remote host, 并安装 git-commit-plugin 插件, 不能自动填充 commit 框

希望能支持 remote development, vscode 在远程节点上工作的场景也比较多

什么时候使用？

在vscode中我修改文档后，git add .后使用吗？我选好type，scope，subject后点击complete没反应啊。git log没看到新的log。

1.0.9版本如何配置中文？

我的vscode是英文，1.0.9更新后git-commit描述也变成了英文，我尝试配置 "GitCommitPlugin.PreferredLanguage": "cn" 但没有生效，可以单独修改git-commit描述的语言吗？

Plugin's <type> icon cannot be displayed in vscode

Why can't I display the icon when I use this plugin 'show git template' on vscode?is there any icon plugin I need to download?

取消输入仍被识别为已编辑

取消输入后取消输入后仍被识别为已编辑,会有👍

const inputMessageDetail = (_key: string | number) => {
    ...
    vscode.window.showInputBox(CommitInputType).then((value) => {
        const _value = value || '';
        message_config[_key] = _value;
       // 没有根据value是不是undefined来修改isEdit
        _detailType && (_detailType.isEdit = true);
       ...
    });
};

emoji和type之间添加空格

用 commitlint-config-gitmoji 校验commit格式的时候要求emoji和type之间有一个空白符，现在每次都需要手动加，希望能自动在emoji和type之间加一个空格。

Need a whitespace ' ' after the colon

Screenshots

Expected behavior

请问下默认默认能否将emoji放到type后面

首选大佬的插件非常好用，只是在配合自动生成changelog的工具时，由于插件会在type前面添加emoji，导致校验时会认为不符合angular的commit规范（规范里的type只是英文单词，不包括表情），就不能生成正常的changelog了。

请问下能否将默认模板的emoji放到type：后面，虽然楼主提供了配置Templates配置项，可以在templateContent中修改的位置，但是多人协作的时候，都要去修改vscode的配置就不太方便了，能否在项目里加个配置文件，优先取文件的配置，再取编辑器的配置，最后取默认配置，谢谢。

Request for adding to HacktoberFest Topic

Hacktoberfest is an annual event where individuals try to make open source contributions in month of October. Starting this year hacktoberfest will only count contributions to repositories in HacktoberFest Topic.

I would like to contribute to this project (specially making it work on vscode web). And I would really appreciate if you can add this project to the HacktoberFest Topic.

为什么rebase之后，使用git命令行生成的提交信息，git author是正确的，而使用git commit plug生成的提交信息git author是错误的

🌈 is not in the correct gitmoji list

husky > commit-msg
⧗ input: 🌈 style: 格式
✖ 🌈 is not in the correct gitmoji list, please check the emoji code on https://gitmoji.dev/. [start-with-gitmoji]

在 gitmoji 里面 style 的emoji 为 💄

项目配置使用 husky 配合 commitlint-config-gitmoji ，.commitlintrc.js规则：

module.exports = {
extends: ["gitmoji"],
};

选择类型，文字错误，pref应该为perf

如图所示：

怎么把甲壳虫这些图形字符去掉

提交甲壳虫字符的时候把公司服务器搞崩了。

build相关选项异常

搜索git提交类型时，选择build 依赖相关的内容与预期不符

mac + v1.0.5

样式优化

虽然我知道很多 git commit 工具都是图标放后面
但是这会因为 fix style 等单词字数不同而导致图标不对齐。

如果图标放前面会不会更好看一点

模板的 Title 是否可以遵循中文输入加入盘古之白（中英文符号之间有空格如上图）

如何在body中换行?

编写详情时多条需要换行, 如何输入呢?

<body>字段可否自定义模板

实际工作中，需要在中按照模板写入需求/bug相关的自测、步骤等信息，是否可以增加自定义的模板，这样填写的时候填对应项就可以了

能够自定义提交类型么

更新vscode1.56之后，铅笔图标变得非常小了

<Subject> : no more than 20 words

when creating a commit, the wizard says :
: no more than 20 words

But in reality, it's no more than 20 characters.

Should just change the wizard spelling

不能通过commitlint检查

你可以把ShowEmoji 配置改为false，提交信息里就不会有emoji图标了

【Bug】无法添加多个自定义提交类型（commit type）

git-commit-plugin verison: v1.0.7

只有 init，并没有 add。

并且建议提交类型按首字母来字母排序。（非必要）

英文单词计数不正确

当 subject 使用全英文的时候会出现单词计数不正确的情况，看起来像是按照单个字母来计数的

Symbol `>` is not properly rendered

See the screenshot:

Seemingly, the > should be rendered as >, VSCode version:

版本: 1.55.1 (system setup)
提交: 08a217c4d27a02a5bcde898fd7981bda5b49391b
日期: 2021-04-07T15:06:02.360Z
Electron: 11.3.0
Chrome: 87.0.4280.141
Node.js: 12.18.3
V8: 8.7.220.31-electron.0
OS: Windows_NT x64 10.0.19042

 feat(xxx): 修复了以下内容：
- 内容1
- 内容2
- 内容3
- 内容4

目前的输入框好像不能很好进行这种换行方式？

希望适配同一工作区多个仓库的情况

情景如题。

首先，源代码管理中没有这个插件的按钮了。

第二，使用命令（ctrl+shift+p），进行创建的commit一直会在第一个仓库。即使光标在第二个仓库。

综上，使用起来有点不方便。

<type>: [<scope>] <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

我自己的提交格式

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

我基于你的插件，在配置文件做了模板配置。如果可以，麻烦合并一下并更新一下插件。谢谢大佬！

请问body如何换行？

请问是否可以添加对code-server的支持？

如题，现在正在往code-server切换，用习惯这个扩展了，希望能添加对code-server的支持，并增加对open-vsx.org的发布