Skip to content

fix: pre-commit hook #1465

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Nytelife26 merged 5 commits into from
Jan 10, 2026
Merged

fix: pre-commit hook #1465

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e8020ad
fix: pre-commit hook
Jan 7, 2026
4a47cff
Constrain file types
cbachhuber Jan 8, 2026
7cf714c
Document pre-commit setup
cbachhuber Jan 8, 2026
6dc4227
Apply suggestion from @cbachhuber
cbachhuber Jan 8, 2026
4473f7d
Move into secion
cbachhuber Jan 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .pre-commit-hooks.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,5 @@
description: This hook checks language usage and style in text files.
entry: proselint
language: python
types: [text]
types: [html, markdown, plain-text, tex]
args: [check]
16 changes: 15 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,21 @@ sudo apt install python3-proselint

`proselint` is packaged by [`nixpkgs`].

### pre-commit

To use proselint with pre-commit, point its config at this repository:

```yaml
repos:
- repo: https://github.com/amperser/proselint
rev: v0.16.0
hooks:
- id: proselint
```

Be sure to change `rev` to use the desired `proselint` git tag or revision.


#### Declarative

```nix
Expand All @@ -86,7 +101,6 @@ nix profile install nixpkgs#proselint
- Emacs via [Flycheck](http://www.flycheck.org/) or via [Flymake](https://sr.ht/~manuel-uberti/flymake-proselint/)
- Vim via [ALE](https://github.com/w0rp/ale) or [Syntastic](https://github.com/vim-syntastic/syntastic) (thanks to @lcd047, @Carreau, and [Daniel M. Capella](https://github.com/polyzen))
- Neovim via [none-ls.nvim](https://github.com/nvimtools/none-ls.nvim) (none-ls has [diagnostics](https://github.com/nvimtools/none-ls.nvim/blob/main/doc/BUILTINS.md#proselint-1) and [code actions](https://github.com/nvimtools/none-ls.nvim/blob/main/doc/BUILTINS.md#proselint) for proselint)
- [pre-commit](https://pre-commit.com/) (by [Andy Airey](https://github.com/aairey))
- [MegaLinter](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_proselint/)

The following plugins are also available, but they are archived or unmaintained:
Expand Down