https://github.com/estruyf/vscode-commit-helper

CommitHelper a Visual Studio Code extension
https://github.com/estruyf/vscode-commit-helper

commit git vscode vscode-extension

Last synced: about 2 months ago
JSON representation

CommitHelper a Visual Studio Code extension

• Host: GitHub
• URL: https://github.com/estruyf/vscode-commit-helper
• Owner: estruyf
• License: mit
• Created: 2024-06-11T19:54:45.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-06-14T18:54:54.000Z (about 2 years ago)
• Last Synced: 2026-01-29T10:59:50.028Z (5 months ago)
• Topics: commit, git, vscode, vscode-extension
• Language: TypeScript
• Homepage: https://marketplace.visualstudio.com/items?itemName=eliostruyf.vscode-commit-helper
• Size: 155 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

          
# CommitHelper for Visual Studio Code

Streamline your commit message process with **CommitHelper**! This extension allows you to create and manage a list of common commit messages or tags, making it effortless to insert them while you write.

## Use Case

Imagine you have a set of tags that you regularly use to control your CI/CD workflow, such as running specific tests, skipping deployments, or triggering particular pipelines. With **CommitHelper**, you can store these tags and easily select the appropriate one while composing your commit message. This not only saves time but also reduces the risk of errors by ensuring you consistently use the correct tags.

## Configuration

The extension requires you to configure the `commitHelper.messages` setting in your `settings.json` file.

Here is an example configuration:

```json

{

  "commitHelper.messages": [

    {

      "type": "👨‍💻 apps",

      "values": ["#search", "#profile"]

    },

    {

      "type": "⚙️ tasks",

      "values": ["#build", "#deploy", "#skip"]

    }

  ]

}

```

## Usage

once you have configured the `commitHelper.messages` setting, you can start using **CommitHelper** to insert your commit messages.

- Open the **source control** panel in Visual Studio Code.

- Click on the `#` icon to open the **CommitHelper** panel

  

  Quickpick list

- Or start typing a slash `/` in the commit message input field.

  

  Completion list in SCM input

- Select the desired tag from the list to insert it into your commit message.