@kevinrabun/judges 3.23.6 → 3.23.8

package/dist/commands/scaffold-plugin.js

@@ -0,0 +1,271 @@
+/**
+ * `judges scaffold-plugin` — Generate a starter custom plugin project.
+ *
+ * Creates a directory structure with:
+ *   - package.json (with @kevinrabun/judges as peer dependency)
+ *   - tsconfig.json
+ *   - src/index.ts (plugin entry-point with example rule & judge)
+ *   - src/rules/example-rule.ts
+ *   - README.md
+ *
+ * Usage:
+ *   judges scaffold-plugin my-org-rules
+ *   judges scaffold-plugin my-org-rules --dir ./plugins
+ */
+import { existsSync, mkdirSync, writeFileSync } from "fs";
+import { join, resolve } from "path";
+// ─── Templates ───────────────────────────────────────────────────────────────
+function packageJsonTemplate(name) {
+    return JSON.stringify({
+        name,
+        version: "0.1.0",
+        description: `Custom Judges Panel plugin: ${name}`,
+        type: "module",
+        main: "dist/index.js",
+        types: "dist/index.d.ts",
+        scripts: {
+            build: "tsc",
+            watch: "tsc --watch",
+            test: "node --test dist/**/*.test.js",
+        },
+        peerDependencies: {
+            "@anthropic-ai/sdk": ">=0.39.0",
+            "@kevinrabun/judges": "*",
+        },
+        devDependencies: {
+            typescript: "^5.7.0",
+        },
+        keywords: ["judges-plugin", "code-review", "static-analysis"],
+        license: "MIT",
+    }, null, 2);
+}
+function tsconfigTemplate() {
+    return JSON.stringify({
+        compilerOptions: {
+            target: "ES2022",
+            module: "Node16",
+            moduleResolution: "Node16",
+            declaration: true,
+            outDir: "dist",
+            rootDir: "src",
+            strict: true,
+            esModuleInterop: true,
+            skipLibCheck: true,
+        },
+        include: ["src"],
+    }, null, 2);
+}
+function indexTemplate(name) {
+    return `/**
+ * ${name} — Custom Judges Panel Plugin
+ *
+ * Register this plugin in your .judgesrc or via the API:
+ *
+ *   import { registerPlugin } from "@kevinrabun/judges/api";
+ *   import plugin from "${name}";
+ *   registerPlugin(plugin);
+ */
+
+import type { JudgesPlugin, CustomRule } from "@kevinrabun/judges/api";
+import { exampleNoTodoRule } from "./rules/example-rule.js";
+
+const plugin: JudgesPlugin = {
+  name: "${name}",
+  version: "0.1.0",
+  description: "Custom rules and judges for ${name}",
+
+  // Register custom rules
+  rules: [exampleNoTodoRule],
+
+  // Optionally add custom judges (uncomment to use):
+  // judges: [],
+
+  // Hook: post-process findings (e.g., add org metadata)
+  // afterEvaluate: (findings) => {
+  //   return findings.map((f) => ({
+  //     ...f,
+  //     tags: [...(f.tags || []), "${name}"],
+  //   }));
+  // },
+};
+
+export default plugin;
+`;
+}
+function exampleRuleTemplate() {
+    return `/**
+ * Example custom rule: no-todo-comments
+ *
+ * Flags TODO / FIXME / HACK comments as findings.
+ * This is a pattern-based rule — the simplest form.
+ */
+
+import type { CustomRule } from "@kevinrabun/judges/api";
+
+export const exampleNoTodoRule: CustomRule = {
+  id: "CUSTOM-001",
+  title: "TODO/FIXME comment detected",
+  severity: "info",
+  judgeId: "code-structure",
+  description: "Flags TODO, FIXME, and HACK comments that should be tracked in an issue tracker.",
+  languages: [], // empty = all languages
+  pattern: /\\b(TODO|FIXME|HACK|XXX)\\b/i,
+  suggestedFix: "Convert this comment into a tracked issue and reference the issue ID.",
+  tags: ["tech-debt", "comments"],
+};
+
+/**
+ * For more complex rules, use the \`analyze\` function instead of \`pattern\`:
+ *
+ * export const complexRule: CustomRule = {
+ *   id: "CUSTOM-002",
+ *   title: "Complex custom check",
+ *   severity: "medium",
+ *   judgeId: "cybersecurity",
+ *   description: "Example of a custom rule with analyze function.",
+ *   analyze: (code, language) => {
+ *     const findings: Finding[] = [];
+ *     // Your custom analysis logic here
+ *     return findings;
+ *   },
+ * };
+ */
+`;
+}
+function readmeTemplate(name) {
+    return `# ${name}
+
+A custom plugin for [Judges Panel](https://github.com/KevinRabun/judges).
+
+## Quick Start
+
+\`\`\`bash
+npm install
+npm run build
+\`\`\`
+
+## Usage
+
+### Via API
+
+\`\`\`ts
+import { registerPlugin } from "@kevinrabun/judges/api";
+import plugin from "${name}";
+
+registerPlugin(plugin);
+\`\`\`
+
+### Via .judgesrc
+
+\`\`\`json
+{
+  "plugins": ["${name}"]
+}
+\`\`\`
+
+## Adding Rules
+
+Create a new file in \`src/rules/\` and add it to the plugin's \`rules\` array in \`src/index.ts\`.
+
+### Pattern-Based Rule
+
+\`\`\`ts
+import type { CustomRule } from "@kevinrabun/judges/api";
+
+export const myRule: CustomRule = {
+  id: "MYORG-001",
+  title: "My custom rule",
+  severity: "medium",
+  judgeId: "cybersecurity",
+  description: "What this rule checks.",
+  pattern: /dangerousFunction\\(/,
+  suggestedFix: "Use safeFunction() instead.",
+};
+\`\`\`
+
+### Function-Based Rule
+
+\`\`\`ts
+import type { CustomRule, Finding } from "@kevinrabun/judges/api";
+
+export const myAdvancedRule: CustomRule = {
+  id: "MYORG-002",
+  title: "Advanced custom check",
+  severity: "high",
+  judgeId: "cybersecurity",
+  description: "Complex analysis with custom logic.",
+  analyze: (code: string, language: string): Finding[] => {
+    const findings: Finding[] = [];
+    // Your analysis logic here
+    return findings;
+  },
+};
+\`\`\`
+
+## License
+
+MIT
+`;
+}
+function parseScaffoldArgs(argv) {
+    const args = { name: undefined, dir: "." };
+    for (let i = 3; i < argv.length; i++) {
+        const arg = argv[i];
+        if (arg === "--dir" || arg === "-d") {
+            args.dir = argv[++i];
+        }
+        else if (!arg.startsWith("-") && !args.name) {
+            args.name = arg;
+        }
+    }
+    return args;
+}
+export function runScaffoldPlugin(argv) {
+    const args = parseScaffoldArgs(argv);
+    if (!args.name) {
+        console.error("Error: Plugin name required.");
+        console.error("Usage: judges scaffold-plugin <name> [--dir <path>]");
+        process.exit(1);
+    }
+    const name = args.name;
+    const root = resolve(args.dir, name);
+    if (existsSync(root)) {
+        console.error(`Error: Directory already exists: ${root}`);
+        process.exit(1);
+    }
+    // Create directory structure
+    mkdirSync(join(root, "src", "rules"), { recursive: true });
+    // Write files
+    const files = [
+        ["package.json", packageJsonTemplate(name)],
+        ["tsconfig.json", tsconfigTemplate()],
+        ["README.md", readmeTemplate(name)],
+        [join("src", "index.ts"), indexTemplate(name)],
+        [join("src", "rules", "example-rule.ts"), exampleRuleTemplate()],
+    ];
+    for (const [rel, content] of files) {
+        writeFileSync(join(root, rel), content, "utf-8");
+    }
+    console.log("");
+    console.log("╔══════════════════════════════════════════════════════════════╗");
+    console.log("║           Judges Panel — Plugin Scaffolded                  ║");
+    console.log("╚══════════════════════════════════════════════════════════════╝");
+    console.log("");
+    console.log(`  Created: ${root}`);
+    console.log("");
+    console.log("  Files:");
+    for (const [rel] of files) {
+        console.log(`    ${rel}`);
+    }
+    console.log("");
+    console.log("  Next steps:");
+    console.log(`    cd ${name}`);
+    console.log("    npm install");
+    console.log("    npm run build");
+    console.log("");
+    console.log("  Then register in your project:");
+    console.log(`    import plugin from "${name}";`);
+    console.log("    registerPlugin(plugin);");
+    console.log("");
+}
+//# sourceMappingURL=scaffold-plugin.js.map

package/dist/commands/scaffold-plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scaffold-plugin.js","sourceRoot":"","sources":["../../src/commands/scaffold-plugin.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,IAAI,CAAC;AAC1D,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAErC,gFAAgF;AAEhF,SAAS,mBAAmB,CAAC,IAAY;IACvC,OAAO,IAAI,CAAC,SAAS,CACnB;QACE,IAAI;QACJ,OAAO,EAAE,OAAO;QAChB,WAAW,EAAE,+BAA+B,IAAI,EAAE;QAClD,IAAI,EAAE,QAAQ;QACd,IAAI,EAAE,eAAe;QACrB,KAAK,EAAE,iBAAiB;QACxB,OAAO,EAAE;YACP,KAAK,EAAE,KAAK;YACZ,KAAK,EAAE,aAAa;YACpB,IAAI,EAAE,+BAA+B;SACtC;QACD,gBAAgB,EAAE;YAChB,mBAAmB,EAAE,UAAU;YAC/B,oBAAoB,EAAE,GAAG;SAC1B;QACD,eAAe,EAAE;YACf,UAAU,EAAE,QAAQ;SACrB;QACD,QAAQ,EAAE,CAAC,eAAe,EAAE,aAAa,EAAE,iBAAiB,CAAC;QAC7D,OAAO,EAAE,KAAK;KACf,EACD,IAAI,EACJ,CAAC,CACF,CAAC;AACJ,CAAC;AAED,SAAS,gBAAgB;IACvB,OAAO,IAAI,CAAC,SAAS,CACnB;QACE,eAAe,EAAE;YACf,MAAM,EAAE,QAAQ;YAChB,MAAM,EAAE,QAAQ;YAChB,gBAAgB,EAAE,QAAQ;YAC1B,WAAW,EAAE,IAAI;YACjB,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,KAAK;YACd,MAAM,EAAE,IAAI;YACZ,eAAe,EAAE,IAAI;YACrB,YAAY,EAAE,IAAI;SACnB;QACD,OAAO,EAAE,CAAC,KAAK,CAAC;KACjB,EACD,IAAI,EACJ,CAAC,CACF,CAAC;AACJ,CAAC;AAED,SAAS,aAAa,CAAC,IAAY;IACjC,OAAO;KACJ,IAAI;;;;;2BAKkB,IAAI;;;;;;;;WAQpB,IAAI;;8CAE+B,IAAI;;;;;;;;;;;;sCAYZ,IAAI;;;;;;CAMzC,CAAC;AACF,CAAC;AAED,SAAS,mBAAmB;IAC1B,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAqCR,CAAC;AACF,CAAC;AAED,SAAS,cAAc,CAAC,IAAY;IAClC,OAAO,KAAK,IAAI;;;;;;;;;;;;;;;;;sBAiBI,IAAI;;;;;;;;;iBAST,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA8CpB,CAAC;AACF,CAAC;AASD,SAAS,iBAAiB,CAAC,IAAc;IACvC,MAAM,IAAI,GAAiB,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC;IACzD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACrC,MAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QACpB,IAAI,GAAG,KAAK,OAAO,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;YACpC,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;QACvB,CAAC;aAAM,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;YAC9C,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC;QAClB,CAAC;IACH,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,IAAc;IAC9C,MAAM,IAAI,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAErC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,CAAC,8BAA8B,CAAC,CAAC;QAC9C,OAAO,CAAC,KAAK,CAAC,qDAAqD,CAAC,CAAC;QACrE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IAED,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;IACvB,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IAErC,IAAI,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;QACrB,OAAO,CAAC,KAAK,CAAC,oCAAoC,IAAI,EAAE,CAAC,CAAC;QAC1D,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IAED,6BAA6B;IAC7B,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAE3D,cAAc;IACd,MAAM,KAAK,GAA4B;QACrC,CAAC,cAAc,EAAE,mBAAmB,CAAC,IAAI,CAAC,CAAC;QAC3C,CAAC,eAAe,EAAE,gBAAgB,EAAE,CAAC;QACrC,CAAC,WAAW,EAAE,cAAc,CAAC,IAAI,CAAC,CAAC;QACnC,CAAC,IAAI,CAAC,KAAK,EAAE,UAAU,CAAC,EAAE,aAAa,CAAC,IAAI,CAAC,CAAC;QAC9C,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,EAAE,iBAAiB,CAAC,EAAE,mBAAmB,EAAE,CAAC;KACjE,CAAC;IAEF,KAAK,MAAM,CAAC,GAAG,EAAE,OAAO,CAAC,IAAI,KAAK,EAAE,CAAC;QACnC,aAAa,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IACnD,CAAC;IAED,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAChB,OAAO,CAAC,GAAG,CAAC,kEAAkE,CAAC,CAAC;IAChF,OAAO,CAAC,GAAG,CAAC,iEAAiE,CAAC,CAAC;IAC/E,OAAO,CAAC,GAAG,CAAC,kEAAkE,CAAC,CAAC;IAChF,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAChB,OAAO,CAAC,GAAG,CAAC,cAAc,IAAI,EAAE,CAAC,CAAC;IAClC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAChB,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IACxB,KAAK,MAAM,CAAC,GAAG,CAAC,IAAI,KAAK,EAAE,CAAC;QAC1B,OAAO,CAAC,GAAG,CAAC,OAAO,GAAG,EAAE,CAAC,CAAC;IAC5B,CAAC;IACD,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAChB,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;IAC7B,OAAO,CAAC,GAAG,CAAC,UAAU,IAAI,EAAE,CAAC,CAAC;IAC9B,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;IAC/B,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;IACjC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAChB,OAAO,CAAC,GAAG,CAAC,kCAAkC,CAAC,CAAC;IAChD,OAAO,CAAC,GAAG,CAAC,2BAA2B,IAAI,IAAI,CAAC,CAAC;IACjD,OAAO,CAAC,GAAG,CAAC,6BAA6B,CAAC,CAAC;IAC3C,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;AAClB,CAAC"}

