vigiles 2.0.0

package/dist/inline.test.js

@@ -0,0 +1,152 @@
+"use strict";
+/**
+ * Tests for the inline-rule parser.
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const node_test_1 = require("node:test");
+const strict_1 = __importDefault(require("node:assert/strict"));
+const inline_js_1 = require("./inline.js");
+(0, node_test_1.describe)("parseInlineRules", () => {
+    (0, node_test_1.it)("extracts a single enforce comment", () => {
+        const { rules, errors } = (0, inline_js_1.parseInlineRules)(`# Project
+
+<!-- vigiles:enforce eslint/no-console "Use structured logger" -->
+
+## Logging
+
+All output through logger.ts.
+`);
+        strict_1.default.equal(errors.length, 0);
+        strict_1.default.equal(rules.length, 1);
+        strict_1.default.equal(rules[0].linterRule, "eslint/no-console");
+        strict_1.default.equal(rules[0].why, "Use structured logger");
+        strict_1.default.equal(rules[0].line, 3);
+    });
+    (0, node_test_1.it)("extracts multiple enforce comments and tracks line numbers", () => {
+        const content = `# Doc
+<!-- vigiles:enforce eslint/no-console "a" -->
+text
+<!-- vigiles:enforce ruff/F401 "b" -->
+`;
+        const { rules, errors } = (0, inline_js_1.parseInlineRules)(content);
+        strict_1.default.equal(errors.length, 0);
+        strict_1.default.equal(rules.length, 2);
+        strict_1.default.equal(rules[0].linterRule, "eslint/no-console");
+        strict_1.default.equal(rules[0].line, 2);
+        strict_1.default.equal(rules[1].linterRule, "ruff/F401");
+        strict_1.default.equal(rules[1].line, 4);
+    });
+    (0, node_test_1.it)("supports plugin-scoped rule names with slashes", () => {
+        const { rules, errors } = (0, inline_js_1.parseInlineRules)(`<!-- vigiles:enforce eslint/@typescript-eslint/no-floating-promises "Await or void" -->`);
+        strict_1.default.equal(errors.length, 0);
+        strict_1.default.equal(rules.length, 1);
+        strict_1.default.equal(rules[0].linterRule, "eslint/@typescript-eslint/no-floating-promises");
+    });
+    (0, node_test_1.it)("reports malformed vigiles:enforce as a parse error", () => {
+        const { rules, errors } = (0, inline_js_1.parseInlineRules)(`<!-- vigiles:enforce eslint/no-console no quotes here -->`);
+        strict_1.default.equal(rules.length, 0);
+        strict_1.default.equal(errors.length, 1);
+        strict_1.default.match(errors[0].message, /Malformed vigiles:enforce/);
+    });
+    (0, node_test_1.it)("reports unknown vigiles markers", () => {
+        const { rules, errors } = (0, inline_js_1.parseInlineRules)(`<!-- vigiles:strengthen eslint/no-console -->`);
+        strict_1.default.equal(rules.length, 0);
+        strict_1.default.equal(errors.length, 1);
+        strict_1.default.match(errors[0].message, /Unknown vigiles marker "strengthen"/);
+    });
+    (0, node_test_1.it)("returns empty results for a file with no vigiles comments", () => {
+        const { rules, errors } = (0, inline_js_1.parseInlineRules)(`# Plain\n\nJust prose, no rules.\n`);
+        strict_1.default.equal(rules.length, 0);
+        strict_1.default.equal(errors.length, 0);
+    });
+    (0, node_test_1.it)("skips the compiled-file hash marker without reporting an error", () => {
+        const { rules, errors } = (0, inline_js_1.parseInlineRules)(`<!-- vigiles:sha256:abc123 compiled from CLAUDE.md.spec.ts -->
+# Project
+<!-- vigiles:enforce eslint/no-console "why" -->
+`);
+        strict_1.default.equal(errors.length, 0, JSON.stringify(errors));
+        strict_1.default.equal(rules.length, 1);
+    });
+    (0, node_test_1.it)("ignores vigiles:enforce markers inside fenced code blocks", () => {
+        // Illustrative example in docs/inline-mode.md would otherwise get
+        // picked up as a live rule.
+        const { rules, errors } = (0, inline_js_1.parseInlineRules)(`# Docs
+
+Example usage:
+
+\`\`\`md
+<!-- vigiles:enforce eslint/no-console "Use structured logger" -->
+<!-- vigiles:enforce ruff/F401 "No unused imports" -->
+\`\`\`
+
+And a real one outside the fence:
+
+<!-- vigiles:enforce eslint/no-eval "Never eval user input" -->
+`);
+        strict_1.default.equal(errors.length, 0, JSON.stringify(errors));
+        strict_1.default.equal(rules.length, 1);
+        strict_1.default.equal(rules[0].linterRule, "eslint/no-eval");
+    });
+    (0, node_test_1.it)("ignores markers inside tilde-fenced code blocks", () => {
+        const { rules } = (0, inline_js_1.parseInlineRules)(`~~~md
+<!-- vigiles:enforce eslint/no-console "inside fence" -->
+~~~
+<!-- vigiles:enforce eslint/no-eval "outside fence" -->
+`);
+        strict_1.default.equal(rules.length, 1);
+        strict_1.default.equal(rules[0].linterRule, "eslint/no-eval");
+    });
+    (0, node_test_1.it)("ignores markers inside inline code spans in prose", () => {
+        // Prose that describes the syntax with a backtick-wrapped example
+        // must not trigger "malformed vigiles:enforce".
+        const { rules, errors } = (0, inline_js_1.parseInlineRules)(`You add \`<!-- vigiles:enforce eslint/no-console "why" -->\` comments to adopt gradually.
+
+Real rule below:
+
+<!-- vigiles:enforce eslint/no-eval "Never eval" -->
+`);
+        strict_1.default.equal(errors.length, 0, JSON.stringify(errors));
+        strict_1.default.equal(rules.length, 1);
+        strict_1.default.equal(rules[0].linterRule, "eslint/no-eval");
+    });
+    (0, node_test_1.it)("ignores ellipsis placeholders inside inline code spans", () => {
+        const { rules, errors } = (0, inline_js_1.parseInlineRules)(`You add \`<!-- vigiles:enforce ... -->\` comments to adopt gradually.
+`);
+        strict_1.default.equal(errors.length, 0, JSON.stringify(errors));
+        strict_1.default.equal(rules.length, 0);
+    });
+    (0, node_test_1.it)("handles nested backtick fences of different lengths", () => {
+        // Opening with 4 backticks, closing with 3 inside should NOT close
+        // the outer block — only a 4+ backtick close matches.
+        const { rules } = (0, inline_js_1.parseInlineRules)(`\`\`\`\`md
+\`\`\`
+<!-- vigiles:enforce eslint/no-console "inside outer" -->
+\`\`\`
+\`\`\`\`
+<!-- vigiles:enforce eslint/no-eval "outside" -->
+`);
+        strict_1.default.equal(rules.length, 1);
+        strict_1.default.equal(rules[0].linterRule, "eslint/no-eval");
+    });
+});
+(0, node_test_1.describe)("hasInlineRules", () => {
+    (0, node_test_1.it)("returns true when a valid enforce comment exists", () => {
+        strict_1.default.equal((0, inline_js_1.hasInlineRules)(`<!-- vigiles:enforce eslint/no-console "why" -->`), true);
+    });
+    (0, node_test_1.it)("returns false for plain markdown", () => {
+        strict_1.default.equal((0, inline_js_1.hasInlineRules)(`# Title\n\nparagraph\n`), false);
+    });
+    (0, node_test_1.it)("returns false for a malformed marker", () => {
+        strict_1.default.equal((0, inline_js_1.hasInlineRules)(`<!-- vigiles:enforce eslint/no-console no-quotes -->`), false);
+    });
+    (0, node_test_1.it)("returns false for markers trapped inside fenced code blocks", () => {
+        strict_1.default.equal((0, inline_js_1.hasInlineRules)(`# Docs\n\n\`\`\`md\n<!-- vigiles:enforce eslint/no-console "x" -->\n\`\`\`\n`), false);
+    });
+    (0, node_test_1.it)("returns true only for parseable rules outside fences", () => {
+        strict_1.default.equal((0, inline_js_1.hasInlineRules)(`\`\`\`md\n<!-- vigiles:enforce eslint/no-console "inside" -->\n\`\`\`\n<!-- vigiles:enforce eslint/no-eval "outside" -->\n`), true);
+    });
+});
+//# sourceMappingURL=inline.test.js.map

package/dist/inline.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"inline.test.js","sourceRoot":"","sources":["../src/inline.test.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;AAEH,yCAAyC;AACzC,gEAAwC;AAExC,2CAA+D;AAE/D,IAAA,oBAAQ,EAAC,kBAAkB,EAAE,GAAG,EAAE;IAChC,IAAA,cAAE,EAAC,mCAAmC,EAAE,GAAG,EAAE;QAC3C,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,IAAA,4BAAgB,EACxC;;;;;;;CAOL,CACI,CAAC;QACF,gBAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAC/B,gBAAM,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAC9B,gBAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,UAAU,EAAE,mBAAmB,CAAC,CAAC;QACvD,gBAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,uBAAuB,CAAC,CAAC;QACpD,gBAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;IACjC,CAAC,CAAC,CAAC;IAEH,IAAA,cAAE,EAAC,4DAA4D,EAAE,GAAG,EAAE;QACpE,MAAM,OAAO,GAAG;;;;CAInB,CAAC;QACE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,IAAA,4BAAgB,EAAC,OAAO,CAAC,CAAC;QACpD,gBAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAC/B,gBAAM,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAC9B,gBAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,UAAU,EAAE,mBAAmB,CAAC,CAAC;QACvD,gBAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;QAC/B,gBAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC;QAC/C,gBAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;IACjC,CAAC,CAAC,CAAC;IAEH,IAAA,cAAE,EAAC,gDAAgD,EAAE,GAAG,EAAE;QACxD,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,IAAA,4BAAgB,EACxC,yFAAyF,CAC1F,CAAC;QACF,gBAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAC/B,gBAAM,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAC9B,gBAAM,CAAC,KAAK,CACV,KAAK,CAAC,CAAC,CAAC,CAAC,UAAU,EACnB,gDAAgD,CACjD,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,IAAA,cAAE,EAAC,oDAAoD,EAAE,GAAG,EAAE;QAC5D,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,IAAA,4BAAgB,EACxC,2DAA2D,CAC5D,CAAC;QACF,gBAAM,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAC9B,gBAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAC/B,gBAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,2BAA2B,CAAC,CAAC;IAC/D,CAAC,CAAC,CAAC;IAEH,IAAA,cAAE,EAAC,iCAAiC,EAAE,GAAG,EAAE;QACzC,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,IAAA,4BAAgB,EACxC,+CAA+C,CAChD,CAAC;QACF,gBAAM,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAC9B,gBAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAC/B,gBAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,qCAAqC,CAAC,CAAC;IACzE,CAAC,CAAC,CAAC;IAEH,IAAA,cAAE,EAAC,2DAA2D,EAAE,GAAG,EAAE;QACnE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,IAAA,4BAAgB,EACxC,oCAAoC,CACrC,CAAC;QACF,gBAAM,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAC9B,gBAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IACjC,CAAC,CAAC,CAAC;IAEH,IAAA,cAAE,EAAC,gEAAgE,EAAE,GAAG,EAAE;QACxE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,IAAA,4BAAgB,EACxC;;;CAGL,CACI,CAAC;QACF,gBAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;QACvD,gBAAM,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAChC,CAAC,CAAC,CAAC;IAEH,IAAA,cAAE,EAAC,2DAA2D,EAAE,GAAG,EAAE;QACnE,kEAAkE;QAClE,4BAA4B;QAC5B,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,IAAA,4BAAgB,EACxC;;;;;;;;;;;;CAYL,CACI,CAAC;QACF,gBAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;QACvD,gBAAM,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAC9B,gBAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,UAAU,EAAE,gBAAgB,CAAC,CAAC;IACtD,CAAC,CAAC,CAAC;IAEH,IAAA,cAAE,EAAC,iDAAiD,EAAE,GAAG,EAAE;QACzD,MAAM,EAAE,KAAK,EAAE,GAAG,IAAA,4BAAgB,EAChC;;;;CAIL,CACI,CAAC;QACF,gBAAM,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAC9B,gBAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,UAAU,EAAE,gBAAgB,CAAC,CAAC;IACtD,CAAC,CAAC,CAAC;IAEH,IAAA,cAAE,EAAC,mDAAmD,EAAE,GAAG,EAAE;QAC3D,kEAAkE;QAClE,gDAAgD;QAChD,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,IAAA,4BAAgB,EACxC;;;;;CAKL,CACI,CAAC;QACF,gBAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;QACvD,gBAAM,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAC9B,gBAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,UAAU,EAAE,gBAAgB,CAAC,CAAC;IACtD,CAAC,CAAC,CAAC;IAEH,IAAA,cAAE,EAAC,wDAAwD,EAAE,GAAG,EAAE;QAChE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,IAAA,4BAAgB,EACxC;CACL,CACI,CAAC;QACF,gBAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;QACvD,gBAAM,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAChC,CAAC,CAAC,CAAC;IAEH,IAAA,cAAE,EAAC,qDAAqD,EAAE,GAAG,EAAE;QAC7D,mEAAmE;QACnE,sDAAsD;QACtD,MAAM,EAAE,KAAK,EAAE,GAAG,IAAA,4BAAgB,EAChC;;;;;;CAML,CACI,CAAC;QACF,gBAAM,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAC9B,gBAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,UAAU,EAAE,gBAAgB,CAAC,CAAC;IACtD,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,IAAA,oBAAQ,EAAC,gBAAgB,EAAE,GAAG,EAAE;IAC9B,IAAA,cAAE,EAAC,kDAAkD,EAAE,GAAG,EAAE;QAC1D,gBAAM,CAAC,KAAK,CACV,IAAA,0BAAc,EAAC,kDAAkD,CAAC,EAClE,IAAI,CACL,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,IAAA,cAAE,EAAC,kCAAkC,EAAE,GAAG,EAAE;QAC1C,gBAAM,CAAC,KAAK,CAAC,IAAA,0BAAc,EAAC,wBAAwB,CAAC,EAAE,KAAK,CAAC,CAAC;IAChE,CAAC,CAAC,CAAC;IAEH,IAAA,cAAE,EAAC,sCAAsC,EAAE,GAAG,EAAE;QAC9C,gBAAM,CAAC,KAAK,CACV,IAAA,0BAAc,EAAC,sDAAsD,CAAC,EACtE,KAAK,CACN,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,IAAA,cAAE,EAAC,6DAA6D,EAAE,GAAG,EAAE;QACrE,gBAAM,CAAC,KAAK,CACV,IAAA,0BAAc,EACZ,8EAA8E,CAC/E,EACD,KAAK,CACN,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,IAAA,cAAE,EAAC,sDAAsD,EAAE,GAAG,EAAE;QAC9D,gBAAM,CAAC,KAAK,CACV,IAAA,0BAAc,EACZ,4HAA4H,CAC7H,EACD,IAAI,CACL,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/linters.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Linter cross-referencing engine.
+ *
+ * Verifies that linter rule references (e.g., "eslint/no-console") point to
+ * real rules that exist and are enabled in project config. Supports:
+ *   ESLint, Stylelint (Node API), Ruff, Clippy, Pylint, RuboCop (CLI).
+ *
+ * This is the core moat — no other tool resolves rules against 6 linter APIs
+ * and checks config-enabled status.
+ */
+export type ConfigEnabledStatus = "enabled" | "disabled" | "unknown";
+export interface LinterCheckResult {
+    exists: boolean;
+    enabled: ConfigEnabledStatus;
+    linter: string;
+    rule: string;
+    error?: string;
+}
+export interface DetectedLinter {
+    name: string;
+    ruleCount?: number;
+    via?: string;
+}
+/** @internal */ export declare function extractLinterName(enforcedBy: string): string;
+/** @internal */ export declare function extractRuleName(enforcedBy: string): string | null;
+/**
+ * Check a single linter rule reference (e.g., "eslint/no-console").
+ *
+ * Verifies: (1) rule exists in linter, (2) rule is enabled in project config.
+ * Returns a result with exists/enabled status.
+ */
+export declare function checkLinterRule(enforcedBy: string, basePath: string, options?: {
+    catalogOnly?: boolean;
+    linters?: Record<string, {
+        rulesDir?: string | string[];
+    }>;
+}): LinterCheckResult;
+//# sourceMappingURL=linters.d.ts.map

package/dist/linters.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"linters.d.ts","sourceRoot":"","sources":["../src/linters.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAYH,MAAM,MAAM,mBAAmB,GAAG,SAAS,GAAG,UAAU,GAAG,SAAS,CAAC;AAErE,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,OAAO,CAAC;IAChB,OAAO,EAAE,mBAAmB,CAAC;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAYD,gBAAgB,CAAC,wBAAgB,iBAAiB,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,CAO7E;AAED,gBAAgB,CAAC,wBAAgB,eAAe,CAC9C,UAAU,EAAE,MAAM,GACjB,MAAM,GAAG,IAAI,CASf;AAqmBD;;;;;GAKG;AACH,wBAAgB,eAAe,CAC7B,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE;IACR,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE;QAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;KAAE,CAAC,CAAC;CAC5D,GACA,iBAAiB,CA6BnB"}