slopbrick 0.19.0 → 0.21.0

package/dist/index.d.cts

@@ -727,6 +727,14 @@ interface Rule<Context = unknown> {
     aiSpecific: boolean;
     /** Round 25: short description shown by `slopbrick rules` and used in docs. */
     description?: string;
+    /**
+     * v0.20.0: when true, the rule is shipped disabled (off) by default.
+     * Users can opt in via `slopbrick.config.mjs` ruleConfig. The
+     * defaultOff flag means "this rule is too noisy / uncalibrated to
+     * run unconditionally — a user has to explicitly turn it on".
+     * See `src/snippet/data.ts` for the canonical list.
+     */
+    defaultOff?: boolean;
     create(context: RuleContext): Context;
     analyze(context: Context, facts: ScanFacts): Issue[];
 }
@@ -833,7 +841,7 @@ type Bucket = 'ai' | 'hygiene' | 'suppressed';
  *
  * v3 dropped the single `slopIndex` headline in favor of four named
  * scores:
- *   - `aiQuality`           — AI-specific findings (USEFUL + OK verdicts)
+ *   - `aiSlopScore`           — AI-specific findings (USEFUL + OK verdicts)
  *   - `engineeringHygiene`  — HYGIENE + INVERTED rules
  *   - `security`            — security/* rules
  *   - `repositoryHealth`    — composite (0.5*aiQ + 0.3*eng + 0.2*sec)
@@ -845,7 +853,7 @@ interface HealthFile {
     version: typeof _usebrick_core.STRUCTURE_SCHEMA_VERSION;
     generatedAt: string;
     workspace: string;
-    aiQuality: number;
+    aiSlopScore: number;
     engineeringHygiene: number;
     security: number;
     repositoryHealth: number;
@@ -894,14 +902,14 @@ interface MaintenanceAxes {
     /** v0.15.0 U.4+: 0-100, higher = better. The new headline score
      *  that replaces slopIndex. Tests and callers should pass this
      *  going forward. */
-    aiQuality?: number;
+    aiSlopScore?: number;
     /** v0.15.0 U.4+: 0-100, higher = better. */
     engineeringHygiene?: number;
     /** v0.15.0 U.4+: 0-100, higher = better. */
     security?: number;
     /** v0.15.0 U.4+: 0-100, higher = better. */
     repositoryHealth?: number;
-    /** 0-100, lower = better. @deprecated v0.15.0: use aiQuality. Kept
+    /** 0-100, lower = better. @deprecated v0.15.0: use aiSlopScore. Kept
      *  for backward compat with existing test fixtures and historical
      *  telemetry. The axis inverts it internally. */
     slopIndex?: number;
