@prompt-lint/rules 1.0.0

package/dist/structure/unused-variable.js

@@ -0,0 +1,38 @@
+import { defineRule } from "@prompt-lint/rule-engine";
+import { collectBodyVariables, collectDeclaredVariables } from "../helpers/index.js";
+/**
+ * `structure/unused-variable`
+ *
+ * Reports a finding for every variable declared in `frontmatter.variables`
+ * that is **not** referenced anywhere in the parsed prompt body. Each
+ * unused variable is emitted separately so reporters can point at the
+ * exact identifier.
+ *
+ * The rule does not emit duplicate findings even if the same name was
+ * declared multiple times in the frontmatter.
+ */
+const unusedVariableRule = defineRule({
+    id: "structure/unused-variable",
+    description: "Flags variables defined in frontmatter but never referenced in the prompt body.",
+    defaultSeverity: "warning",
+    options: Object.freeze([]),
+    check: ({ file, report }) => {
+        const declared = collectDeclaredVariables(file);
+        const referenced = new Set(collectBodyVariables(file).map((v) => v.name));
+        for (const name of declared) {
+            if (referenced.has(name))
+                continue;
+            report({
+                message: `Declared variable \`${name}\` is never referenced in the prompt body.`,
+                severity: "warning",
+                suggestions: [
+                    `Reference \`{{ ${name} }}\` somewhere in the body, or`,
+                    "Remove the entry from `variables:` in the frontmatter.",
+                ],
+            });
+        }
+        return { findings: [] };
+    },
+});
+export default unusedVariableRule;
+//# sourceMappingURL=unused-variable.js.map

package/dist/structure/unused-variable.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"unused-variable.js","sourceRoot":"","sources":["../../src/structure/unused-variable.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAA;AAErD,OAAO,EAAE,oBAAoB,EAAE,wBAAwB,EAAE,MAAM,qBAAqB,CAAA;AAEpF;;;;;;;;;;GAUG;AACH,MAAM,kBAAkB,GAAmB,UAAU,CAAC;IACpD,EAAE,EAAE,2BAA2B;IAC/B,WAAW,EAAE,iFAAiF;IAC9F,eAAe,EAAE,SAAS;IAC1B,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;IAC1B,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE;QAC1B,MAAM,QAAQ,GAAG,wBAAwB,CAAC,IAAI,CAAC,CAAA;QAC/C,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAA;QACzE,KAAK,MAAM,IAAI,IAAI,QAAQ,EAAE,CAAC;YAC5B,IAAI,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC;gBAAE,SAAQ;YAClC,MAAM,CAAC;gBACL,OAAO,EAAE,uBAAuB,IAAI,4CAA4C;gBAChF,QAAQ,EAAE,SAAS;gBACnB,WAAW,EAAE;oBACX,kBAAkB,IAAI,iCAAiC;oBACvD,wDAAwD;iBACzD;aACF,CAAC,CAAA;QACJ,CAAC;QACD,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAA;IACzB,CAAC;CACF,CAAC,CAAA;AAEF,eAAe,kBAAkB,CAAA"}

package/dist/test-helpers.d.ts

@@ -0,0 +1,40 @@
+import type { Finding, PromptFile, RuleContext } from "@prompt-lint/types";
+/**
+ * Construct a `RuleContext` for a single rule call.
+ *
+ * The helper ports the engine's `runOneRuleOneFile` plumbing so unit tests
+ * can exercise `rule.check(ctx)` directly without spinning up the engine.
+ */
+export declare function makeContext(file: PromptFile, options?: Readonly<Record<string, unknown>>): {
+    context: RuleContext;
+    emitted: Omit<Finding, "ruleId" | "fileId" | "filePath">[];
+};
+/**
+ * Run a rule synchronously and return its emitted findings together with
+ * any findings the rule returned from `check`.
+ *
+ * Variables in the body are extracted via `@prompt-lint/parser` so the
+ * tests do not have to enumerate each `{{ var }}` reference manually.
+ */
+export declare function runRule(rule: {
+    check: (ctx: RuleContext) => RuleResult | Promise<RuleResult>;
+}, input?: {
+    path?: string;
+    body?: string;
+    frontmatter?: PromptFile["frontmatter"];
+    variables?: PromptFile["variables"];
+    format?: PromptFile["format"];
+}, options?: Readonly<Record<string, unknown>>): Promise<{
+    findings: Finding[];
+    emitted: Omit<Finding, "ruleId" | "fileId" | "filePath">[];
+}>;
+interface RuleResult {
+    findings: readonly unknown[];
+}
+/**
+ * Convenience helper for tests that prefer to start from a parsed-style
+ * `PromptFile` literal.
+ */
+export declare function frozen<T>(value: T): T;
+export {};
+//# sourceMappingURL=test-helpers.d.ts.map

package/dist/test-helpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"test-helpers.d.ts","sourceRoot":"","sources":["../src/test-helpers.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAA;AAE1E;;;;;GAKG;AACH,wBAAgB,WAAW,CACzB,IAAI,EAAE,UAAU,EAChB,OAAO,GAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAM,GAC9C;IAAE,OAAO,EAAE,WAAW,CAAC;IAAC,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,QAAQ,GAAG,QAAQ,GAAG,UAAU,CAAC,EAAE,CAAA;CAAE,CAUtF;AAED;;;;;;GAMG;AACH,wBAAsB,OAAO,CAC3B,IAAI,EAAE;IAAE,KAAK,EAAE,CAAC,GAAG,EAAE,WAAW,KAAK,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;CAAE,EACvE,KAAK,GAAE;IACL,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,WAAW,CAAC,EAAE,UAAU,CAAC,aAAa,CAAC,CAAA;IACvC,SAAS,CAAC,EAAE,UAAU,CAAC,WAAW,CAAC,CAAA;IACnC,MAAM,CAAC,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAA;CACzB,EACN,OAAO,GAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAM,GAC9C,OAAO,CAAC;IAAE,QAAQ,EAAE,OAAO,EAAE,CAAC;IAAC,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,QAAQ,GAAG,QAAQ,GAAG,UAAU,CAAC,EAAE,CAAA;CAAE,CAAC,CAiB9F;AAED,UAAU,UAAU;IAClB,QAAQ,EAAE,SAAS,OAAO,EAAE,CAAA;CAC7B;AAED;;;GAGG;AACH,wBAAgB,MAAM,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,CAErC"}

