Skip to content

chore: adopt shared engineering standard (uv, ruff, strict mypy, Makefile) - #6

Merged
comppaz merged 1 commit into
mainfrom
chore/adopt-standards
May 27, 2026
Merged

chore: adopt shared engineering standard (uv, ruff, strict mypy, Makefile)#6
comppaz merged 1 commit into
mainfrom
chore/adopt-standards

Conversation

@comppaz

@comppaz comppaz commented May 27, 2026

Copy link
Copy Markdown
Contributor

Adopts the shared noirdoc engineering standard for this repo.

Tooling

  • uv as package manager/runner (adds uv.lock).
  • ruff for lint + format, full ruleset E,W,F,I,B,UP,SIM,TID,RUF; pinned ruff==0.15.14 (matched in pre-commit rev so make fmt and the hook agree).
  • mypy enabled in strict mode.
  • pre-commit baseline: hygiene hooks + ruff (check/format) + mypy + gitleaks.
  • CI: uv-based lint / typecheck / test workflow (matrix 3.12/3.13, slow ML tests deselected).
  • .editorconfig, and a Makefile with a standard target vocabulary (make help/install/lint/fmt/typecheck/test/test-slow/check/models).
  • README "Development" section.

Source changes

  • Type annotations across src/ and tests/ to satisfy strict mypy. No runtime behavior changes — annotations, ClassVar/TYPE_CHECKING imports, generics, return types, narrow casts only.
  • Per-module ignore_missing_imports for untyped third-party libs (spacy/flair/gliner/openpyxl/pytesseract/pypdfium2); RUF002/RUF003 ignored (German prose).

Verification

  • make check green: ruff clean, mypy . clean, 254 tests pass (28 slow ML tests deselected).
  • pre-commit run --all-files passes all hooks.

…file)

- Migrate to uv (add uv.lock); pin ruff==0.15.14.
- ruff: full ruleset (E,W,F,I,B,UP,SIM,TID,RUF) + formatter.
- mypy: enable strict; annotate src + tests to pass (no runtime behavior changes).
- pre-commit: hygiene hooks + ruff + mypy + gitleaks.
- CI: uv-based lint / typecheck / test workflow.
- Add .editorconfig, Makefile (help/install/lint/fmt/typecheck/test/check), README Development section.
@comppaz
comppaz force-pushed the chore/adopt-standards branch from 47f8b39 to 1ae9b2b Compare May 27, 2026 10:10
@comppaz
comppaz merged commit 553841e into main May 27, 2026
3 checks passed
@comppaz
comppaz deleted the chore/adopt-standards branch May 27, 2026 10:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant