/vscode-commitlint

commitlint integration for VS Code

Primary LanguageTypeScriptMIT LicenseMIT

vscode-commitlint

A VS Code extension that integrates commitlint into VS Code's commit editor.

Install from the Visual Studio Marketplace

Animation of a commit message with linting issues being corrected

Features

  • Runs commitlint against your commit message as you write it
  • Reports lint errors and warnings in the editor
  • Highlights relevant parts of the commit based on the specific issue
  • Autodetects commitlint configuration by default
  • Supports all commitlint rules

Settings

commitlint.config.file

Path to a custom commitlint configuration file. Relative paths are resolved based on the workspace root. Leave blank to auto-detect.

Requirements

To make the most out of this extension, you'll probably want to configure commitlint in your project and use VS Code as your git commit editor: