slopbrick 0.21.2 → 0.25.0

package/dist/index.d.cts

@@ -737,6 +737,27 @@ interface RuleContext {
     supportsRsc?: boolean;
     hotspotIssues?: Issue[];
 }
+/**
+ * v0.25.0: self-scan excludes. When `selfScan.excludePaths` is set, the
+ * scan worker skips files whose workspace-relative path matches any of
+ * the glob patterns. This is for *self-scanning* the slopbrick repo
+ * itself, where rule definitions (`src/rules/**`) and test fixtures
+ * (`tests/fixtures/**`, `tests/rules/**`) are meta-code — the rules
+ * contain examples of the patterns they detect (self-fire), and test
+ * fixtures contain intentional bad code that the rules must fire on
+ * to be useful. Both are false positives in the self-scan context.
+ *
+ * Default excludes (in `config/defaults.ts`) cover exactly these three
+ * paths. Users who scan a *different* repo can leave `selfScan` unset
+ * (or set `excludePaths: []`) to opt out. Empty array disables; absent
+ * field uses defaults.
+ */
+interface ScanSelfScanConfig {
+    /** Glob patterns (minimatch) to exclude from the scan. Matched against
+     *  the workspace-relative POSIX-style path. Dot files are matched
+     *  (`{ dot: true }` semantics). */
+    excludePaths: string[];
+}
 interface Rule<Context = unknown> {
     id: string;
     category: Category;
@@ -832,6 +853,19 @@ interface ResolvedConfig {
         /** Walk production AST to find branches without test coverage. */
         missingEdgeCase?: boolean;
     };
+    /**
+     * v0.25.0: self-scan exclude paths. Applied at scan time (in
+     * `engine/worker.ts`) so files matching any glob in `excludePaths`
+     * short-circuit with empty issues. Defaults (in `config/defaults.ts`)
+     * cover the three "always false positive in self-scan" paths:
+     * rule definitions (`src/rules/**`), test fixtures
+     * (`tests/fixtures/**`), and rule test files (`tests/rules/**`).
+     *
+     * Empty array `excludePaths: []` disables exclusion entirely
+     * (legacy behavior — every file is scanned). Unset field uses
+     * defaults.
+     */
+    selfScan?: ScanSelfScanConfig;
 }
 
 /**
@@ -1578,4 +1612,4 @@ declare function formatBadge(report: ProjectReport): string;
 /** Render an array of values as a Unicode sparkline (▁▂▃▄▅▆▇█). */
 declare function formatSparkline(values: number[]): string;
 
