Add Vale pre-commit hook #758
Draft
Conversation
This file contains 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
guillaume-d
force-pushed
the
guillaume-d/bug/750-add-Vale-pre-commit-hook
branch
from
7565ef2
to
c9b308a
Compare
Rebased to adapt to latest configuration format changes. |
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.
Vale can check both spelling and style in (hyper)text as well as in source files.
This depends on #757 which should be merged first! I will rebase this (or merge from master?) after that.
Alas this ad-hoc implementation does not readily support differentiating between warnings and errors. Well, it could, but a project-independent way to reference a file (in this case a Go template) from .overcommit.yml would be needed, see errata-ai/vale#350.
Limited support is probably still better than nothing! 😉 Also the template for warnings is now out here (see above link), so it could at least be linked to as part of this hook configuration/documentation.
The documentation is indeed just a placeholder for now. Documentation for non-ad-hoc points to their implementation, so what should be done for ad-hoc ones?
Maybe having some manual installation instructions for ad-hoc hooks would be fine too? It is clearly not ideal for users, but after all the individual tools' installations is (also for simplicity reasons) not done automatically either.