https://github.com/MigoXLab/pre-commit-toolkit
Recommended static code analysis rules for code project
https://github.com/MigoXLab/pre-commit-toolkit
Last synced: 11 months ago
JSON representation
Recommended static code analysis rules for code project
- Host: GitHub
- URL: https://github.com/MigoXLab/pre-commit-toolkit
- Owner: MigoXLab
- License: apache-2.0
- Created: 2025-05-21T06:41:10.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-06-16T08:00:54.000Z (12 months ago)
- Last Synced: 2025-06-19T08:36:12.035Z (11 months ago)
- Homepage:
- Size: 32.2 KB
- Stars: 4
- Watchers: 0
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Pre-commit rules toolkit
We have recommended a set of static code analysis [python rules](./python/pre-commit-config.yaml), primarily targeting repositories with Python code. For details on the checks performed by each rule and troubleshooting guidance, please refer to the table below.
| Rule | Description | Debug | Notes | Ignore Example |
| ------------------------------------ | ------------------------------------------- | ------------------------------------- | ------------------------------------- | ----------------------------------------------- |
| [black](https://github.com/psf/black) | Python code formatter | | | single-line format:`# fmt: skip` |
| [flake8](https://github.com/PyCQA/flake8) | Check the style and quality of some python code | | | single-line format:`# noqa: F401`
command args:`--ignore=F401` |
| [isort](https://github.com/PyCQA/isort) | Python utility / library to sort imports | | Sort rules: sort imports alphabetically and automatically separate into sections and by type | single-line format:`# isort:skip` |
| [codespell](https://github.com/codespell-project/codespell) | Check code for common misspellings | | | single-line format:`# codespell:ignore `
command args:`--skip=doc/en/usage.md` |
| [mdformat](https://github.com/hukkin/mdformat) | CommonMark compliant Markdown formatter | | | |
| [pymarkdown](https://github.com/jackdewinter/pymarkdown) | Markdown linter | You can use args: `[fix]` to fix errors automatically. | There will be a conflict between mdformat and pymarkdown when an empty YAML file exists.
| single-line format:(Must be at line start) ``
command args:`- entry: "pymarkdown -d MD013,MD041,MD010"` |
| [pylint](https://github.com/pylint-dev/pylint) | Python code analysis tool | | Python 3.12 unsupported | single-line format:`# pylint: disable=W0401,W0614`
command args:`--disable=E0402,E0401` |
| [gitleaks](https://github.com/gitleaks/gitleaks) | Detect secrets (passwords, API keys, tokens) in git repos/files | | If you configure .gitleaks.toml, then the demo configuration in .pre-commit-config.yaml would be as follows:
- repo: https://github.com/gitleaks/gitleaks
rev: v8.27.0
hooks:
- id: gitleaks
entry: "gitleaks dir"
args: \[
"-c=.gitleaks.toml",
"--verbose",
"--redact=50"
\]
| single-line format: `# gitleaks:allow`(Though offical example is [gitleaks](https://github.com/gitleaks/gitleaks?tab=readme-ov-file#gitleaksallow),this way can avoid of confliction with flake8)
configure way:Use `disabledRules = [ "generic-api-key"]` in [.gitleaks.toml](https://github.com/gitleaks/gitleaks/blob/master/.gitleaks.toml) |
| [markdown-link-check](https://github.com/tcort/markdown-link-check) |checks all of the hyperlinks in a markdown text to determine if they are alive or dead| | Current version mistake `/A/B` format as an error. |single-line format:`single-line format:`
command args: `-i http://example.net` |
# Quick Start
1. Install pre-commit
`pip install pre-commit`
For detailed installation instructions, refer to the [pre-commit](https://pre-commit.com/)
2. Configuration
- .pre-commit-config.yaml already exists
Select [hooks](python/pre-commit-config.yaml) not already in use by your project and add them to your .pre-commit-config.yaml file
- if not
Copy the configuration file to your project root:
`cp python/pre-commit-config.yaml /.pre-commit-config.yaml`
3. Install the git hook scripts
`pre-commit install`
4. Check Code
- run all hooks: `pre-commit run --all-files`
- run one hook: `pre-commit run --all-files`
# Citation
Our configuration incorporates examples from [lmdeploy](https://github.com/InternLM/lmdeploy/blob/main/.github/md-link-config.json) .