mirror of
https://github.com/kuhyx/utils.git
synced 2026-11-10 19:07:17 +01:00
Krzysztof kuhy Rudnicki
a10d190b65
Some checks failed
file length / file-length (push) Waiting to run
md-naming / markdown naming convention (push) Waiting to run
palette drift / palette (push) Waiting to run
design_system tests / test (push) Has been cancelled
gatelock pre-commit / pre-commit (push) Has been cancelled
gatelock tests / test (3.10) (push) Has been cancelled
gatelock tests / test (3.11) (push) Has been cancelled
gatelock tests / test (3.12) (push) Has been cancelled
web_ui tests / test (push) Has been cancelled
Markdown across every repo had accumulated a dozen ad-hoc names (refactor_claude_todo.md x23, DESIGN_AUDIT_TODO.md, NEXT_SESSION, HANDOFF, PLAN, SPEC) with nothing distinguishing a live task from a finished record. An audit found docs asserting work was pending that shipped months earlier, and one asserting completion while the work was open. Four namespaces now: README.md, CLAUDE*.md, DOCS*.md, TODO*.md. Task files carry the literal "REMOVE ME AFTER FINISH" and are deleted when the work lands. Enforced bidirectionally -- a TODO without the marker fails, AND any file carrying the marker that is not named TODO*.md fails. Without the reverse rule a task can be renamed into the permanent namespace and quietly live forever, which is the failure being fixed. md_naming/ mirrors the file_length topology and imports its tables (EXCLUDED_DIRS, THIRD_PARTY_REPOS, VENDORED_ANYWHERE, GENERATED_PATTERN) rather than restating them, so the two gates cannot disagree about the same file. 71 tests, 100% branch coverage. stale.py warns on TODOs past 90 days but never fails: no machine can prove a task is finished, so the honest mechanism is a nudge. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01A47aX5DJwmA3QFn3pkEWi7
44 lines
977 B
Python
44 lines
977 B
Python
"""Shared configuration for the markdown-naming convention.
|
|
|
|
Single source of truth for the four namespaces, the removal marker and the
|
|
exemption list, imported by the pre-commit gate (`check.py`) and the staleness
|
|
reporter (`stale.py`). This module is the public surface:
|
|
:mod:`md_naming._tables` holds the data, :mod:`md_naming.rules` the predicates.
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
from md_naming._tables import (
|
|
ALLOWED_PATTERN,
|
|
COMMUNITY_NAMES,
|
|
EXEMPT_SUBPATHS,
|
|
EXTRA_THIRD_PARTY,
|
|
HARNESS_NAMES,
|
|
MARKER,
|
|
STALE_DAYS,
|
|
TODO_PREFIX,
|
|
)
|
|
from md_naming.rules import (
|
|
contains_marker,
|
|
has_allowed_name,
|
|
is_exempt,
|
|
is_markdown,
|
|
is_todo,
|
|
)
|
|
|
|
__all__ = [
|
|
"ALLOWED_PATTERN",
|
|
"COMMUNITY_NAMES",
|
|
"EXEMPT_SUBPATHS",
|
|
"EXTRA_THIRD_PARTY",
|
|
"HARNESS_NAMES",
|
|
"MARKER",
|
|
"STALE_DAYS",
|
|
"TODO_PREFIX",
|
|
"contains_marker",
|
|
"has_allowed_name",
|
|
"is_exempt",
|
|
"is_markdown",
|
|
"is_todo",
|
|
]
|