@rigour-labs/core 6.8.1 → 6.9.0-rc.2

package/dist/switches.d.ts

@@ -0,0 +1,640 @@
+/**
+ * A feature a team can turn off, on or require, and a person or a run can choose within that, as for the reviewer. Four
+ * layers, the nearest wins: a flag on this run, an environment variable (hooks and CI take no flags), the person's own
+ * settings (a key in the profile's settings.json), and the team's rigour.yml. `required` is the team's floor: a nearer
+ * layer that turns the feature off is refused, and the refusal is reported, never silent.
+ */
+import { type RigourSettings } from './settings.js';
+import type { Config } from './types/index.js';
+import type { Source } from './review/reviewer/settings.js';
+export type TeamSwitch = 'off' | 'on' | 'required';
+export declare const SWITCHES: {
+    goal: {
+        label: string;
+        env: string;
+        teamPath: string[];
+        team: (config: {
+            ignore: string[];
+            commands: {
+                format?: string | undefined;
+                lint?: string | undefined;
+                typecheck?: string | undefined;
+                test?: string | undefined;
+            };
+            gates: {
+                deep: {
+                    temperature: number;
+                    intent_checks: boolean;
+                    checks: {
+                        architecture: boolean;
+                        test_quality: boolean;
+                        solid: boolean;
+                        dry: boolean;
+                        design_patterns: boolean;
+                        language_idioms: boolean;
+                        error_handling: boolean;
+                        code_smells: boolean;
+                    };
+                    max_tokens?: number | undefined;
+                    timeout_ms?: number | undefined;
+                    budget_ms?: number | undefined;
+                    agentic?: boolean | undefined;
+                    repo_rules?: boolean | undefined;
+                    review_lessons?: "verified" | "all" | "off" | undefined;
+                    router?: {
+                        enabled?: boolean | undefined;
+                        min_score?: number | undefined;
+                        max_functions?: number | undefined;
+                    } | undefined;
+                };
+                max_file_lines: number;
+                forbid_todos: boolean;
+                forbid_fixme: boolean;
+                required_files: string[];
+                ast: {
+                    complexity: number;
+                    max_methods: number;
+                    max_params: number;
+                };
+                staleness: {
+                    enabled: boolean;
+                    rules: Record<string, boolean>;
+                };
+                dependencies: {
+                    forbid: string[];
+                    detect_unused: boolean;
+                    detect_heavy_alternatives: boolean;
+                    detect_duplicate_purpose: boolean;
+                    unused_allowlist: string[];
+                };
+                architecture: {
+                    boundaries: {
+                        from: string;
+                        to: string;
+                        mode: "allow" | "deny";
+                    }[];
+                };
+                safety: {
+                    max_files_changed_per_cycle: number;
+                    protected_paths: string[];
+                };
+                context: {
+                    enabled: boolean;
+                    sensitivity: number;
+                    mining_depth: number;
+                };
+                environment: {
+                    enabled: boolean;
+                    enforce_contracts: boolean;
+                    tools: Record<string, string>;
+                    required_env: string[];
+                };
+                retry_loop_breaker: {
+                    enabled: boolean;
+                    max_retries: number;
+                    doc_sources: Record<string, string>;
+                };
+                agent_team: {
+                    enabled: boolean;
+                    max_concurrent_agents: number;
+                    task_ownership: "strict" | "collaborative";
+                };
+                checkpoint: {
+                    enabled: boolean;
+                    interval_minutes: number;
+                    quality_threshold: number;
+                    drift_detection: boolean;
+                };
+                security: {
+                    enabled: boolean;
+                    sql_injection: boolean;
+                    xss: boolean;
+                    path_traversal: boolean;
+                    hardcoded_secrets: boolean;
+                    insecure_randomness: boolean;
+                    command_injection: boolean;
+                    block_on_severity: "critical" | "high" | "medium" | "low";
+                };
+                frontend_secret_exposure: {
+                    enabled: boolean;
+                    block_on_severity: "critical" | "high" | "medium" | "low";
+                    check_process_env: boolean;
+                    check_import_meta_env: boolean;
+                    secret_env_name_patterns: string[];
+                    safe_public_prefixes: string[];
+                    frontend_path_patterns: string[];
+                    server_path_patterns: string[];
+                    allowlist_env_names: string[];
+                };
+                duplication_drift: {
+                    enabled: boolean;
+                    similarity_threshold: number;
+                    min_body_lines: number;
+                };
+                hallucinated_imports: {
+                    enabled: boolean;
+                    ignore_patterns: string[];
+                };
+                inconsistent_error_handling: {
+                    enabled: boolean;
+                    max_strategies_per_type: number;
+                    min_occurrences: number;
+                    ignore_empty_catches: boolean;
+                };
+                context_window_artifacts: {
+                    enabled: boolean;
+                    min_file_lines: number;
+                    degradation_threshold: number;
+                    signals_required: number;
+                };
+                promise_safety: {
+                    enabled: boolean;
+                    ignore_patterns: string[];
+                    check_unhandled_then: boolean;
+                    check_unsafe_parse: boolean;
+                    check_async_without_await: boolean;
+                    check_unsafe_fetch: boolean;
+                };
+                phantom_apis: {
+                    enabled: boolean;
+                    ignore_patterns: string[];
+                    check_node: boolean;
+                    check_python: boolean;
+                    check_go: boolean;
+                    check_csharp: boolean;
+                    check_java: boolean;
+                };
+                deprecated_apis: {
+                    enabled: boolean;
+                    ignore_patterns: string[];
+                    check_node: boolean;
+                    check_python: boolean;
+                    check_go: boolean;
+                    check_csharp: boolean;
+                    check_java: boolean;
+                    check_web: boolean;
+                    block_security_deprecated: boolean;
+                };
+                test_quality: {
+                    enabled: boolean;
+                    check_empty_tests: boolean;
+                    check_tautological: boolean;
+                    check_mock_heavy: boolean;
+                    check_assertion_free_async: boolean;
+                    max_mocks_per_test: number;
+                };
+                governance: {
+                    enabled: boolean;
+                    enforce_memory: boolean;
+                    enforce_skills: boolean;
+                    block_native_memory: boolean;
+                    protected_memory_paths: string[];
+                    protected_skills_paths: string[];
+                    exempt_paths: string[];
+                };
+                unindexed_reads: {
+                    enabled: boolean;
+                    migrations: string[];
+                };
+                deprecated_dependencies: {
+                    enabled: boolean;
+                    registry?: string | undefined;
+                };
+                unused_exports: {
+                    enabled: boolean;
+                    allow: string[];
+                    block: boolean;
+                };
+                query_patterns: {
+                    enabled: boolean;
+                };
+                change_sweep: {
+                    enabled: boolean;
+                };
+                redundancy: {
+                    enabled: boolean;
+                    wire_contracts: string[];
+                    schema_migrations: string[];
+                };
+                optional_params: {
+                    enabled: boolean;
+                };
+                duplicate_functions: {
+                    enabled: boolean;
+                };
+                orphan_files: {
+                    enabled: boolean;
+                    allow: string[];
+                    block: boolean;
+                };
+                migration_order: {
+                    enabled: boolean;
+                    dirs: string[];
+                };
+                semantic_bugs: {
+                    enabled: boolean;
+                    rules?: string[] | undefined;
+                };
+                side_effect_analysis: {
+                    enabled: boolean;
+                    ignore_patterns: string[];
+                    check_unbounded_timers: boolean;
+                    check_unbounded_loops: boolean;
+                    check_process_lifecycle: boolean;
+                    check_recursive_depth: boolean;
+                    check_resource_lifecycle: boolean;
+                    check_retry_without_limit: boolean;
+                    check_circular_triggers: boolean;
+                    check_auto_restart: boolean;
+                };
+                style_drift: {
+                    enabled: boolean;
+                    deviation_threshold: number;
+                    sample_size: number;
+                    baseline_path: string;
+                };
+                logic_drift: {
+                    enabled: boolean;
+                    baseline_path: string;
+                    track_operators: boolean;
+                    track_branches: boolean;
+                    track_returns: boolean;
+                };
+            };
+            hooks: {
+                require_review_ack: boolean;
+            };
+            output: {
+                report_path: string;
+            };
+            brief: {
+                enabled: boolean;
+                max_items: number;
+            };
+            learning: {
+                outcomes: {
+                    mode: "off" | "on" | "required";
+                    window_days: number;
+                    demote_after: number;
+                };
+            };
+            review: {
+                include_heuristics: boolean;
+                show_preexisting: boolean;
+                goal: "off" | "on" | "required";
+                reviewer: {
+                    enabled: boolean;
+                    mode: "single" | "cross" | "full";
+                    timeout_ms: number;
+                    on_push: "off" | "background" | "wait";
+                    reviewers: string[];
+                    models: Record<string, string>;
+                    panel: "off" | "on" | "required";
+                    mode_required: boolean;
+                    dismissals: boolean;
+                    panel_max_items: number;
+                    judges: 2 | 3;
+                    escalate: "always" | "risk";
+                    cross_models: Record<string, string>;
+                    reasoning: Record<string, "high" | "medium" | "low">;
+                    judge_env: Record<string, {
+                        unset: string[];
+                    }>;
+                    model?: string | undefined;
+                    max_runs_per_day?: number | undefined;
+                    max_usd_per_day?: number | undefined;
+                    api?: {
+                        model: string;
+                        url: string;
+                        key_env: string;
+                        max_turns: number;
+                        vendor?: "anthropic" | "openai" | "google" | "other" | undefined;
+                    } | undefined;
+                };
+                github_account?: string | undefined;
+            };
+            preset?: string | undefined;
+            paradigm?: string | undefined;
+        }) => "off" | "on" | "required";
+    };
+    outcomes: {
+        label: string;
+        env: string;
+        teamPath: string[];
+        team: (config: {
+            ignore: string[];
+            commands: {
+                format?: string | undefined;
+                lint?: string | undefined;
+                typecheck?: string | undefined;
+                test?: string | undefined;
+            };
+            gates: {
+                deep: {
+                    temperature: number;
+                    intent_checks: boolean;
+                    checks: {
+                        architecture: boolean;
+                        test_quality: boolean;
+                        solid: boolean;
+                        dry: boolean;
+                        design_patterns: boolean;
+                        language_idioms: boolean;
+                        error_handling: boolean;
+                        code_smells: boolean;
+                    };
+                    max_tokens?: number | undefined;
+                    timeout_ms?: number | undefined;
+                    budget_ms?: number | undefined;
+                    agentic?: boolean | undefined;
+                    repo_rules?: boolean | undefined;
+                    review_lessons?: "verified" | "all" | "off" | undefined;
+                    router?: {
+                        enabled?: boolean | undefined;
+                        min_score?: number | undefined;
+                        max_functions?: number | undefined;
+                    } | undefined;
+                };
+                max_file_lines: number;
+                forbid_todos: boolean;
+                forbid_fixme: boolean;
+                required_files: string[];
+                ast: {
+                    complexity: number;
+                    max_methods: number;
+                    max_params: number;
+                };
+                staleness: {
+                    enabled: boolean;
+                    rules: Record<string, boolean>;
+                };
+                dependencies: {
+                    forbid: string[];
+                    detect_unused: boolean;
+                    detect_heavy_alternatives: boolean;
+                    detect_duplicate_purpose: boolean;
+                    unused_allowlist: string[];
+                };
+                architecture: {
+                    boundaries: {
+                        from: string;
+                        to: string;
+                        mode: "allow" | "deny";
+                    }[];
+                };
+                safety: {
+                    max_files_changed_per_cycle: number;
+                    protected_paths: string[];
+                };
+                context: {
+                    enabled: boolean;
+                    sensitivity: number;
+                    mining_depth: number;
+                };
+                environment: {
+                    enabled: boolean;
+                    enforce_contracts: boolean;
+                    tools: Record<string, string>;
+                    required_env: string[];
+                };
+                retry_loop_breaker: {
+                    enabled: boolean;
+                    max_retries: number;
+                    doc_sources: Record<string, string>;
+                };
+                agent_team: {
+                    enabled: boolean;
+                    max_concurrent_agents: number;
+                    task_ownership: "strict" | "collaborative";
+                };
+                checkpoint: {
+                    enabled: boolean;
+                    interval_minutes: number;
+                    quality_threshold: number;
+                    drift_detection: boolean;
+                };
+                security: {
+                    enabled: boolean;
+                    sql_injection: boolean;
+                    xss: boolean;
+                    path_traversal: boolean;
+                    hardcoded_secrets: boolean;
+                    insecure_randomness: boolean;
+                    command_injection: boolean;
+                    block_on_severity: "critical" | "high" | "medium" | "low";
+                };
+                frontend_secret_exposure: {
+                    enabled: boolean;
+                    block_on_severity: "critical" | "high" | "medium" | "low";
+                    check_process_env: boolean;
+                    check_import_meta_env: boolean;
+                    secret_env_name_patterns: string[];
+                    safe_public_prefixes: string[];
+                    frontend_path_patterns: string[];
+                    server_path_patterns: string[];
+                    allowlist_env_names: string[];
+                };
+                duplication_drift: {
+                    enabled: boolean;
+                    similarity_threshold: number;
+                    min_body_lines: number;
+                };
+                hallucinated_imports: {
+                    enabled: boolean;
+                    ignore_patterns: string[];
+                };
+                inconsistent_error_handling: {
+                    enabled: boolean;
+                    max_strategies_per_type: number;
+                    min_occurrences: number;
+                    ignore_empty_catches: boolean;
+                };
+                context_window_artifacts: {
+                    enabled: boolean;
+                    min_file_lines: number;
+                    degradation_threshold: number;
+                    signals_required: number;
+                };
+                promise_safety: {
+                    enabled: boolean;
+                    ignore_patterns: string[];
+                    check_unhandled_then: boolean;
+                    check_unsafe_parse: boolean;
+                    check_async_without_await: boolean;
+                    check_unsafe_fetch: boolean;
+                };
+                phantom_apis: {
+                    enabled: boolean;
+                    ignore_patterns: string[];
+                    check_node: boolean;
+                    check_python: boolean;
+                    check_go: boolean;
+                    check_csharp: boolean;
+                    check_java: boolean;
+                };
+                deprecated_apis: {
+                    enabled: boolean;
+                    ignore_patterns: string[];
+                    check_node: boolean;
+                    check_python: boolean;
+                    check_go: boolean;
+                    check_csharp: boolean;
+                    check_java: boolean;
+                    check_web: boolean;
+                    block_security_deprecated: boolean;
+                };
+                test_quality: {
+                    enabled: boolean;
+                    check_empty_tests: boolean;
+                    check_tautological: boolean;
+                    check_mock_heavy: boolean;
+                    check_assertion_free_async: boolean;
+                    max_mocks_per_test: number;
+                };
+                governance: {
+                    enabled: boolean;
+                    enforce_memory: boolean;
+                    enforce_skills: boolean;
+                    block_native_memory: boolean;
+                    protected_memory_paths: string[];
+                    protected_skills_paths: string[];
+                    exempt_paths: string[];
+                };
+                unindexed_reads: {
+                    enabled: boolean;
+                    migrations: string[];
+                };
+                deprecated_dependencies: {
+                    enabled: boolean;
+                    registry?: string | undefined;
+                };
+                unused_exports: {
+                    enabled: boolean;
+                    allow: string[];
+                    block: boolean;
+                };
+                query_patterns: {
+                    enabled: boolean;
+                };
+                change_sweep: {
+                    enabled: boolean;
+                };
+                redundancy: {
+                    enabled: boolean;
+                    wire_contracts: string[];
+                    schema_migrations: string[];
+                };
+                optional_params: {
+                    enabled: boolean;
+                };
+                duplicate_functions: {
+                    enabled: boolean;
+                };
+                orphan_files: {
+                    enabled: boolean;
+                    allow: string[];
+                    block: boolean;
+                };
+                migration_order: {
+                    enabled: boolean;
+                    dirs: string[];
+                };
+                semantic_bugs: {
+                    enabled: boolean;
+                    rules?: string[] | undefined;
+                };
+                side_effect_analysis: {
+                    enabled: boolean;
+                    ignore_patterns: string[];
+                    check_unbounded_timers: boolean;
+                    check_unbounded_loops: boolean;
+                    check_process_lifecycle: boolean;
+                    check_recursive_depth: boolean;
+                    check_resource_lifecycle: boolean;
+                    check_retry_without_limit: boolean;
+                    check_circular_triggers: boolean;
+                    check_auto_restart: boolean;
+                };
+                style_drift: {
+                    enabled: boolean;
+                    deviation_threshold: number;
+                    sample_size: number;
+                    baseline_path: string;
+                };
+                logic_drift: {
+                    enabled: boolean;
+                    baseline_path: string;
+                    track_operators: boolean;
+                    track_branches: boolean;
+                    track_returns: boolean;
+                };
+            };
+            hooks: {
+                require_review_ack: boolean;
+            };
+            output: {
+                report_path: string;
+            };
+            brief: {
+                enabled: boolean;
+                max_items: number;
+            };
+            learning: {
+                outcomes: {
+                    mode: "off" | "on" | "required";
+                    window_days: number;
+                    demote_after: number;
+                };
+            };
+            review: {
+                include_heuristics: boolean;
+                show_preexisting: boolean;
+                goal: "off" | "on" | "required";
+                reviewer: {
+                    enabled: boolean;
+                    mode: "single" | "cross" | "full";
+                    timeout_ms: number;
+                    on_push: "off" | "background" | "wait";
+                    reviewers: string[];
+                    models: Record<string, string>;
+                    panel: "off" | "on" | "required";
+                    mode_required: boolean;
+                    dismissals: boolean;
+                    panel_max_items: number;
+                    judges: 2 | 3;
+                    escalate: "always" | "risk";
+                    cross_models: Record<string, string>;
+                    reasoning: Record<string, "high" | "medium" | "low">;
+                    judge_env: Record<string, {
+                        unset: string[];
+                    }>;
+                    model?: string | undefined;
+                    max_runs_per_day?: number | undefined;
+                    max_usd_per_day?: number | undefined;
+                    api?: {
+                        model: string;
+                        url: string;
+                        key_env: string;
+                        max_turns: number;
+                        vendor?: "anthropic" | "openai" | "google" | "other" | undefined;
+                    } | undefined;
+                };
+                github_account?: string | undefined;
+            };
+            preset?: string | undefined;
+            paradigm?: string | undefined;
+        }) => "off" | "on" | "required";
+    };
+};
+export type SwitchName = keyof typeof SWITCHES & keyof RigourSettings;
+export interface ResolvedSwitch {
+    enabled: boolean;
+    source: Source;
+    /** The team requires it: no nearer layer turns it off. */
+    required: boolean;
+    /** Nearer choices that were not applied, one line each, for the report. */
+    refused: string[];
+}
+export declare function resolveSwitch(name: SwitchName, config: Config, flag?: boolean, user?: boolean | undefined, env?: NodeJS.ProcessEnv): ResolvedSwitch;
+/** The person's own choice, from Studio: true or false sets it, `null` goes back to the team's. Returns what is stored. */
+export declare function saveUserSwitch(name: SwitchName, value: unknown): boolean | undefined;

