@geoql/doctor-core 1.2.1 → 1.3.0

package/dist/index.d.ts

@@ -1,5 +1,31 @@
 import { z } from "zod";
 
+//#region src/rule-registry.d.ts
+type RuleCategory = 'ai-slop' | 'reactivity' | 'composition' | 'performance' | 'template' | 'template-perf' | 'build-quality' | 'deps' | 'dead-code' | 'sfc' | 'vue-builtin' | 'structure' | 'modules-deps' | 'nitro' | 'seo' | 'cloudflare' | 'server-routes' | 'hydration' | 'data-fetching' | 'security' | 'design';
+type RuleSource = 'doctor' | 'oxlint-builtin' | 'eslint-plugin-vue';
+interface RegisteredRule {
+  readonly id: string;
+  readonly severity: Severity;
+  readonly category: RuleCategory;
+  readonly source: RuleSource;
+  readonly recommended: boolean;
+}
+declare const RULE_REGISTRY: readonly RegisteredRule[];
+interface ListRulesFilter {
+  readonly preset?: 'recommended' | 'all';
+  readonly category?: RuleCategory;
+  readonly source?: RuleSource;
+  readonly severity?: Severity;
+}
+declare function listRules(filter?: ListRulesFilter): RegisteredRule[];
+//#endregion
+//#region src/score-dimensions.d.ts
+type ScoreDimension = 'performance' | 'correctness' | 'security' | 'maintainability' | 'nuxt' | 'design';
+declare const SCORE_DIMENSIONS: readonly ScoreDimension[];
+declare function dimensionForCategory(category: RuleCategory): ScoreDimension;
+declare function isScoreDimension(value: string): value is ScoreDimension;
+declare function categoriesForDimension(dimension: ScoreDimension): RuleCategory[];
+//#endregion
 //#region src/score.d.ts
 interface ScoreBreakdownEntry {
   ruleId: string;
@@ -7,6 +33,13 @@ interface ScoreBreakdownEntry {
   weightPerOccurrence: number;
   penalty: number;
 }
+interface DimensionScore {
+  score: number;
+  totalFindings: number;
+  errorCount: number;
+  warnCount: number;
+  infoCount: number;
+}
 interface ScoreResult {
   score: number;
   passed: boolean;
@@ -16,6 +49,12 @@ interface ScoreResult {
   warnCount: number;
   infoCount: number;
   breakdown: ScoreBreakdownEntry[];
+  /**
+   * Per-dimension sub-scores. Each is computed with the SAME √-decay formula
+   * isolated to that dimension's diagnostics — diagnostic aids that do NOT sum
+   * to the overall score. The single `score` above stays the authoritative value.
+   */
+  byDimension: Readonly<Record<ScoreDimension, DimensionScore>>;
 }
 interface ScoreConfig {
   rules?: Record<string, {
@@ -495,6 +534,13 @@ interface DoctorReport {
       info: number;
     };
     breakdown: DoctorReportBreakdownEntry[];
+    byDimension: Record<string, {
+      score: number;
+      totalFindings: number;
+      error: number;
+      warn: number;
+      info: number;
+    }>;
   };
   diagnostics: DoctorReportDiagnostic[];
   timing: {
@@ -546,25 +592,6 @@ declare function renderRulePrompt(ruleId: string): string | null;
  */
 declare function renderAgentPlaybook(): string;
 //#endregion
-//#region src/rule-registry.d.ts
-type RuleCategory = 'ai-slop' | 'reactivity' | 'composition' | 'performance' | 'template' | 'template-perf' | 'build-quality' | 'deps' | 'dead-code' | 'sfc' | 'vue-builtin' | 'structure' | 'modules-deps' | 'nitro' | 'seo' | 'cloudflare' | 'server-routes' | 'hydration' | 'data-fetching' | 'security' | 'design';
-type RuleSource = 'doctor' | 'oxlint-builtin' | 'eslint-plugin-vue';
-interface RegisteredRule {
-  readonly id: string;
-  readonly severity: Severity;
-  readonly category: RuleCategory;
-  readonly source: RuleSource;
-  readonly recommended: boolean;
-}
-declare const RULE_REGISTRY: readonly RegisteredRule[];
-interface ListRulesFilter {
-  readonly preset?: 'recommended' | 'all';
-  readonly category?: RuleCategory;
-  readonly source?: RuleSource;
-  readonly severity?: Severity;
-}
-declare function listRules(filter?: ListRulesFilter): RegisteredRule[];
-//#endregion
 //#region src/audit-filter.d.ts
 /**
  * Filter `report.diagnostics` to a known set of allowed rule ids, then
@@ -588,6 +615,24 @@ declare function listRules(filter?: ListRulesFilter): RegisteredRule[];
  */
 declare function filterReportByRules(report: AuditReport, allowedRuleIds: ReadonlySet<string>, failOn?: 'error' | 'warn' | 'none', oxlintStderr?: string): AuditReport;
 //#endregion
+//#region src/config/category-filter.d.ts
+interface CategoryScopeInput {
+  categories?: readonly string[];
+  dimensions?: readonly string[];
+}
+/**
+ * Resolve `--category` + `--dimension` inputs to the concrete set of
+ * RuleCategory values they cover. Returns undefined when no scope was
+ * requested (run everything). Throws on an unknown category/dimension so the
+ * CLI can exit 2 rather than silently ignore a typo.
+ */
+declare function resolveCategoryScope(input: CategoryScopeInput): ReadonlySet<RuleCategory> | undefined;
+/**
+ * Narrow `ruleIds` to those whose registered category is in `scope`. RuleIds
+ * not in the registry are dropped (a category scope is an explicit allowlist).
+ */
+declare function filterRuleIdsByCategory(ruleIds: Iterable<string>, scope: ReadonlySet<RuleCategory>): Set<string>;
+//#endregion
 //#region src/push.d.ts
 /**
  * The 6 fields the SaaS receives for each finding.
@@ -660,5 +705,5 @@ declare function buildPushPayload(input: PushPayloadInput): PushPayload;
  */
 declare function pushFindings(opts: PushOptions): Promise<PushResult>;
 //#endregion
-export { type ApplyInlineDisablesOptions, type AuditConfig, type AuditReport, type AuditTimings, BUILT_IN_RECOMMENDED, type Capability, type CliOverrides, ConfigCycleError, ConfigFileNotFoundError, type ConfigSource, DOCTOR_REPORT_SCHEMA_VERSION, DeadCodeImportFailed, DeadCodeTimeoutError, type Diagnostic, type DiagnosticSource, type DirectiveLine, type DirectiveRange, type DirectiveSet, type DoctorReport, type DoctorUserConfig, type DoctorUserConfigInput, DoctorUserConfigSchema, type Framework, type GitScopeMode, type InitConfigFormat, type InitFileWrite, type InitOptions, type InitPlan, type InitPreset, InvalidConfigError, LevelSchema, type ListRulesFilter, type LoadRuleDocOptions, type MonorepoKind, type MonorepoResult, OxlintOutputTooLarge, OxlintSpawnFailed, type ProjectInfo, type ProjectInfoLite, type PushOptions, type PushPayload, type PushPayloadInput, type PushResult, type PushedFinding, RULE_REGISTRY, type RawInitAnswers, type RegisteredRule, type ReporterFormat, type ReporterInput, type ReporterOptions, type ResolvedDoctorConfig, type ResolvedInitAnswers, type RuleCategory, type RuleDoc, RuleEntrySchema, type RuleSource, type ScoreBreakdownEntry, type ScoreConfig, type ScoreResult, type Severity, type VerboseTraceOptions, type WorkspacePackage, agentReport, applyInlineDisables, audit, buildDoctorReport, buildJsonSchema, buildPushPayload, checkBuildQuality, checkDeadCode, checkDeps, checkNuxtProject, dedupeDeadCodeAgainstLint, defineConfig, detectProject, detectSummary, docsUrl, encodeAnnotation, encodeAnnotations, filterReportByRules, findMonorepoRoot, format, isNuxtLayoutFile, isNuxtPageFile, isNuxtServerFile, jsonCompactReport, jsonReport, listChangedFiles, listRules, listWorkspacePackages, loadAllRuleDocs, loadDoctorConfig, loadRuleDoc, mergeCliOverrides, normalizeInitAnswers, parseDirectives, parseExcludeList, planInit, prCommentReport, prettyReport, pushFindings, renderAgentPlaybook, renderDetectSummary, renderRulePrompt, renderVerboseTrace, runCrossFilePass, sarifReport, scoreDiagnostics, stripFindings, validateConfig };
+export { type ApplyInlineDisablesOptions, type AuditConfig, type AuditReport, type AuditTimings, BUILT_IN_RECOMMENDED, type Capability, type CliOverrides, ConfigCycleError, ConfigFileNotFoundError, type ConfigSource, DOCTOR_REPORT_SCHEMA_VERSION, DeadCodeImportFailed, DeadCodeTimeoutError, type Diagnostic, type DiagnosticSource, type DimensionScore, type DirectiveLine, type DirectiveRange, type DirectiveSet, type DoctorReport, type DoctorUserConfig, type DoctorUserConfigInput, DoctorUserConfigSchema, type Framework, type GitScopeMode, type InitConfigFormat, type InitFileWrite, type InitOptions, type InitPlan, type InitPreset, InvalidConfigError, LevelSchema, type ListRulesFilter, type LoadRuleDocOptions, type MonorepoKind, type MonorepoResult, OxlintOutputTooLarge, OxlintSpawnFailed, type ProjectInfo, type ProjectInfoLite, type PushOptions, type PushPayload, type PushPayloadInput, type PushResult, type PushedFinding, RULE_REGISTRY, type RawInitAnswers, type RegisteredRule, type ReporterFormat, type ReporterInput, type ReporterOptions, type ResolvedDoctorConfig, type ResolvedInitAnswers, type RuleCategory, type RuleDoc, RuleEntrySchema, type RuleSource, SCORE_DIMENSIONS, type ScoreBreakdownEntry, type ScoreConfig, type ScoreDimension, type ScoreResult, type Severity, type VerboseTraceOptions, type WorkspacePackage, agentReport, applyInlineDisables, audit, buildDoctorReport, buildJsonSchema, buildPushPayload, categoriesForDimension, checkBuildQuality, checkDeadCode, checkDeps, checkNuxtProject, dedupeDeadCodeAgainstLint, defineConfig, detectProject, detectSummary, dimensionForCategory, docsUrl, encodeAnnotation, encodeAnnotations, filterReportByRules, filterRuleIdsByCategory, findMonorepoRoot, format, isNuxtLayoutFile, isNuxtPageFile, isNuxtServerFile, isScoreDimension, jsonCompactReport, jsonReport, listChangedFiles, listRules, listWorkspacePackages, loadAllRuleDocs, loadDoctorConfig, loadRuleDoc, mergeCliOverrides, normalizeInitAnswers, parseDirectives, parseExcludeList, planInit, prCommentReport, prettyReport, pushFindings, renderAgentPlaybook, renderDetectSummary, renderRulePrompt, renderVerboseTrace, resolveCategoryScope, runCrossFilePass, sarifReport, scoreDiagnostics, stripFindings, validateConfig };
 //# sourceMappingURL=index.d.ts.map