feat: Projektgerüst, gehärteten Betriebsstand und Prozess aufsetzen
Legt die Grundlage, auf der alle weiteren Meilensteine nur noch Fachlichkeit ergänzen: Next 16 mit App Router und TypeScript strict, Tailwind 4, Prisma 7, Vitest 5, Playwright, ESLint, Prettier und die Hooks für Lint und Commits. Zwei Dinge sind bewusst so gebaut und durch Tests festgehalten: Die Datenbank ist im Betriebsstand von außen nicht erreichbar. Sie hat kein ports:-Mapping und hängt allein im Netz "intern", das ohne Gateway läuft; nur "web" kommt zusätzlich nach draußen. tests/betriebsstand.test.ts schlägt an, falls ein Port-Mapping zurückkehrt. Geprüft, nicht behauptet: docker compose up startet den Stack, 5432 ist vom Host aus zu, aus "web" offen. pnpm pruefe:doku hält Dokumentation und Code zusammen — Version im Changelog, Issue-Dateien gegen ihre Übersicht, keine Verweise auf fehlende Dateien, keine fehlenden Bilder. Das Skript wurde gegen vier eingebaute Fehler gegengeprüft. Drei Versions-Obergrenzen sind nötig und in CLAUDE.md begründet: eslint bleibt auf 9.x, weil eslint-plugin-react keinen Nachfolger für eslint 10 hat und das Regelwerk sonst beim Laden abbricht; typescript bleibt auf 6.0.x, weil typescript-eslint TypeScript 7 noch nicht unterstützt; prisma ist exakt auf 7.10.0 gepinnt, weil sein latest-Tag auf einen 8.0-RC zeigt, der von @prisma/client aber nicht. Auth.js entfällt entgegen der ursprünglichen Vorgabe: v5 steht dauerhaft auf Beta, das Projekt ist im Wartungsmodus und sein Prisma-Adapter deckt Prisma 7 nicht ab. Stattdessen openid-client und jose, wie in ProxLedger. Dieser erste Commit geht direkt auf main, weil es noch keinen Branch gibt, von dem abzuzweigen wäre. Ab #006 läuft jedes Issue über einen eigenen Branch. Closes #5 Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This commit is contained in:
Florian Wilde
Claude Opus 5
Executable
+144
@@ -0,0 +1,144 @@
|
||||
#!/usr/bin/env node
|
||||
/**
|
||||
* Prueft, dass Dokumentation und Code nicht auseinanderlaufen. Laeuft in CI und
|
||||
* vor jedem Commit. Geprueft wird:
|
||||
*
|
||||
* 1. Die Version aus package.json hat einen Abschnitt im Changelog.
|
||||
* 2. Jede Issue-Datei steht in der Uebersicht – und umgekehrt.
|
||||
* 3. Geschaetzte und tatsaechliche Zeiten stimmen zwischen Datei und Uebersicht.
|
||||
* 4. Alle in der Anleitung verlinkten Bilder sind vorhanden.
|
||||
* 5. Kein Markdown verweist auf eine Datei, die es nicht gibt.
|
||||
*/
|
||||
import { readFileSync, existsSync, readdirSync } from "node:fs";
|
||||
import { join, dirname, resolve } from "node:path";
|
||||
|
||||
const wurzel = resolve(import.meta.dirname, "..");
|
||||
const befunde = [];
|
||||
|
||||
function melde(text) {
|
||||
befunde.push(text);
|
||||
}
|
||||
|
||||
function lies(pfad) {
|
||||
return readFileSync(join(wurzel, pfad), "utf8");
|
||||
}
|
||||
|
||||
function feld(text, name) {
|
||||
const treffer = text.match(new RegExp(`\\*\\*${name}:\\*\\*\\s*(.+?)(?=\\s*\\*\\*|$)`, "m"));
|
||||
return treffer?.[1]?.trim() ?? "";
|
||||
}
|
||||
|
||||
// ---- 1. Version im Changelog ----------------------------------------------
|
||||
{
|
||||
const { version } = JSON.parse(lies("package.json"));
|
||||
const changelog = lies("CHANGELOG.md");
|
||||
const veroeffentlicht = changelog.includes(`## [${version}]`);
|
||||
const unveroeffentlicht = /^## \[Unveröffentlicht\]/m.test(changelog);
|
||||
if (!veroeffentlicht && !unveroeffentlicht) {
|
||||
melde(
|
||||
`Version ${version} hat keinen Abschnitt im Changelog und es gibt keinen Abschnitt ` +
|
||||
`[Unveröffentlicht].`,
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
// ---- 2. und 3. Issue-Dateien gegen die Uebersicht --------------------------
|
||||
{
|
||||
const verz = "docs/issues";
|
||||
const dateien = readdirSync(join(wurzel, verz))
|
||||
.filter((n) => /^\d{3}-.+\.md$/.test(n))
|
||||
.sort();
|
||||
const uebersicht = lies(join(verz, "README.md"));
|
||||
|
||||
for (const name of dateien) {
|
||||
if (!uebersicht.includes(`(${name})`)) {
|
||||
melde(`${verz}/${name} fehlt in ${verz}/README.md.`);
|
||||
continue;
|
||||
}
|
||||
const text = lies(join(verz, name));
|
||||
const kopf = text.match(/^#\s*#(\d+)\s+(.+)$/m);
|
||||
if (!kopf) {
|
||||
melde(`${verz}/${name} hat keine Kopfzeile der Form "# #007 Titel".`);
|
||||
continue;
|
||||
}
|
||||
const [, nummer, titel] = kopf;
|
||||
if (Number(nummer) !== Number(name.slice(0, 3))) {
|
||||
melde(`${verz}/${name} nennt #${nummer}, der Dateiname sagt ${name.slice(0, 3)}.`);
|
||||
}
|
||||
const zeile = uebersicht.split("\n").find((z) => z.includes(`(${name})`));
|
||||
for (const [beschriftung, wert] of [
|
||||
["Status", feld(text, "Status")],
|
||||
["Geschätzt", feld(text, "Geschätzt")],
|
||||
["Tatsächlich", feld(text, "Tatsächlich")],
|
||||
]) {
|
||||
if (wert && !zeile.includes(`| ${wert} |`)) {
|
||||
melde(`${verz}/${name}: "${beschriftung}: ${wert}" weicht von der Übersicht ab.`);
|
||||
}
|
||||
}
|
||||
if (!zeile.includes(titel)) {
|
||||
melde(`${verz}/${name}: Titel "${titel}" weicht von der Übersicht ab.`);
|
||||
}
|
||||
}
|
||||
|
||||
for (const treffer of uebersicht.matchAll(/\((\d{3}-[^)]+\.md)\)/g)) {
|
||||
if (!dateien.includes(treffer[1])) {
|
||||
melde(`${verz}/README.md verweist auf ${treffer[1]}, die Datei fehlt.`);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// ---- 4. Verlinkte Bilder in der Anleitung ----------------------------------
|
||||
{
|
||||
const verz = join(wurzel, "docs/anleitung");
|
||||
if (existsSync(verz)) {
|
||||
const sammeln = (ordner) =>
|
||||
readdirSync(ordner, { withFileTypes: true }).flatMap((eintrag) => {
|
||||
const pfad = join(ordner, eintrag.name);
|
||||
if (eintrag.isDirectory()) return sammeln(pfad);
|
||||
return eintrag.name.endsWith(".md") ? [pfad] : [];
|
||||
});
|
||||
for (const datei of sammeln(verz)) {
|
||||
const text = readFileSync(datei, "utf8");
|
||||
for (const treffer of text.matchAll(/!\[[^\]]*\]\(([^)]+)\)/g)) {
|
||||
const ziel = treffer[1];
|
||||
if (/^https?:/.test(ziel)) continue;
|
||||
if (!existsSync(resolve(dirname(datei), ziel))) {
|
||||
melde(`${datei.replace(`${wurzel}/`, "")} verlinkt das fehlende Bild ${ziel}.`);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// ---- 5. Verweise zwischen Markdown-Dateien --------------------------------
|
||||
{
|
||||
const sammeln = (ordner) =>
|
||||
readdirSync(ordner, { withFileTypes: true }).flatMap((eintrag) => {
|
||||
if (["node_modules", ".git", ".next"].includes(eintrag.name)) return [];
|
||||
const pfad = join(ordner, eintrag.name);
|
||||
if (eintrag.isDirectory()) return sammeln(pfad);
|
||||
return eintrag.name.endsWith(".md") ? [pfad] : [];
|
||||
});
|
||||
|
||||
for (const datei of sammeln(wurzel)) {
|
||||
const text = readFileSync(datei, "utf8");
|
||||
for (const treffer of text.matchAll(/(?<!!)\[[^\]]*\]\(([^)]+)\)/g)) {
|
||||
const ziel = treffer[1];
|
||||
if (/^(https?:|mailto:|#)/.test(ziel)) continue;
|
||||
const ohneAnker = ziel.split("#")[0];
|
||||
if (!ohneAnker) continue;
|
||||
if (!existsSync(resolve(dirname(datei), ohneAnker))) {
|
||||
melde(`${datei.replace(`${wurzel}/`, "")} verweist auf ${ohneAnker}, das es nicht gibt.`);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// ---- Ergebnis --------------------------------------------------------------
|
||||
if (befunde.length > 0) {
|
||||
console.error(`\nDokumentation und Code laufen auseinander (${befunde.length}):\n`);
|
||||
for (const b of befunde) console.error(` - ${b}`);
|
||||
console.error("");
|
||||
process.exit(1);
|
||||
}
|
||||
console.log("Dokumentation stimmt.");
|
||||
Reference in New Issue
Block a user