Skip to content

walles/git-commit-message-plus

 
 

Repository files navigation

CI Status

Git Commit Message Plus

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

Features

Help for writing good Git commit messages:

  • Highlight file names and what's happening to them
  • Quick Fixes for certain diagnostics
  • Inform about git commit -v if it isn't being used
  • git commit -v diff highlighting even when running git in not-English.
  • 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)
    • Code completion for JIRA issue IDs based on branch name
    • 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

Internal

TODO

  • Test doing git commit in a jira-123 branch, then type "j" as the first letter. Verify that we get a suggestion. I have a feeling completion doesn't activate properly.
  • Add a Quick fix for switching between [] and : style JIRA issue ID prefixes
  • 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
  2. 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:

npm run publish

About

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

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors