@geoql/doctor-core 1.3.3 → 1.4.1

package/README.md

@@ -21,7 +21,7 @@ It also owns the pieces the CLIs surface: the config loader (`doctor.config.ts`
 npm i @geoql/doctor-core
 ```
 
-Published on [npm](https://www.npmjs.com/package/@geoql/doctor-core) and [JSR](https://jsr.io/@geoql/doctor-core) at `v0.1.0` with provenance. ESM-only. `knip` and `oxlint` are peer dependencies (the dead-code and script passes shell out to them).
+Published on [npm](https://www.npmjs.com/package/@geoql/doctor-core) and [JSR](https://jsr.io/@geoql/doctor-core) with provenance. ESM-only. `knip` and `oxlint` are peer dependencies (the dead-code and script passes shell out to them).
 
 ## API
 

package/dist/index.d.ts

@@ -70,6 +70,7 @@ type Capability = string;
 type MonorepoKind = 'pnpm' | 'yarn' | 'npm' | 'turbo' | null;
 interface ProjectInfo {
   readonly framework: Framework;
+  readonly frameworkDetected: boolean;
   readonly rootDirectory: string;
   readonly packageJsonPath: string | null;
   readonly vueVersion: string | null;
@@ -94,6 +95,7 @@ interface ProjectInfo {
 //#region src/reporters/types.d.ts
 interface ProjectInfoLite {
   readonly framework: Framework;
+  readonly frameworkDetected: boolean;
   readonly vueVersion: string | null;
   readonly nuxtVersion: string | null;
   readonly capabilities: readonly string[];
@@ -108,6 +110,8 @@ interface ReporterInput {
   readonly diagnostics: readonly Diagnostic[];
   readonly score: ScoreResult;
   readonly projectInfo: ProjectInfoLite;
+  readonly incomplete?: boolean;
+  readonly skippedCheckReasons?: readonly SkippedCheckReason[];
 }
 interface ReporterOptions {
   readonly color?: boolean;
@@ -143,6 +147,13 @@ interface AuditConfig {
   respectInlineDisables?: boolean;
   fix?: boolean;
   fixExcludes?: string[];
+  maxDurationMs?: number;
+}
+interface SkippedCheckReason {
+  kind: 'time-budget-exhausted';
+  deadlineMs: number;
+  elapsedMs: number;
+  skippedPasses: readonly string[];
 }
 interface AuditTimings {
   template: number;
@@ -165,6 +176,8 @@ interface AuditReport {
   elapsedMs: number;
   timings: AuditTimings;
   ruleCounts: Record<string, number>;
+  incomplete: boolean;
+  skippedCheckReasons?: readonly SkippedCheckReason[];
 }
 //#endregion
 //#region src/annotations.d.ts
@@ -392,6 +405,34 @@ declare function renderDetectSummary(project: ProjectInfo, sfcCount: number): st
 declare function detectSummary(dir: string): Promise<string>;
 declare function planInit(options: InitOptions): Promise<InitPlan>;
 //#endregion
+//#region src/ci/provider-detect.d.ts
+type CiProvider = 'github' | 'gitlab' | 'unknown';
+/**
+ * Detects the CI provider from an explicit env snapshot. Takes the env as an
+ * argument (instead of reading process.env) so provider detection stays a
+ * deterministic, fully-testable pure function.
+ */
+declare function detectCiProvider(env: Readonly<Record<string, string | undefined>>): CiProvider;
+//#endregion
+//#region src/ci/scaffold-workflow.d.ts
+interface CiScaffoldOptions {
+  bin: 'vue-doctor' | 'nuxt-doctor';
+  framework: 'vue' | 'nuxt';
+  dir: string;
+  provider?: 'github' | 'gitlab' | 'auto';
+  pr?: boolean;
+  noComments?: boolean;
+  force?: boolean;
+  env?: Readonly<Record<string, string | undefined>>;
+}
+interface CiScaffoldPlan {
+  writes: InitFileWrite[];
+  conflict: boolean;
+  conflictPath: string | null;
+  provider: 'github' | 'gitlab';
+}
+declare function scaffoldCiWorkflow(opts: CiScaffoldOptions): Promise<CiScaffoldPlan>;
+//#endregion
 //#region src/project-info/find-monorepo-root.d.ts
 interface MonorepoResult {
   root: string;
@@ -519,6 +560,7 @@ interface DoctorReport {
   };
   projectInfo: {
     framework: string;
+    frameworkDetected: boolean;
     vueVersion: string | null;
     nuxtVersion: string | null;
     capabilities: string[];
@@ -547,6 +589,8 @@ interface DoctorReport {
     elapsedMs: number;
     analyzedFileCount: number;
   };
+  incomplete?: boolean;
+  skippedCheckReasons?: SkippedCheckReason[];
 }
 declare function buildDoctorReport(input: ReporterInput): DoctorReport;
 declare function jsonReport(input: ReporterInput): string;
@@ -705,5 +749,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 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 };
+export { type ApplyInlineDisablesOptions, type AuditConfig, type AuditReport, type AuditTimings, BUILT_IN_RECOMMENDED, type Capability, type CiProvider, type CiScaffoldOptions, type CiScaffoldPlan, 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 SkippedCheckReason, type VerboseTraceOptions, type WorkspacePackage, agentReport, applyInlineDisables, audit, buildDoctorReport, buildJsonSchema, buildPushPayload, categoriesForDimension, checkBuildQuality, checkDeadCode, checkDeps, checkNuxtProject, dedupeDeadCodeAgainstLint, defineConfig, detectCiProvider, 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, scaffoldCiWorkflow, scoreDiagnostics, stripFindings, validateConfig };
 //# sourceMappingURL=index.d.ts.map