pasika 0.3.0 → 0.3.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pasika",
-  "version": "0.3.0",
+  "version": "0.3.2",
   "description": "Reusable agent setup package",
   "repository": {
     "type": "git",
@@ -12,7 +12,11 @@
     "./eslint": {
       "types": "./dist/eslint/pasika/index.d.ts",
       "import": "./dist/eslint/pasika/index.js"
-    }
+    },
+    "./package.json": "./package.json"
+  },
+  "bin": {
+    "pasika": "dist/cli/index.js"
   },
   "files": [
     "dist",
@@ -20,35 +24,40 @@
   ],
   "scripts": {
     "build": "rm -rf dist && tsc -p tsconfig.build.json",
+    "coverage": "tsx cli/index.ts coverage",
+    "docs": "eslint docs --config eslint.docs.config.ts",
     "fix": "eslint . --fix",
     "lint": "eslint .",
     "prepack": "npm run build",
-    "typecheck": "tsc --noEmit",
-    "coverage": "tsx cli/index.ts coverage",
-    "docs": "tsx cli/index.ts docs",
-    "test": "node --import tsx --test 'eslint/**/*.test.ts' 'enforcement/**/*.test.ts'"
+    "test": "node --import tsx --test 'eslint/**/*.test.ts' 'enforcement/**/*.test.ts'",
+    "typecheck": "tsc --noEmit"
+  },
+  "dependencies": {
+    "commander": "^12.1.0",
+    "zod": "^4.4.3"
   },
   "devDependencies": {
+    "@eslint/css": "^1.4.0",
+    "@eslint/css-tree": "^4.0.5",
+    "@eslint/json": "^2.0.1",
+    "@eslint/markdown": "^8.0.3",
+    "@humanwhocodes/momoa": "^3.3.12",
     "@types/estree": "^1.0.9",
-    "@types/node": "^24.12.2",
+    "@types/mdast": "^4.0.4",
+    "@types/node": "^26.4.0",
     "@typescript-eslint/parser": "^8.68.0",
-    "eslint": "^9.39.4",
+    "@typescript-eslint/utils": "^8.68.0",
+    "eslint": "^10.9.1",
+    "jiti": "^2.7.0",
     "prettier": "^3.8.1",
     "tsx": "^4.23.12",
     "typescript": "^5.9.2",
-    "zirka": "^0.0.38"
-  },
-  "engines": {
-    "node": ">=22"
-  },
-  "dependencies": {
-    "commander": "^12.1.0",
-    "zod": "^4.4.3"
-  },
-  "bin": {
-    "pasika": "dist/cli/index.js"
+    "zirka": "^0.0.39"
   },
   "peerDependencies": {
     "typescript": ">=5.0.0"
+  },
+  "engines": {
+    "node": ">=22"
   }
 }

package/dist/enforcement/docs-check.d.ts

@@ -1,17 +0,0 @@
-import { type ParsedDoc } from "./parse-docs.js";
-/**
- * Identifiers of the documentation checks. The enforcement registry points at
- * these, so renaming one is a change the registry has to follow.
- */
-export declare const DOCS_CHECKS: readonly ["doc-kind-suffix", "title-matches-file-name", "overview-present", "overview-length", "guide-overview-no-links", "guide-step-single-sentence", "guide-step-single-link", "guide-states-no-requirement", "guide-folder-entry-point", "requirement-present", "rule-paired-examples", "example-heading-description", "policy-no-examples", "policy-single-document", "no-cross-document-link", "reference-no-rfc-vocabulary", "reference-block-headings", "support-document-placement", "no-template-prompt"];
-export type DocsCheck = (typeof DOCS_CHECKS)[number];
-export interface DocsFinding {
-    doc: string;
-    line: number;
-    check: DocsCheck;
-    message: string;
-}
-export declare function checkDocs(docsRoot: string): {
-    docs: ParsedDoc[];
-    findings: DocsFinding[];
-};

package/dist/enforcement/docs-check.js