package/dist/switches.js

@@ -0,0 +1,36 @@
+/**
+ * A feature a team can turn off, on or require, and a person or a run can choose within that, as for the reviewer. Four
+ * layers, the nearest wins: a flag on this run, an environment variable (hooks and CI take no flags), the person's own
+ * settings (a key in the profile's settings.json), and the team's rigour.yml. `required` is the team's floor: a nearer
+ * layer that turns the feature off is refused, and the refusal is reported, never silent.
+ */
+import { loadSettings, saveSettings } from './settings.js';
+export const SWITCHES = {
+    goal: { label: 'goal check', env: 'RIGOUR_GOAL', teamPath: ['review', 'goal'], team: config => config.review?.goal },
+    outcomes: { label: 'outcome loop', env: 'RIGOUR_OUTCOMES', teamPath: ['learning', 'outcomes', 'mode'], team: config => config.learning?.outcomes?.mode },
+};
+export function resolveSwitch(name, config, flag, user = loadSettings()[name], env = process.env) {
+    const definition = SWITCHES[name];
+    const team = definition.team(config) ?? 'off';
+    const required = team === 'required';
+    const refused = [];
+    const given = env[definition.env];
+    const raw = given?.trim().toLowerCase();
+    const fromEnv = raw === 'on' || raw === '1' || raw === 'true' ? true : raw === 'off' || raw === '0' || raw === 'false' ? false : undefined;
+    if (raw && fromEnv === undefined)
+        refused.push(`${definition.env}=${given} ignored: use on or off`);
+    const near = [['flag', flag], ['env', fromEnv], ['user', user]].find(([, value]) => value !== undefined);
+    if (near && !(required && near[1] === false))
+        return { enabled: near[1], source: near[0], required, refused };
+    if (near)
+        refused.push(`${definition.label} off (${near[0]}) refused: rigour.yml sets ${definition.teamPath.join('.')}: required`);
+    return { enabled: team !== 'off', source: 'team', required, refused };
+}
+/** The person's own choice, from Studio: true or false sets it, `null` goes back to the team's. Returns what is stored. */
+export function saveUserSwitch(name, value) {
+    if (value !== null && typeof value !== 'boolean')
+        throw new Error(`${name} is true, false, or null for the team's`);
+    const { [name]: _previous, ...settings } = loadSettings();
+    saveSettings(value === null ? settings : { ...settings, [name]: value });
+    return value ?? undefined;
+}