Xlorep DarkHelm
9b742a5a6d
## Summary This PR tightens repository quality enforcement around markdown and documentation. It adds `markdownlint` to the `cicd-checks` workflow, expands pre-commit coverage so markdown files are checked repo-wide, and cleans up the PP-58 documentation set to keep it aligned with the new policy. ## What changed - Added a `Markdownlint Check` entry to `.gitea/workflows/cicd-checks.yaml` - Added `markdownlint` to pre-commit and widened prettier coverage to include markdown files across the repo - Updated `README.md` to satisfy markdownlint line-length rules - Normalized the PP-58 documentation set: - `docs/DEPLOYABLE_RUNTIME_CONTRACT.md` - `docs/adr/ADR003-deployable_runtime_image_contract.md` - `docs/DEVELOPMENT.md` - `docs/CICD_MULTI_STAGE_BUILD.md` - `docs/CICD_TROUBLESHOOTING_GUIDE.md` - `docs/SECURE_DOCKER_CICD.md` ## Validation - `pre-commit run markdownlint --files README.md docs/DEPLOYABLE_RUNTIME_CONTRACT.md` - `pre-commit run prettier --files README.md docs/DEPLOYABLE_RUNTIME_CONTRACT.md` - Workflow YAML validation returned no errors ## Notes This change does not alter application runtime behavior. It only strengthens CI and documentation quality enforcement. Co-authored-by: copilotcoder <copilotcoder@darkhelm.org> Reviewed-on: #68
117 lines
4.1 KiB
YAML
117 lines
4.1 KiB
YAML
---
|
|
repos:
|
|
# General hooks for all files
|
|
- repo: https://github.com/pre-commit/pre-commit-hooks
|
|
rev: v4.6.0
|
|
hooks:
|
|
- id: trailing-whitespace
|
|
- id: end-of-file-fixer
|
|
- id: check-merge-conflict
|
|
- id: check-added-large-files
|
|
- id: check-yaml
|
|
- id: check-json
|
|
- id: check-toml
|
|
- id: mixed-line-ending
|
|
|
|
# Markdown linting
|
|
- repo: https://github.com/igorshubovych/markdownlint-cli
|
|
rev: v0.45.0
|
|
hooks:
|
|
- id: markdownlint
|
|
args: [--fix]
|
|
files: \.(md|markdown)$
|
|
|
|
# TOML linting
|
|
- repo: https://github.com/macisamuele/language-formatters-pre-commit-hooks
|
|
rev: v2.14.0
|
|
hooks:
|
|
- id: pretty-format-toml
|
|
args: [--autofix]
|
|
|
|
# Python backend linting and formatting with ruff
|
|
- repo: local
|
|
hooks:
|
|
# Linter
|
|
- id: ruff
|
|
name: ruff-lint
|
|
entry: bash -c 'cd backend && uv run ruff check --fix . --config=pyproject.toml'
|
|
language: system
|
|
files: ^backend/
|
|
types: [python]
|
|
pass_filenames: false
|
|
# Formatter
|
|
- id: ruff-format
|
|
name: ruff-format
|
|
entry: bash -c 'cd backend && uv run ruff format . --config=pyproject.toml'
|
|
language: system
|
|
files: ^backend/
|
|
types: [python]
|
|
pass_filenames: false
|
|
|
|
# Python type checking with pyright
|
|
- repo: local
|
|
hooks:
|
|
- id: pyright
|
|
name: pyright
|
|
entry: bash -c 'cd backend && uv run pyright . --project=.'
|
|
language: system
|
|
files: ^backend/
|
|
types: [python]
|
|
pass_filenames: false
|
|
|
|
# Python docstring linting with pydoclint
|
|
- repo: local
|
|
hooks:
|
|
- id: pydoclint
|
|
name: pydoclint
|
|
entry: bash -c 'cd backend && uv run pydoclint --config=pyproject.toml src/'
|
|
language: system
|
|
files: ^backend/.*\.py$
|
|
types: [python]
|
|
pass_filenames: false
|
|
|
|
# Custom hook to enforce no types in docstrings
|
|
- repo: local
|
|
hooks:
|
|
- id: no-docstring-types
|
|
name: Prohibit types in docstrings
|
|
entry: python scripts/check_no_docstring_types.py
|
|
language: system
|
|
files: ^backend/.*\.py$
|
|
pass_filenames: true
|
|
|
|
# Frontend linting and formatting
|
|
- repo: local
|
|
hooks:
|
|
# ESLint with auto-fix for pre-commit (CI uses --no-fix)
|
|
- id: eslint
|
|
name: eslint
|
|
entry: bash -c 'export PATH="$HOME/.local/share/mise/shims:$HOME/.local/bin:$PATH" && cd frontend && if [ "${CI:-}" = "true" ]; then corepack yarn eslint . --max-warnings=0; else corepack yarn eslint . --fix; fi'
|
|
language: system
|
|
files: ^frontend/.*\.(js|ts|vue)$
|
|
pass_filenames: false
|
|
|
|
# Prettier with auto-format for pre-commit (CI uses --check)
|
|
- id: prettier
|
|
name: prettier
|
|
entry: bash -c 'export PATH="$HOME/.local/share/mise/shims:$HOME/.local/bin:$PATH" && FILES=(); for file in "$@"; do FILES+=("$(realpath "$file")"); done && if [ "${CI:-}" = "true" ]; then corepack yarn --cwd frontend prettier --check "${FILES[@]}"; else corepack yarn --cwd frontend prettier --write "${FILES[@]}"; fi' --
|
|
language: system
|
|
files: \.(js|ts|vue|json|css|scss|md|markdown)$
|
|
pass_filenames: true
|
|
|
|
# TypeScript type checking (same as CI)
|
|
- id: typescript-check
|
|
name: typescript-check
|
|
entry: bash -c 'export PATH="$HOME/.local/share/mise/shims:$HOME/.local/bin:$PATH" && cd frontend && corepack yarn vue-tsc --noEmit'
|
|
language: system
|
|
files: ^frontend/.*\.(ts|vue)$
|
|
pass_filenames: false
|
|
|
|
# TSDoc linting with auto-fix for pre-commit (CI uses --no-fix)
|
|
- id: tsdoc-lint
|
|
name: tsdoc-lint
|
|
entry: bash -c 'export PATH="$HOME/.local/share/mise/shims:$HOME/.local/bin:$PATH" && cd frontend && if command -v yarn >/dev/null 2>&1; then if [ "${CI:-}" = "true" ]; then yarn eslint . --ext .ts,.vue --max-warnings=0; else yarn eslint . --ext .ts,.vue --fix; fi; else if [ "${CI:-}" = "true" ]; then corepack yarn eslint . --ext .ts,.vue --max-warnings=0; else corepack yarn eslint . --ext .ts,.vue --fix; fi; fi'
|
|
language: system
|
|
files: ^frontend/.*\.(ts|vue)$
|
|
pass_filenames: false
|