@@ -1,159 +0,0 @@
-import path from "node:path";
-import { parseDocs, RFC_2119 } from "./parse-docs.js";
-/**
- * Identifiers of the documentation checks. The enforcement registry points at
- * these, so renaming one is a change the registry has to follow.
- */
-export const DOCS_CHECKS = [
-    "doc-kind-suffix",
-    "title-matches-file-name",
-    "overview-present",
-    "overview-length",
-    "guide-overview-no-links",
-    "guide-step-single-sentence",
-    "guide-step-single-link",
-    "guide-states-no-requirement",
-    "guide-folder-entry-point",
-    "requirement-present",
-    "rule-paired-examples",
-    "example-heading-description",
-    "policy-no-examples",
-    "policy-single-document",
-    "no-cross-document-link",
-    "reference-no-rfc-vocabulary",
-    "reference-block-headings",
-    "support-document-placement",
-    "no-template-prompt",
-];
-function countSentences(text) {
-    // Abbreviations inside requirement text are rare, so a period followed by
-    // whitespace is a reliable sentence boundary here.
-    return text.split(/[.!?](?:\s+|$)/).filter((part) => part.trim() !== "").length;
-}
-function checkDoc(doc, allDocs) {
-    const findings = [];
-    const add = (line, check, message) => {
-        findings.push({ doc: doc.doc, line, check, message });
-    };
-    if (!doc.kind) {
-        add(1, "doc-kind-suffix", "file name carries no -guide, -rule, -reference, or -policy suffix");
-        return findings;
-    }
-    const expectedFileName = `${doc.title
-        .toLowerCase()
-        .replaceAll(/[^a-z0-9]+/g, "-")
-        .replace(/^-|-$/g, "")}.md`;
-    if (doc.title === "") {
-        add(1, "title-matches-file-name", "document has no `# Title` heading");
-    }
-    else if (expectedFileName !== doc.fileName) {
-        add(1, "title-matches-file-name", `title "${doc.title}" expects file name ${expectedFileName}`);
-    }
-    if (doc.overview === undefined) {
-        add(2, "overview-present", "no overview follows the title");
-    }
-    else if (countSentences(doc.overview) > 2) {
-        add(2, "overview-length", `overview uses ${String(countSentences(doc.overview))} sentences, at most two are allowed`);
-    }
-    if (doc.kind === "guide") {
-        if (doc.overview?.includes("](")) {
-            add(2, "guide-overview-no-links", "guide overview links another document");
-        }
-        for (const step of doc.steps) {
-            if (countSentences(step.text) > 1) {
-                add(step.line, "guide-step-single-sentence", `step uses ${String(countSentences(step.text))} sentences`);
-            }
-            if (step.links.length > 1) {
-                add(step.line, "guide-step-single-link", `step links ${String(step.links.length)} documents`);
-            }
-        }
-        if (doc.requirements.length > 0) {
-            const first = doc.requirements[0];
-            add(first?.line ?? 1, "guide-states-no-requirement", "guide states a requirement with RFC 2119 vocabulary");
-        }
-    }
-    else {
-        for (const link of doc.docLinks) {
-            add(link.line, "no-cross-document-link", `${doc.kind} links another document: ${link.target}`);
-        }
-    }
-    if ((doc.kind === "rule" || doc.kind === "policy") && doc.requirements.length === 0) {
-        add(1, "requirement-present", `${doc.kind} document states no requirement`);
-    }
-    if (doc.kind === "rule") {
-        const incorrect = doc.exampleHeadings.filter((heading) => heading.text.startsWith("Incorrect"));
-        const correct = doc.exampleHeadings.filter((heading) => heading.text.startsWith("Correct"));
-        if (incorrect.length === 0 || incorrect.length !== correct.length) {
-            add(1, "rule-paired-examples", `${String(incorrect.length)} Incorrect and ${String(correct.length)} Correct examples`);
-        }
-        for (const heading of doc.exampleHeadings) {
-            if (!/^(?:Incorrect|Correct) — .+/.test(heading.text)) {
-                add(heading.line, "example-heading-description", `example heading has no em-dash description: ${heading.text}`);
-            }
-        }
-    }
-    if (doc.kind === "policy") {
-        for (const heading of doc.exampleHeadings) {
-            add(heading.line, "policy-no-examples", `policy document contains an example: ${heading.text}`);
-        }
-        const policyDocs = allDocs.filter((other) => other.kind === "policy");
-        if (policyDocs.length > 1 && policyDocs[0] === doc) {
-            add(1, "policy-single-document", `${String(policyDocs.length)} policy documents exist`);
-        }
-    }
-    if (doc.kind === "reference") {
-        doc.proseWithoutCode.forEach((line, index) => {
-            const match = RFC_2119.exec(line);
-            if (match) {
-                add(index + 1, "reference-no-rfc-vocabulary", `reference uses RFC 2119 vocabulary: ${match.groups?.keyword ?? ""}`);
-            }
-        });
-        if (doc.sectionHeadings.length === 1) {
-            add(doc.sectionHeadings[0]?.line ?? 1, "reference-block-headings", "reference has exactly one section heading, so either a single block is headed or a first block is not");
-        }
-    }
-    // Rules and references a guide owns live in its rules/ and references/ folders.
-    const parentFolder = path.basename(path.dirname(doc.filePath));
-    if (doc.kind === "rule" && parentFolder !== "rules") {
-        add(1, "support-document-placement", `rule lives in "${parentFolder}/" instead of "rules/"`);
-    }
-    if (doc.kind === "reference" && parentFolder !== "references") {
-        add(1, "support-document-placement", `reference lives in "${parentFolder}/" instead of "references/"`);
-    }
-    doc.prose.forEach((line, index) => {
-        if (/^\s*\[[A-Z0-9].*\]\s*$/.test(line)) {
-            add(index + 1, "no-template-prompt", "leftover bracketed template prompt");
-        }
-    });
-    return findings;
-}
-/**
- * A folder that holds `rules/` or `references/` is a guide folder, so it needs a
- * guide named after it as its entry point. Other guides may share that folder.
- */
-function checkGuideFolders(docs) {
-    const guideFolders = new Set(docs
-        .filter((doc) => ["rules", "references"].includes(path.basename(path.dirname(doc.filePath))))
-        .map((doc) => path.dirname(path.dirname(doc.filePath))));
-    return [...guideFolders]
-        .sort((left, right) => left.localeCompare(right))
-        .flatMap((folder) => {
-        const expectedEntryPoint = `${path.basename(folder)}.md`;
-        const hasEntryPoint = docs.some((doc) => doc.kind === "guide" && path.dirname(doc.filePath) === folder && doc.fileName === expectedEntryPoint);
-        if (hasEntryPoint)
-            return [];
-        const anyDoc = docs.find((doc) => doc.filePath.startsWith(`${folder}${path.sep}`));
-        return [
-            {
-                doc: anyDoc ? path.dirname(path.dirname(anyDoc.doc)) : path.basename(folder),
-                line: 1,
-                check: "guide-folder-entry-point",
-                message: `folder holds support documents but has no ${expectedEntryPoint} entry point`,
-            },
-        ];
-    });
-}
-export function checkDocs(docsRoot) {
-    const docs = parseDocs(docsRoot);
-    return { docs, findings: [...docs.flatMap((doc) => checkDoc(doc, docs)), ...checkGuideFolders(docs)] };
-}