https://github.com/KnisterPeter/vscode-commitizen

Visual Studio Code Commitizen Support
https://github.com/KnisterPeter/vscode-commitizen

commitizen typescript vscode

Last synced: about 2 months ago
JSON representation

Visual Studio Code Commitizen Support

• Host: GitHub
• URL: https://github.com/KnisterPeter/vscode-commitizen
• Owner: KnisterPeter
• License: mit
• Archived: true
• Created: 2016-11-28T08:02:47.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2023-11-27T12:59:58.000Z (10 months ago)
• Last Synced: 2024-06-28T10:34:39.771Z (3 months ago)
• Topics: commitizen, typescript, vscode
• Language: TypeScript
• Homepage: https://marketplace.visualstudio.com/items?itemName=KnisterPeter.vscode-commitizen
• Size: 2.26 MB
• Stars: 240
• Watchers: 3
• Forks: 36
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# vscode-commitizen README

![build](https://github.com/KnisterPeter/vscode-commitizen/workflows/build/badge.svg)

[![Marketplace Version](https://vsmarketplacebadge.apphb.com/version/knisterpeter.vscode-commitizen.svg)](https://marketplace.visualstudio.com/items?itemName=KnisterPeter.vscode-commitizen)

[![Installs](https://vsmarketplacebadge.apphb.com/installs/knisterpeter.vscode-commitizen.svg)](https://marketplace.visualstudio.com/items?itemName=KnisterPeter.vscode-commitizen)

[![renovate badge](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovateapp.com/)

This vscode extension adds [commitizen support](https://github.com/commitizen).

## Usage

* Open the command panel (`ctrl+shift+p` or `command+shift+p`) and type 'conventional commit'.

* Select the command and answer the questions afterwards (type, scope, subject, body, breaking changes, closed issues).

* After the closed issues the commit is done automatically.

* **Note**: During answering the questions just hit `ESC`to cancel the commit.

## Configuration

To configure this extension follow [cz-customizable](https://github.com/leonardoanalista/cz-customizable) and

create the required config file. This also read by this extension if configured.

To determine what config to use, the extention will look for a config file in the following places:

1. a ```.cz-config.js``` in the root directory

2. in ```package.json``` to determine the path to the config file: 

```

  "config": {

    "cz-customizable": {

      "config": "test.js"

    }

  }

```

3. use the default config 

## Attributions

[Commitizen logo](./images/commitizen-logo.svg) is a remixed version of the [logo created by authors of commitizen cz-cli repository](https://github.com/commitizen/cz-cli/blob/a3f4ffa88221013960cd9c6d8711b319016b9e2d/logo/commitizen-logo-color.svg), under MIT license.