A git commit message highlighter being nicer than the built-in one.
Report issues here: https://github.com/walles/git-commit-message-plus/issues
Set VSCode as your Git commit
editor.
Then when you git commit, you'll be supported in writing good Git commit
messages.
- 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
- 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?
- Highlight current branch name in the Git metadata
- Move all tests under the same top subdirectory
To run the unit tests:
npm install && npm test
To install into VSCode:
- npm run package
- 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:
- Bump the "version" in package.json
- npm install to get that version into package-lock.json as well
- Commit the version bump ^
- git push
- git tag NEW-VERSION-NUMBER && git push --tags
- npm run publish
If npm run publish fails with "Access Denied: The Personal Access Token used
has expired.":
- Go to Azure DevOps and click your profile icon
(User settings) -> Personal access tokens.
- Create a new token with the organization set to All accessible organizations and the scope set to Marketplace / Manage.
- Run npx vsce login walles and paste the new PAT before trying the publish
command again.