Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
entorb committed Apr 30, 2024
1 parent 2ea1866 commit e9d496b
Showing 1 changed file with 25 additions and 1 deletion.
26 changes: 25 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ To disable ruff checking of a (legacy) file or path, you can
* add a `# ruff: noqa` comment inside that file
* exclude via [.ruff.toml](.ruff.toml): `extend-exclude = ["src/MyFile1.py"]`
* exclude via [.pre-commit-config.yaml](.pre-commit-config.yaml)
* exclude via .gitignore file
* exclude via [.gitignore](.gitignore)

To disable a certain rule for a file add

Expand All @@ -50,6 +50,30 @@ see <https://cspell.org>
* [cspell.json](cspell.json) config
* [cspell-words.txt](cspell-words.txt) custom dictionary

To disable cspell checking of a file or path, you can use

* add a `# cspell: disable` comment inside that file
* exclude via [cspell.config.yaml](cspell.config.yaml) -> ignorePaths
* exclude via [.gitignore](.gitignore)

To disable the spellchecking for a section of the file

* `# cspell: disable`
* `...`
* `# cspell: enable`

To disable a certain word for a file

* `# cspell:ignore myword myyword` add to file-specifiv ignore list
* `# cspell:words myword myyword` add to file-specifiv dictionary
* `# cspell:disable-next-line`
* `# cspell:ignoreRegExp g{5}|h{5}`

Aliases:
`cspell:` `cSpell:` `spell-checker:` `spellchecker:`

see [cspell.org/configuration/document-settings/](https://cspell.org/configuration/document-settings/)

## run pre-commit manually

`pre-commit run --all-files`
Expand Down

0 comments on commit e9d496b

Please sign in to comment.