mirror of
https://github.com/Akkudoktor-EOS/EOS.git
synced 2026-11-13 09:13:30 +01:00
Bobby NoelteandGitHub
e8dcfecf73
Add a configurable filename linter to enforce naming conventions and an AGENTS.md to guide AI coding agents in following project conventions. The guidelines steer code generation; the linter independently verifies filename compliance. Together, they improve consistency and reduce unnecessary files and review effort. Conflicting file names were renamed. Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com>
96 lines
2.7 KiB
YAML
96 lines
2.7 KiB
YAML
default_stages: [pre-commit]
|
|
# Exclude some file types from automatic code style
|
|
exclude: \.(json|csv)$
|
|
repos:
|
|
# --- Basic sanity checks ---
|
|
- repo: https://github.com/pre-commit/pre-commit-hooks
|
|
rev: v6.0.0
|
|
hooks:
|
|
- id: check-merge-conflict
|
|
- id: check-toml
|
|
- id: check-yaml
|
|
- id: end-of-file-fixer
|
|
- id: trailing-whitespace
|
|
- id: check-merge-conflict
|
|
exclude: '\.rst$' # Exclude .rst files from whitespace cleanup
|
|
|
|
# --- Import sorting ---
|
|
- repo: https://github.com/PyCQA/isort
|
|
rev: 8.0.1
|
|
hooks:
|
|
- id: isort
|
|
|
|
# --- Linting + Formatting via Ruff ---
|
|
- repo: https://github.com/astral-sh/ruff-pre-commit
|
|
rev: v0.16.3
|
|
hooks:
|
|
# Run the linter and fix simple isssues automatically
|
|
- id: ruff
|
|
args: [--fix]
|
|
# Run the formatter
|
|
- id: ruff-format
|
|
|
|
- repo: local
|
|
hooks:
|
|
# Run EOS custom file name linter
|
|
- id: eos-filename-linter
|
|
name: EOS filename linter
|
|
entry: uv run --locked --exact --extra dev python scripts/lint_filenames.py
|
|
language: system
|
|
types: [python]
|
|
pass_filenames: true
|
|
|
|
# --- Static type checking ---
|
|
- repo: local
|
|
hooks:
|
|
- id: mypy
|
|
name: mypy (locked development environment)
|
|
entry: uv run --locked --exact --extra dev python -m mypy --config-file pyproject.toml
|
|
language: unsupported
|
|
pass_filenames: false
|
|
always_run: true
|
|
|
|
# --- Markdown linter ---
|
|
- repo: https://github.com/jackdewinter/pymarkdown
|
|
rev: v0.9.39
|
|
hooks:
|
|
- id: pymarkdown
|
|
files: ^docs/
|
|
args:
|
|
- --config=docs/pymarkdown.json
|
|
- scan
|
|
|
|
# --- Commit message linting ---
|
|
# - Local cross-platform hooks
|
|
- repo: local
|
|
hooks:
|
|
# Validate commit messages (using Python wrapper)
|
|
- id: commitizen-commit
|
|
name: Commitizen (venv-aware)
|
|
entry: scripts/cz_check_commit_message.py
|
|
language: python
|
|
additional_dependencies:
|
|
- .
|
|
stages: [commit-msg]
|
|
pass_filenames: false
|
|
|
|
# Branch name check on push (using Python wrapper)
|
|
- id: commitizen-branch
|
|
name: Commitizen branch check
|
|
entry: scripts/cz_check_branch.py
|
|
language: python
|
|
additional_dependencies:
|
|
- .
|
|
stages: [pre-push]
|
|
pass_filenames: false
|
|
|
|
# Validate new commit messages before push (using Python wrapper)
|
|
- id: commitizen-new-commits
|
|
name: Commitizen (check new commits only, .venv aware)
|
|
entry: scripts/cz_check_new_commits.py
|
|
language: python
|
|
additional_dependencies:
|
|
- .
|
|
stages: [pre-push]
|
|
pass_filenames: false
|