@@ -951,7 +959,7 @@ interface AiMaintenanceCostResult {
 type DocDriftLevel = 'low' | 'medium' | 'high' | 'critical';
 /** A single doc-drift finding — one rule firing on one line. */
 interface DocFinding {
-    ruleId: 'docs/stale-package-reference' | 'docs/stale-function-reference' | 'docs/expired-code-example' | 'docs/broken-link';
+    ruleId: 'docs/stale-package-reference' | 'docs/stale-function-reference' | 'docs/broken-link';
     severity: 'low' | 'medium' | 'high';
     docFile: string;
     line: number;
@@ -1004,7 +1012,7 @@ interface RepositoryHealthInputs {
     /** v0.15.0 U.4+: 0-100, higher = better. The new headline score
      *  that replaces slopIndex. Tests and callers should pass this
      *  going forward. */
-    aiQuality?: number;
+    aiSlopScore?: number;
     /** v0.15.0 U.4+: 0-100, higher = better. */
     engineeringHygiene?: number;
     /** v0.15.0 U.4+: 0-100, higher = better. */
@@ -1012,7 +1020,7 @@ interface RepositoryHealthInputs {
     /** v0.15.0 U.4+: 0-100, higher = better. */
     repositoryHealth?: number;
     /** 0-100, lower = better. Inverted to 100 - x for the composite.
-     *  @deprecated v0.15.0: use aiQuality. Kept for backward compat. */
+     *  @deprecated v0.15.0: use aiSlopScore. Kept for backward compat. */
     slopIndex?: number;
     /** 0-100, higher = better. */
     architectureConsistency?: number;
@@ -1184,16 +1192,26 @@ interface ProjectReport {
     version: string;
     generatedAt: string;
     configPath?: string;
-    /** v0.15.0 U.4+: replaces the legacy slopIndex. 0-100, higher is better. */
-    aiQuality: number;
+    /**
+     * v0.20.0: renamed from `aiSlopScore` to `aiSlopScore` because the
+     * old name implied a property of the *code* (quality) when it
+     * actually measures a property of the *tool's detection* (how
+     * many AI-detection rules fire on this codebase). 0-100, higher
+     * is better — but 'better' means 'fewer rule fires', not
+     * 'higher quality code'. The name "AI Slop Score" matches the
+     * existing description ("measures AI-slop signatures") and the
+     * slopbrick brand. See the pre-publish checklist in
+     * CONTRIBUTING.md for the full rationale.
+     */
+    aiSlopScore: number;
     engineeringHygiene: number;
     security: number;
     repositoryHealth: number;
     assemblyHealth: number;
     totalScore: number;
-    /** @deprecated v0.15.0: use aiQuality. Kept as optional for backward
-     *  compat with existing test fixtures and historical telemetry. Will be
-     *  removed in v0.16.0. */
+    /** @deprecated v0.20.0: use `aiSlopScore`. Kept as optional for
+     *  backward compat with existing test fixtures and historical
+     *  telemetry. Will be removed in v0.21. */
     slopIndex?: number;
     categoryScores: Record<Category, number>;
     /** Phase 2 §10: composite subscores. Each is in 0-100 (capped).

package/dist/index.d.ts

@@ -727,6 +727,14 @@ interface Rule<Context = unknown> {
     aiSpecific: boolean;
     /** Round 25: short description shown by `slopbrick rules` and used in docs. */
     description?: string;
+    /**
+     * v0.20.0: when true, the rule is shipped disabled (off) by default.
+     * Users can opt in via `slopbrick.config.mjs` ruleConfig. The
+     * defaultOff flag means "this rule is too noisy / uncalibrated to
+     * run unconditionally — a user has to explicitly turn it on".
+     * See `src/snippet/data.ts` for the canonical list.
+     */
+    defaultOff?: boolean;
     create(context: RuleContext): Context;
     analyze(context: Context, facts: ScanFacts): Issue[];
 }
@@ -833,7 +841,7 @@ type Bucket = 'ai' | 'hygiene' | 'suppressed';
  *
  * v3 dropped the single `slopIndex` headline in favor of four named
  * scores:
- *   - `aiQuality`           — AI-specific findings (USEFUL + OK verdicts)
+ *   - `aiSlopScore`           — AI-specific findings (USEFUL + OK verdicts)
  *   - `engineeringHygiene`  — HYGIENE + INVERTED rules
  *   - `security`            — security/* rules
  *   - `repositoryHealth`    — composite (0.5*aiQ + 0.3*eng + 0.2*sec)
@@ -845,7 +853,7 @@ interface HealthFile {
     version: typeof _usebrick_core.STRUCTURE_SCHEMA_VERSION;
     generatedAt: string;
     workspace: string;
-    aiQuality: number;
+    aiSlopScore: number;
     engineeringHygiene: number;
     security: number;
     repositoryHealth: number;
@@ -894,14 +902,14 @@ interface MaintenanceAxes {
     /** v0.15.0 U.4+: 0-100, higher = better. The new headline score
      *  that replaces slopIndex. Tests and callers should pass this
      *  going forward. */
-    aiQuality?: number;
+    aiSlopScore?: number;
     /** v0.15.0 U.4+: 0-100, higher = better. */
     engineeringHygiene?: number;
     /** v0.15.0 U.4+: 0-100, higher = better. */
     security?: number;
     /** v0.15.0 U.4+: 0-100, higher = better. */
     repositoryHealth?: number;
-    /** 0-100, lower = better. @deprecated v0.15.0: use aiQuality. Kept
+    /** 0-100, lower = better. @deprecated v0.15.0: use aiSlopScore. Kept
      *  for backward compat with existing test fixtures and historical
      *  telemetry. The axis inverts it internally. */
     slopIndex?: number;
@@ -951,7 +959,7 @@ interface AiMaintenanceCostResult {
 type DocDriftLevel = 'low' | 'medium' | 'high' | 'critical';
 /** A single doc-drift finding — one rule firing on one line. */
 interface DocFinding {
-    ruleId: 'docs/stale-package-reference' | 'docs/stale-function-reference' | 'docs/expired-code-example' | 'docs/broken-link';
+    ruleId: 'docs/stale-package-reference' | 'docs/stale-function-reference' | 'docs/broken-link';
     severity: 'low' | 'medium' | 'high';
     docFile: string;
     line: number;
@@ -1004,7 +1012,7 @@ interface RepositoryHealthInputs {
     /** v0.15.0 U.4+: 0-100, higher = better. The new headline score
      *  that replaces slopIndex. Tests and callers should pass this
      *  going forward. */
-    aiQuality?: number;
+    aiSlopScore?: number;
     /** v0.15.0 U.4+: 0-100, higher = better. */
     engineeringHygiene?: number;
     /** v0.15.0 U.4+: 0-100, higher = better. */
@@ -1012,7 +1020,7 @@ interface RepositoryHealthInputs {
     /** v0.15.0 U.4+: 0-100, higher = better. */
     repositoryHealth?: number;
     /** 0-100, lower = better. Inverted to 100 - x for the composite.
-     *  @deprecated v0.15.0: use aiQuality. Kept for backward compat. */
+     *  @deprecated v0.15.0: use aiSlopScore. Kept for backward compat. */
     slopIndex?: number;
     /** 0-100, higher = better. */
     architectureConsistency?: number;
@@ -1184,16 +1192,26 @@ interface ProjectReport {
     version: string;
     generatedAt: string;
     configPath?: string;
-    /** v0.15.0 U.4+: replaces the legacy slopIndex. 0-100, higher is better. */
-    aiQuality: number;
+    /**
+     * v0.20.0: renamed from `aiSlopScore` to `aiSlopScore` because the
+     * old name implied a property of the *code* (quality) when it
+     * actually measures a property of the *tool's detection* (how
+     * many AI-detection rules fire on this codebase). 0-100, higher
+     * is better — but 'better' means 'fewer rule fires', not
+     * 'higher quality code'. The name "AI Slop Score" matches the
+     * existing description ("measures AI-slop signatures") and the
+     * slopbrick brand. See the pre-publish checklist in
+     * CONTRIBUTING.md for the full rationale.
+     */
+    aiSlopScore: number;
     engineeringHygiene: number;
     security: number;
     repositoryHealth: number;
     assemblyHealth: number;
     totalScore: number;
-    /** @deprecated v0.15.0: use aiQuality. Kept as optional for backward
-     *  compat with existing test fixtures and historical telemetry. Will be
-     *  removed in v0.16.0. */
+    /** @deprecated v0.20.0: use `aiSlopScore`. Kept as optional for
+     *  backward compat with existing test fixtures and historical
+     *  telemetry. Will be removed in v0.21. */
     slopIndex?: number;
     categoryScores: Record<Category, number>;
     /** Phase 2 §10: composite subscores. Each is in 0-100 (capped).