@docker-doctor/cli 0.4.3 → 0.5.0

package/dist/index.d.cts

@@ -6,10 +6,11 @@ interface DockerfileInstruction {
   line: number;
   raw: string;
 }
+type DiagnosticSeverity = "error" | "warning" | "info";
 interface Diagnostic {
   file: string;
   rule: string;
-  severity: "error" | "warning" | "info";
+  severity: DiagnosticSeverity;
   message: string;
   help: string;
   line?: number;
@@ -21,14 +22,20 @@ interface ProjectInfo {
   dockerignores?: string[];
 }
 type RuleCategory = "Security" | "Performance" | "Best Practices" | "Compose" | "Image Size";
-type RuleSeverity = "error" | "warning" | "info" | "off";
+type RuleSeverity = DiagnosticSeverity | "off";
 interface RuleDefinition {
   key: string;
   category: RuleCategory;
-  defaultSeverity: RuleSeverity;
+  defaultSeverity: DiagnosticSeverity;
   message: string;
   help: string;
 }
+/**
+ * Maps a path of YAML keys/indices (e.g. `["services", "web"]`) to the
+ * 1-based line where that key is defined, or `undefined` when the path does
+ * not resolve to a concrete node in the source document.
+ */
+type ComposeLocator = (path: readonly (string | number)[]) => number | undefined;
 interface DockerDoctorConfig {
   rules?: Record<string, RuleSeverity>;
   categories?: Partial<Record<RuleCategory, RuleSeverity>>;
@@ -38,7 +45,9 @@ interface DockerDoctorConfig {
 }
 //#endregion
 //#region ../core/src/project-info/discover.d.ts
-declare const discoverProject: (rootDir: string) => Promise<ProjectInfo>;
+declare const discoverProject: (rootDir: string, options?: {
+  ignoreFiles?: readonly string[];
+}) => Promise<ProjectInfo>;
 //#endregion
 //#region ../core/src/parsers/dockerfile-parser.d.ts
 declare const parseDockerfile: (content: string) => DockerfileInstruction[];
@@ -50,7 +59,7 @@ declare const parseCompose: (content: string, filepath: string) => unknown;
 declare const runDockerfileRules: (instructions: DockerfileInstruction[], file: string, projectFiles: string[], rulesConfig?: Record<string, RuleSeverity>, categoriesConfig?: Record<string, RuleSeverity>) => Diagnostic[];
 //#endregion
 //#region ../core/src/runners/compose-runner.d.ts
-declare const runComposeRules: (composeContent: unknown, file: string, rulesConfig?: Record<string, RuleSeverity>, categoriesConfig?: Record<string, RuleSeverity>) => Diagnostic[];
+declare const runComposeRules: (composeContent: unknown, file: string, rulesConfig?: Record<string, RuleSeverity>, categoriesConfig?: Record<string, RuleSeverity>, locate?: ComposeLocator) => Diagnostic[];
 //#endregion
 //#region ../core/src/rules/index.d.ts
 declare const allRules: RuleDefinition[];

package/dist/index.d.mts

@@ -6,10 +6,11 @@ interface DockerfileInstruction {
   line: number;
   raw: string;
 }
+type DiagnosticSeverity = "error" | "warning" | "info";
 interface Diagnostic {
   file: string;
   rule: string;
-  severity: "error" | "warning" | "info";
+  severity: DiagnosticSeverity;
   message: string;
   help: string;
   line?: number;
@@ -21,14 +22,20 @@ interface ProjectInfo {
   dockerignores?: string[];
 }
 type RuleCategory = "Security" | "Performance" | "Best Practices" | "Compose" | "Image Size";
-type RuleSeverity = "error" | "warning" | "info" | "off";
+type RuleSeverity = DiagnosticSeverity | "off";
 interface RuleDefinition {
   key: string;
   category: RuleCategory;
-  defaultSeverity: RuleSeverity;
+  defaultSeverity: DiagnosticSeverity;
   message: string;
   help: string;
 }
+/**
+ * Maps a path of YAML keys/indices (e.g. `["services", "web"]`) to the
+ * 1-based line where that key is defined, or `undefined` when the path does
+ * not resolve to a concrete node in the source document.
+ */
+type ComposeLocator = (path: readonly (string | number)[]) => number | undefined;
 interface DockerDoctorConfig {
   rules?: Record<string, RuleSeverity>;
   categories?: Partial<Record<RuleCategory, RuleSeverity>>;
@@ -38,7 +45,9 @@ interface DockerDoctorConfig {
 }
 //#endregion
 //#region ../core/src/project-info/discover.d.ts
-declare const discoverProject: (rootDir: string) => Promise<ProjectInfo>;
+declare const discoverProject: (rootDir: string, options?: {
+  ignoreFiles?: readonly string[];
+}) => Promise<ProjectInfo>;
 //#endregion
 //#region ../core/src/parsers/dockerfile-parser.d.ts
 declare const parseDockerfile: (content: string) => DockerfileInstruction[];
@@ -50,7 +59,7 @@ declare const parseCompose: (content: string, filepath: string) => unknown;
 declare const runDockerfileRules: (instructions: DockerfileInstruction[], file: string, projectFiles: string[], rulesConfig?: Record<string, RuleSeverity>, categoriesConfig?: Record<string, RuleSeverity>) => Diagnostic[];
 //#endregion
 //#region ../core/src/runners/compose-runner.d.ts
-declare const runComposeRules: (composeContent: unknown, file: string, rulesConfig?: Record<string, RuleSeverity>, categoriesConfig?: Record<string, RuleSeverity>) => Diagnostic[];
+declare const runComposeRules: (composeContent: unknown, file: string, rulesConfig?: Record<string, RuleSeverity>, categoriesConfig?: Record<string, RuleSeverity>, locate?: ComposeLocator) => Diagnostic[];
 //#endregion
 //#region ../core/src/rules/index.d.ts
 declare const allRules: RuleDefinition[];

package/dist/index.mjs

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-import { a as runDockerfileRules, c as parseCompose, d as version$1, i as runComposeRules, l as parseDockerfile, n as calculateScore, o as allRules, r as loadConfig, s as findRule, t as toJsonReport, u as discoverProject } from "./src-TK9DRoRo.mjs";
+import { a as runDockerfileRules, d as discoverProject, f as version$1, i as runComposeRules, l as parseCompose, n as calculateScore, o as allRules, r as loadConfig, s as findRule, t as toJsonReport, u as parseDockerfile } from "./src-CpGd43y0.mjs";
 
 //#region ../core/src/config/define-config.ts
 const defineConfig = (config) => config;