GitPlanet

Cheap and reliable Node.js hosting starts at $3/month, and $1/month static HTML hosting

Created with love in Canada, visit hostnodejs.com today

Feel like to post an Ad? Learn Details
All Projects → vivaxy → vscode-conventional-commits

vivaxy / vscode-conventional-commits

Licence: MIT license
💬Conventional Commits for VSCode.

Programming Languages

typescript
32286 projects
javascript
184084 projects - #8 most used programming language
shell
77523 projects

Labels

vscodevscode-extensionconventional-changelogstandard-versionconventional-commits

Projects that are alternatives of or similar to vscode-conventional-commits

cocogitto
The Conventional Commits toolbox
Stars: ✭ 242 (+61.33%)
Mutual labels:  conventional-changelog, conventional-commits
git
🔀 semantic-release plugin to commit release assets to the project's git repository
Stars: ✭ 235 (+56.67%)
Mutual labels:  conventional-changelog, conventional-commits
Conventionalcommits.org
The conventional commits specification
Stars: ✭ 3,552 (+2268%)
Mutual labels:  conventional-changelog, conventional-commits
commitlint-config-cz
⚙️ commitlint sharable configuration, automatically converts/merges your cz-customizable (commitizen) config.
Stars: ✭ 23 (-84.67%)
Mutual labels:  conventional-changelog, conventional-commits
DataverseDevTools-VSCode
The all-in-one tool to develop code for Dataverse/Dynamics 365. Helps you connect to a Dataverse environment, generate TypeScript definitions for entities, create a different type of Dataverse-specific projects, and much more.
Stars: ✭ 18 (-88%)
Mutual labels:  vscode-extension
lix.vscode
Visual Studio Code extension for lix
Stars: ✭ 16 (-89.33%)
Mutual labels:  vscode-extension
language-tools
🌐 Prisma Language Tools = Language Server and Prisma's VS Code extension.
Stars: ✭ 159 (+6%)
Mutual labels:  vscode-extension
pine-script-syntax-highlighting
Syntax Highlighting for Pine Script
Stars: ✭ 58 (-61.33%)
Mutual labels:  vscode-extension
code-compass
a contextual search engine for software packages built on import2vec embeddings (https://www.code-compass.com)
Stars: ✭ 33 (-78%)
Mutual labels:  vscode-extension
agda-mode-vscode
agda-mode on VS Code
Stars: ✭ 112 (-25.33%)
Mutual labels:  vscode-extension
vscode-chat
Chat with your team while you collaborate over code using VS Live Share
Stars: ✭ 496 (+230.67%)
Mutual labels:  vscode-extension
vscode-appsync-resolver-autocomplete
Adds autocomplete functionality to vscode when editing AWS AppSync resolver vtl files.
Stars: ✭ 21 (-86%)
Mutual labels:  vscode-extension
vscode-vtools
A collection of small tools for Visual Studio Code.
Stars: ✭ 20 (-86.67%)
Mutual labels:  vscode-extension
vscode-guides
An extension for more guide lines
Stars: ✭ 64 (-57.33%)
Mutual labels:  vscode-extension
BlindJS
BlindJS is a Javascript library that allows blind typing of pre-defined code. So stop worrying about writing valid code and start typing fast as hell!
Stars: ✭ 14 (-90.67%)
Mutual labels:  vscode-extension
icie
Competitive programming IDE-as-a-VS-Code-plugin
Stars: ✭ 81 (-46%)
Mutual labels:  vscode-extension
powerplatform-vscode
The Power Platform VSCode extension makes it easy to manage Power Platform environments and allows the developer to create, build and deploy Power Platform solutions, packages and portals.
Stars: ✭ 74 (-50.67%)
Mutual labels:  vscode-extension
quit-control-vscode
➡️ Stop mistyping keyboard shortcuts and quitting VSCode unintentionally
Stars: ✭ 37 (-75.33%)
Mutual labels:  vscode-extension
getx snippets extension
An extension to accelerate the process of developing applications with flutter, aimed at everyone using the GetX package.
Stars: ✭ 142 (-5.33%)
Mutual labels:  vscode-extension
vscode-ibmi
IBM i development extension for VS Code
Stars: ✭ 122 (-18.67%)
Mutual labels:  vscode-extension
View All Similar Projects ➔

VSCode Conventional Commits

Marketplace Version Installs Financial Contributors on Open Collective

Conventional Commits for VSCode.

Features

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

Usage

Demo

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.

Icon on the Source Control menu

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

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

  • 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: Set lineBreak configuration to \n. When you're typing, enter \n as a line break.

image

Or \\n in JSON format.

image

Q: How do I resolve repo not found error?

A: See issue discussion #15.

Q: How do I use commitlint in showEditor mode?

A: The extension - vscode-commitlint will helpful!

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.

Debug instruction

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.

Team Members

Financial Contributors

Become a financial contributor and help us sustain our community. [Contribute]

Individuals

Organizations

Support this project with your organization. Your logo will show up here with a link to your website. [Contribute]

Related Projects

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].