package/dist/test-helpers.js

@@ -0,0 +1,52 @@
+import { collectVariables, scanVariables } from "@prompt-lint/parser";
+import { makePromptFile } from "@prompt-lint/test-utils";
+/**
+ * Construct a `RuleContext` for a single rule call.
+ *
+ * The helper ports the engine's `runOneRuleOneFile` plumbing so unit tests
+ * can exercise `rule.check(ctx)` directly without spinning up the engine.
+ */
+export function makeContext(file, options = {}) {
+    const emitted = [];
+    const context = Object.freeze({
+        file,
+        options: Object.freeze({ ...options }),
+        report: (raw) => {
+            emitted.push({ ...raw });
+        },
+    });
+    return { context, emitted };
+}
+/**
+ * Run a rule synchronously and return its emitted findings together with
+ * any findings the rule returned from `check`.
+ *
+ * Variables in the body are extracted via `@prompt-lint/parser` so the
+ * tests do not have to enumerate each `{{ var }}` reference manually.
+ */
+export async function runRule(rule, input = {}, options = {}) {
+    const body = input.body ?? "";
+    const occurrences = scanVariables(body);
+    const variables = collectVariables(occurrences);
+    const file = makePromptFile({
+        path: input.path ?? "prompts/sample.prompt.md",
+        format: input.format ?? "prompt.md",
+        body,
+        frontmatter: (input.frontmatter ?? {}),
+        variables,
+    });
+    const { context, emitted } = makeContext(file, options);
+    const result = await rule.check(context);
+    return {
+        findings: Array.isArray(result.findings) ? result.findings : [],
+        emitted,
+    };
+}
+/**
+ * Convenience helper for tests that prefer to start from a parsed-style
+ * `PromptFile` literal.
+ */
+export function frozen(value) {
+    return Object.freeze(value);
+}
+//# sourceMappingURL=test-helpers.js.map

package/dist/test-helpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"test-helpers.js","sourceRoot":"","sources":["../src/test-helpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AACrE,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAA;AAGxD;;;;;GAKG;AACH,MAAM,UAAU,WAAW,CACzB,IAAgB,EAChB,UAA6C,EAAE;IAE/C,MAAM,OAAO,GAAsD,EAAE,CAAA;IACrE,MAAM,OAAO,GAAgB,MAAM,CAAC,MAAM,CAAC;QACzC,IAAI;QACJ,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,EAAE,GAAG,OAAO,EAAE,CAAC;QACtC,MAAM,EAAE,CAAC,GAAoD,EAAE,EAAE;YAC/D,OAAO,CAAC,IAAI,CAAC,EAAE,GAAG,GAAG,EAAE,CAAC,CAAA;QAC1B,CAAC;KACF,CAAC,CAAA;IACF,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,CAAA;AAC7B,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,OAAO,CAC3B,IAAuE,EACvE,QAMI,EAAE,EACN,UAA6C,EAAE;IAE/C,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,IAAI,EAAE,CAAA;IAC7B,MAAM,WAAW,GAAG,aAAa,CAAC,IAAI,CAAC,CAAA;IACvC,MAAM,SAAS,GAAG,gBAAgB,CAAC,WAAW,CAAC,CAAA;IAC/C,MAAM,IAAI,GAAG,cAAc,CAAC;QAC1B,IAAI,EAAE,KAAK,CAAC,IAAI,IAAI,0BAA0B;QAC9C,MAAM,EAAE,KAAK,CAAC,MAAM,IAAK,WAAoC;QAC7D,IAAI;QACJ,WAAW,EAAE,CAAC,KAAK,CAAC,WAAW,IAAI,EAAE,CAA8B;QACnE,SAAS;KACV,CAAC,CAAA;IACF,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,WAAW,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;IACvD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;IACxC,OAAO;QACL,QAAQ,EAAE,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAE,MAAM,CAAC,QAAsB,CAAC,CAAC,CAAC,EAAE;QAC9E,OAAO;KACR,CAAA;AACH,CAAC;AAMD;;;GAGG;AACH,MAAM,UAAU,MAAM,CAAI,KAAQ;IAChC,OAAO,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;AAC7B,CAAC"}

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@prompt-lint/rules",
+  "version": "1.0.0",
+  "description": "Built-in lint rules for PromptLint V1.",
+  "license": "MIT",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "!**/*.tsbuildinfo"
+  ],
+  "dependencies": {
+    "@prompt-lint/parser": "1.0.0",
+    "@prompt-lint/types": "1.0.0",
+    "@prompt-lint/rule-engine": "1.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "20.17.10",
+    "typescript": "5.7.2",
+    "vitest": "2.1.8",
+    "@prompt-lint/biome-config": "0.0.0",
+    "@prompt-lint/test-utils": "0.0.0",
+    "@prompt-lint/tsconfig": "0.0.0"
+  },
+  "scripts": {
+    "lint": "biome check src",
+    "lint:fix": "biome check --write src",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest",
+    "test:run": "vitest run",
+    "build": "tsc -p tsconfig.build.json",
+    "clean": "rm -rf dist .turbo coverage",
+    "topo": "echo \"topo\""
+  }
+}