-export { AI_SECURITY_NUMERIC, type AiDebt, type AiMaintenanceCost, type AiMaintenanceCostResult, type AstroComponentFact, type AutoTunedRule, type BaselineCache, type BaselineMeta, type CachedFile, type Category, type ClassNameFact, type CommentFact, type ComponentFacts, type ComponentScore, type ComponentSizeFact, type ConsoleCallFact, type Constitution, DEFAULT_CONFIG, type DangerouslySetInnerHtmlFact, type DbDriftLevel, type DbFinding, type DialogCallFact, type DisabledLintRuleFact, type DocDriftLevel, type DocFinding, type DomQueryFact, type ElementFact, type EvalCallFact, type ExplicitAnyFact, type FetchCallFact, type FileScanResult, type FixSuggestion, type FlywheelOutput, type FlywheelState, type Framework$1 as Framework, type HealthFile, type HookCallFact, type HookDependencyArrayFact, type HookFact, type ImportFact, type InlineEventHandlerFact, type Issue, type JsxAttributeStringLiteralFact, type JsxTextLiteralFact, type KeyPropFact, type LogicalExpressionFact, type MagicNumberSpacingConfig, type MaintenanceAxes, type MaintenanceAxisHealth, type NonNullAssertionFact, type OptimisticUpdateFact, type ProjectReport, type PropMutationFact, type PropPassThroughFact, REPOSITORY_HEALTH_WEIGHTS, type ReportReadResult, type RepositoryHealth, type RepositoryHealthInputs, type ResearchMetrics, type ResolvedConfig, type Rule, type RuleContext, type RuleSeverity, type RuleSuggestion, type ScanCache, type ScanFacts, type ScanProjectOptions, type Severity, type SlopAuditRun, type StateBinding, type StateBindingFact, type StringLiteralFact, type StylePropFact, type TamaguiStylePropFact, type TopOffender, type UseEffectBodyFact, VERSION, baselineStatusMessage, colorForSlop, failedThresholdCount, filterByDisabledDirectives, filterIssues, formatBadge, formatReportFromFile, formatSparkline, loadConfig, readReportFile, runCli, runInitWizard, scanProject, serializeConfig, stagedGating, thresholdExceeded };
+export { AI_SECURITY_NUMERIC, type AiDebt, type AiMaintenanceCost, type AiMaintenanceCostResult, type AstroComponentFact, type AutoTunedRule, type BaselineCache, type BaselineMeta, type CachedFile, type Category, type ClassNameFact, type CommentFact, type ComponentFacts, type ComponentScore, type ComponentSizeFact, type ConsoleCallFact, type Constitution, DEFAULT_CONFIG, type DangerouslySetInnerHtmlFact, type DbDriftLevel, type DbFinding, type DialogCallFact, type DisabledLintRuleFact, type DocDriftLevel, type DocFinding, type DomQueryFact, type ElementFact, type EvalCallFact, type ExplicitAnyFact, type FetchCallFact, type FileScanResult, type FixSuggestion, type FlywheelOutput, type FlywheelState, type Framework$1 as Framework, type HealthFile, type HookCallFact, type HookDependencyArrayFact, type HookFact, type ImportFact, type InlineEventHandlerFact, type Issue, type JsxAttributeStringLiteralFact, type JsxTextLiteralFact, type KeyPropFact, type LogicalExpressionFact, type MagicNumberSpacingConfig, type MaintenanceAxes, type MaintenanceAxisHealth, type NonNullAssertionFact, type OptimisticUpdateFact, type ProjectReport, type PropMutationFact, type PropPassThroughFact, REPOSITORY_HEALTH_WEIGHTS, type ReportReadResult, type RepositoryHealth, type RepositoryHealthInputs, type ResearchMetrics, type ResolvedConfig, type Rule, type RuleContext, type RuleSeverity, type RuleSuggestion, type ScanCache, type ScanFacts, type ScanProjectOptions, type ScanSelfScanConfig, type Severity, type SlopAuditRun, type StateBinding, type StateBindingFact, type StringLiteralFact, type StylePropFact, type TamaguiStylePropFact, type TopOffender, type UseEffectBodyFact, VERSION, baselineStatusMessage, colorForSlop, failedThresholdCount, filterByDisabledDirectives, filterIssues, formatBadge, formatReportFromFile, formatSparkline, loadConfig, readReportFile, runCli, runInitWizard, scanProject, serializeConfig, stagedGating, thresholdExceeded };

package/dist/index.d.ts

@@ -737,6 +737,27 @@ interface RuleContext {
     supportsRsc?: boolean;
     hotspotIssues?: Issue[];
 }
+/**
+ * v0.25.0: self-scan excludes. When `selfScan.excludePaths` is set, the
+ * scan worker skips files whose workspace-relative path matches any of
+ * the glob patterns. This is for *self-scanning* the slopbrick repo
+ * itself, where rule definitions (`src/rules/**`) and test fixtures
+ * (`tests/fixtures/**`, `tests/rules/**`) are meta-code — the rules
+ * contain examples of the patterns they detect (self-fire), and test
+ * fixtures contain intentional bad code that the rules must fire on
+ * to be useful. Both are false positives in the self-scan context.
+ *
+ * Default excludes (in `config/defaults.ts`) cover exactly these three
+ * paths. Users who scan a *different* repo can leave `selfScan` unset
+ * (or set `excludePaths: []`) to opt out. Empty array disables; absent
+ * field uses defaults.
+ */
+interface ScanSelfScanConfig {
+    /** Glob patterns (minimatch) to exclude from the scan. Matched against
+     *  the workspace-relative POSIX-style path. Dot files are matched
+     *  (`{ dot: true }` semantics). */
+    excludePaths: string[];
+}
 interface Rule<Context = unknown> {
     id: string;
     category: Category;
@@ -832,6 +853,19 @@ interface ResolvedConfig {
         /** Walk production AST to find branches without test coverage. */
         missingEdgeCase?: boolean;
     };
+    /**
+     * v0.25.0: self-scan exclude paths. Applied at scan time (in
+     * `engine/worker.ts`) so files matching any glob in `excludePaths`
+     * short-circuit with empty issues. Defaults (in `config/defaults.ts`)
+     * cover the three "always false positive in self-scan" paths:
+     * rule definitions (`src/rules/**`), test fixtures
+     * (`tests/fixtures/**`), and rule test files (`tests/rules/**`).
+     *
+     * Empty array `excludePaths: []` disables exclusion entirely
+     * (legacy behavior — every file is scanned). Unset field uses
+     * defaults.
+     */
+    selfScan?: ScanSelfScanConfig;
 }
 
 /**
@@ -1578,4 +1612,4 @@ declare function formatBadge(report: ProjectReport): string;
 /** Render an array of values as a Unicode sparkline (▁▂▃▄▅▆▇█). */
 declare function formatSparkline(values: number[]): string;
 
