docs(sublime): document setup for linting git commit messages - #4029
Open
costajohnt wants to merge 2 commits into
Open
docs(sublime): document setup for linting git commit messages#4029costajohnt wants to merge 2 commits into
costajohnt wants to merge 2 commits into
Conversation
4 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Issues
Closes #3781
Follow-up to #3782, which was closed in favor of documenting the configuration instead of widening the languageId match arm.
Description
Sublime Text reports
languageId: "git"for commit buffers, andharper-lsroutes commit messages by thegit-commitlanguageId, so commit messages go unlinted out of the box. There are two things a user has to do, and neither is currently documented:text.git.committo theselectorin theharper-lsclient config, so LSP attaches to the buffer at all."text.git.commit": "git-commit"inlanguage-ids.sublime-settings, so the client sends a languageIdharper-lsrecognizes.This adds a "Linting Git Commit Messages" section to the Sublime Text integration page covering both.
Demo
Not applicable, documentation only.
How Has This Been Tested?
Documentation only, no code paths touched. The
git-commitlanguageId in the mapping matches the existing match arm inharper-ls/src/backend.rs, and the workaround itself is the one the reporter confirmed working in #3781.AI Disclosure
If Your PR Implements or Enhances a Linter
Not applicable.
Checklist