nitayneeman/vscode-git-semantic-commit

Repository files navigation

Logo

MarketplaceBuildInstallsLicense

Installation · Usage · Settings · CHANGELOG

This Visual Studio Code extension enables to commit simply by the semantic message conventions.

Preview

Notice that the default types are aligned with the Angular commit message conventions.


The first thing you need to do is installing the extension.

Well, there are two ways to trigger the "Semantic Commit" command:

Open the Command Palette and start typing Git: Semantic Commit:

Triggering using the Command Palette

Then, choose the appropriate command and follow the steps.

Alternatively, you can use the primary and secondary actions within the Source Control view:

Triggering using the View Actions


The extension allows you to customize the following configuration settings:

NameDescription
gitSemanticCommit.commitOptionsSpecifies which arguments to be passed when the commit is executed
gitSemanticCommit.preserveScopeDetermines whether to preserve the last message scope that was inserted
gitSemanticCommit.scopeTemplateSpecifies scope template ($scope placeholder will be replaced with the passed scope)
gitSemanticCommit.stageAllDetermines whether to stage all changes before the commit, in case the staging area (index) is empty
gitSemanticCommit.typesSpecifies the supported message types

Besides the fact you can add new message types, it's also possible to modify the existing values and their descriptions:

Enriching types with Emojis

You can modify the scope template through a placeholder:

Changing the Scope Template


This is an open source project. Any contribution would be greatly appreciated!

About

💬 A Visual Studio Code extension which enables to commit simply by the semantic message conventions

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 7