package/dist/commands/tune.d.ts

@@ -0,0 +1,25 @@
+/**
+ * `judges tune` — Analyze your project and suggest optimal .judgesrc.json configuration.
+ *
+ * Runs an initial evaluation on a sample of project files, then recommends:
+ * - Which preset best fits your project
+ * - Rules to disable based on consistent FP patterns
+ * - Severity overrides for noisy rules
+ * - Framework-specific settings
+ *
+ * Usage:
+ *   judges tune                        # Analyze current directory
+ *   judges tune --dir ./src            # Analyze specific directory
+ *   judges tune --apply                # Write .judgesrc.json automatically
+ *   judges tune --max-files 20         # Limit sample size
+ */
+interface TuneArgs {
+    dir: string;
+    apply: boolean;
+    maxFiles: number;
+    verbose: boolean;
+}
+export declare function parseTuneArgs(argv: string[]): TuneArgs;
+export declare function runTune(argv: string[]): void;
+export {};
+//# sourceMappingURL=tune.d.ts.map

package/dist/commands/tune.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tune.d.ts","sourceRoot":"","sources":["../../src/commands/tune.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAUH,UAAU,QAAQ;IAChB,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,OAAO,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,OAAO,CAAC;CAClB;AAoQD,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,QAAQ,CAkCtD;AAED,wBAAgB,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI,CAkI5C"}