https://github.com/entorb/pre-commit-config

configuration for pre-commit and Ruff (as replacement for flake8 and black)
https://github.com/entorb/pre-commit-config

cspell markdown perl pre-commit python ruff

Last synced: 3 days ago
JSON representation

configuration for pre-commit and Ruff (as replacement for flake8 and black)

• Host: GitHub
• URL: https://github.com/entorb/pre-commit-config
• Owner: entorb
• License: gpl-3.0
• Created: 2024-01-24T07:16:11.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-09-16T06:02:31.000Z (12 days ago)
• Last Synced: 2024-09-16T07:30:04.896Z (12 days ago)
• Topics: cspell, markdown, perl, pre-commit, python, ruff
• Language: Python
• Homepage:
• Size: 55.7 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# pre-commit config for Python projects

Here is my config for pre-commit, Ruff and CSpell code checks.

Use case: performs automated code style checks (linting), formatting and spell check on a (python) git repository

## install pre-commit

`pip3 install pre-commit`

## configure pre-commit

see 

[.pre-commit-config.yaml](.pre-commit-config.yaml)

* defines and configures which hooks to run

* see  for complete list

## configure ruff hook (linter and formatter)

see 

[.ruff.toml](.ruff.toml)

* configures the Ruff linter and formatter hook

* Ruff includes the features of these linters: flake8, pyupgrade and autoflake

* Ruff includes the features of these formatters: black, isort, add-trailing-comma

* Ruff offers a list of 700+ rules, see [docs.astral.sh/ruff/rules/](https://docs.astral.sh/ruff/rules/) for list

* in my configuration I enabled most of them

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](.gitignore)

To disable a certain rule for a file add

`# ruff: noqa: D103`

To disable a certain rule for a specific line of code:

`# noqa: D103`

## configure cspell hook (spell checker)

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

* [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:`

## run pre-commit manually

`pre-commit run --all-files`

or

`pre-commit run --files myFile1.py myFile2.json`

## run pre-commit automatically triggered upon each `git commit` command

`pre-commit install`

to install the hook so it will be executed upon each local `git commit` command.

## update pre-commit hooks to latest version

`pre-commit autoupdate`

to update versions of all hooks in [.pre-commit-config.yaml](.pre-commit-config.yaml) to the latest version.

## run pre-commit automated via GitHub Actions

Copy dir [.github/workflows/](.github/workflows/) to your repo, to

* automatically trigger the run upon push of commits and creation of pull requests

* weekly autoupdate hook versions in [.pre-commit-config.yaml](.pre-commit-config.yaml)