-export { AI_SECURITY_NUMERIC, type AiDebt, type AiMaintenanceCost, type AiMaintenanceCostResult, type AstroComponentFact, type AutoTunedRule, type BaselineCache, type BaselineMeta, type CachedFile, type Category, type ClassNameFact, type CommentFact, type ComponentFacts, type ComponentScore, type ComponentSizeFact, type ConsoleCallFact, type Constitution, DEFAULT_CONFIG, type DangerouslySetInnerHtmlFact, type DbDriftLevel, type DbFinding, type DialogCallFact, type DisabledLintRuleFact, type DocDriftLevel, type DocFinding, type DomQueryFact, type ElementFact, type EvalCallFact, type ExplicitAnyFact, type FetchCallFact, type FileScanResult, type FixSuggestion, type FlywheelOutput, type FlywheelState, type Framework$1 as Framework, type HealthFile, type HookCallFact, type HookDependencyArrayFact, type HookFact, type ImportFact, type InlineEventHandlerFact, type Issue, type JsxAttributeStringLiteralFact, type JsxTextLiteralFact, type KeyPropFact, type LogicalExpressionFact, type MagicNumberSpacingConfig, type MaintenanceAxes, type MaintenanceAxisHealth, type NonNullAssertionFact, type OptimisticUpdateFact, type ProjectReport, type PropMutationFact, type PropPassThroughFact, REPOSITORY_HEALTH_WEIGHTS, type ReportReadResult, type RepositoryHealth, type RepositoryHealthInputs, type ResearchMetrics, type ResolvedConfig, type Rule, type RuleContext, type RuleSeverity, type RuleSuggestion, type ScanCache, type ScanFacts, type ScanProjectOptions, type Severity, type SlopAuditRun, type StateBinding, type StateBindingFact, type StringLiteralFact, type StylePropFact, type TamaguiStylePropFact, type TopOffender, type UseEffectBodyFact, VERSION, baselineStatusMessage, colorForSlop, failedThresholdCount, filterByDisabledDirectives, filterIssues, formatBadge, formatReportFromFile, formatSparkline, loadConfig, readReportFile, runCli, runInitWizard, scanProject, serializeConfig, stagedGating, thresholdExceeded };
+export { AI_SECURITY_NUMERIC, type AiDebt, type AiMaintenanceCost, type AiMaintenanceCostResult, type AstroComponentFact, type AutoTunedRule, type BaselineCache, type BaselineMeta, type CachedFile, type Category, type ClassNameFact, type CommentFact, type ComponentFacts, type ComponentScore, type ComponentSizeFact, type ConsoleCallFact, type Constitution, DEFAULT_CONFIG, type DangerouslySetInnerHtmlFact, type DbDriftLevel, type DbFinding, type DialogCallFact, type DisabledLintRuleFact, type DocDriftLevel, type DocFinding, type DomQueryFact, type ElementFact, type EvalCallFact, type ExplicitAnyFact, type FetchCallFact, type FileScanResult, type FixSuggestion, type FlywheelOutput, type FlywheelState, type Framework$1 as Framework, type HealthFile, type HookCallFact, type HookDependencyArrayFact, type HookFact, type ImportFact, type InlineEventHandlerFact, type Issue, type JsxAttributeStringLiteralFact, type JsxTextLiteralFact, type KeyPropFact, type LogicalExpressionFact, type MagicNumberSpacingConfig, type MaintenanceAxes, type MaintenanceAxisHealth, type NonNullAssertionFact, type OptimisticUpdateFact, type ProjectReport, type PropMutationFact, type PropPassThroughFact, REPOSITORY_HEALTH_WEIGHTS, type ReportReadResult, type RepositoryHealth, type RepositoryHealthInputs, type ResearchMetrics, type ResolvedConfig, type Rule, type RuleContext, type RuleSeverity, type RuleSuggestion, type ScanCache, type ScanFacts, type ScanProjectOptions, type ScanSelfScanConfig, type Severity, type SlopAuditRun, type StateBinding, type StateBindingFact, type StringLiteralFact, type StylePropFact, type TamaguiStylePropFact, type TopOffender, type UseEffectBodyFact, VERSION, baselineStatusMessage, colorForSlop, failedThresholdCount, filterByDisabledDirectives, filterIssues, formatBadge, formatReportFromFile, formatSparkline, loadConfig, readReportFile, runCli, runInitWizard, scanProject, serializeConfig, stagedGating, thresholdExceeded };