Files
breadcrumb-the-shire/bin/docs-drift-check.sh
fs 0c78dc4355 chore(setup): track config.php directly, slim README to setup checklist
config/config.php was gitignored and devs had to copy it from
config/config.php.example on every fresh clone. Since the bootstrap
config reads everything from .env via $envString() / $envInt() /
$envBool() defaults, there is nothing developer-specific in the file —
the cp step was dead ceremony.

- Remove config/config.php from .gitignore and track it directly
- Delete config/config.php.example
- Drop the example-existence + per-doc reference checks from
  bin/docs-drift-check.sh; add a legacy-pattern check that flags
  any new mention of the removed example file
- Update ConfigContractsTest to require config.php and forbid the
  example
- Clean stale references in CLAUDE.md, README.md, six docs files,
  and the core-guardrails skill

Same commit slims README down from 294 to 47 lines: one setup
checklist (now 3 commands instead of 4), the seeded login table,
the three quality-gate commands, and pointers to CLAUDE.md and
docs/index.md for everything else.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-04-29 08:37:45 +02:00

38 lines
1.3 KiB
Bash
Executable File

#!/usr/bin/env bash
set -euo pipefail
script_dir="$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" && pwd)"
repo_root="$(cd -- "${script_dir}/.." && pwd)"
cd "${repo_root}"
scan_targets=(README.md CLAUDE.md docs .agents)
scan_globs=(-g '*.md' -g '*.json' -g '!.agents/runs/**')
fail=0
check_legacy_pattern() {
local pattern="$1"
local label="$2"
local matches
matches="$(rg -n --pcre2 "${pattern}" "${scan_targets[@]}" "${scan_globs[@]}" || true)"
if [[ -n "${matches}" ]]; then
echo "[FAIL] ${label}"
echo "${matches}"
fail=1
fi
}
check_legacy_pattern 'config/settings\.php' 'Legacy docs reference to config/settings.php found'
check_legacy_pattern 'config/router\.php' 'Legacy docs reference to config/router.php found'
check_legacy_pattern '\bAPP_ROUTE_DEFINITIONS\b' 'Legacy docs reference to APP_ROUTE_DEFINITIONS found'
check_legacy_pattern '\bAPP_PUBLIC_PATHS\b' 'Legacy docs reference to APP_PUBLIC_PATHS found'
check_legacy_pattern 'data-search-key' 'Legacy global-search aside marker (data-search-key) found'
check_legacy_pattern 'config/config\.php\.example' 'Legacy docs reference to config/config.php.example (file removed; config.php is now tracked)'
if [[ ${fail} -ne 0 ]]; then
echo "[FAIL] docs drift checks failed"
exit 1
fi
echo "[OK] docs drift checks passed"