https://github.com/walles/git-commit-message-plus

VSCode git commit message highlighter nicer than the built-in one
https://github.com/walles/git-commit-message-plus

commit-message git git-commit-messages vscode-extension

Last synced: about 1 month ago
JSON representation

VSCode git commit message highlighter nicer than the built-in one

• Host: GitHub
• URL: https://github.com/walles/git-commit-message-plus
• Owner: walles
• License: mit
• Created: 2023-01-23T20:13:45.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2025-02-20T18:52:37.000Z (3 months ago)
• Last Synced: 2025-02-20T19:40:49.989Z (3 months ago)
• Topics: commit-message, git, git-commit-messages, vscode-extension
• Language: TypeScript
• Homepage:
• Size: 4.35 MB
• Stars: 5
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![CI Status](https://github.com/walles/git-commit-message-plus/actions/workflows/ci.yml/badge.svg?branch=main)

# Git Commit Message Plus

A git commit message highlighter being nicer than the built-in one.

Report issues here: 

## Prep

[Set VSCode as your Git commit

editor](https://code.visualstudio.com/docs/sourcecontrol/overview#_vs-code-as-git-editor).

Then when you `git commit`, you'll be supported in [writing good Git commit

messages](https://cbea.ms/git-commit).

## Features

- Quick Fixes for certain diagnostics

- Inform about `git commit -v` if it isn't being used (with Quick Fix)

- Code completion for JIRA issue IDs based on branch name

- Diagnostics for:

  - \> 50 characters subject lines

  - \> 72 characters subject lines

  - Not-capitalized subject lines (with Quick Fix)

  - Trailing punctuation in the subject line (with Quick Fix)

  - Not-capitalized JIRA issue IDs (with Quick Fix)

  - JIRA issue ID conflicting with branch name (with Quick Fix)

  - Non-blank second lines

![Highlighted Git commit message](images/screenshot.png)

### Internal

- Comes with tests using 

- Comes with unit tests for the diagnostics

### TODO

- Consider the tests for no-diffs for both diagnostics and quick fixes. Are we

  really testing for comment-line followed by an empty line at the end?

- Disable `@typescript-eslint/no-non-null-assertion` in `*.test.*` files, or in

  the whole `suite` directory

- Highlight current branch name in the Git metadata

- Validate code formatting in CI and fail on violations

- Fail CI on linter warnings

- Move all tests under the same top subdirectory

## Development

To run the unit tests:

```

npm install && npm test

```

To install into VSCode:

1. `npm run package`

1. In VSCode:

   - Click Extensions

   - Click the ... menu in the top right corner

   - Click Install from VSIX...

   - Pick the `99.99.99` one, that's the perpetual development version

To check highlighting in VSCode: "Developer: Inspect Editor Tokens and Scopes"

### To publish a new version:

1. Bump the `"version"` in [package.json](package.json)

1. `npm install` to get that version into `package-lock.json` as well

1. Commit the version bump ^

1. `git push`

1. `git tag NEW-VERSION-NUMBER && git push --tags`

1. `npm run publish`