@doccov/cli 0.16.0 → 0.17.0

package/dist/cli.js

@@ -1,9 +1,10 @@
 #!/usr/bin/env node
 
 // src/config/doccov-config.ts
-import { access } from "node:fs/promises";
+import { access, readFile } from "node:fs/promises";
 import path from "node:path";
 import { pathToFileURL } from "node:url";
+import { parse as parseYaml } from "yaml";
 
 // src/config/schema.ts
 import { z } from "zod";
@@ -95,7 +96,9 @@ var DOCCOV_CONFIG_FILENAMES = [
   "doccov.config.cts",
   "doccov.config.js",
   "doccov.config.mjs",
-  "doccov.config.cjs"
+  "doccov.config.cjs",
+  "doccov.yml",
+  "doccov.yaml"
 ];
 var fileExists = async (filePath) => {
   try {
@@ -122,6 +125,11 @@ var findConfigFile = async (cwd) => {
   }
 };
 var importConfigModule = async (absolutePath) => {
+  const ext = path.extname(absolutePath);
+  if (ext === ".yml" || ext === ".yaml") {
+    const content = await readFile(absolutePath, "utf-8");
+    return parseYaml(content);
+  }
   const fileUrl = pathToFileURL(absolutePath);
   fileUrl.searchParams.set("t", Date.now().toString());
   const module = await import(fileUrl.href);
@@ -1878,11 +1886,11 @@ function registerInitCommand(program, dependencies = {}) {
     ...defaultDependencies3,
     ...dependencies
   };
-  program.command("init").description("Create a DocCov configuration file").option("--cwd <dir>", "Working directory", process.cwd()).option("--format <format>", "Config format: auto, mjs, js, cjs", "auto").action((options) => {
+  program.command("init").description("Create a DocCov configuration file").option("--cwd <dir>", "Working directory", process.cwd()).option("--format <format>", "Config format: auto, mjs, js, cjs, yaml", "auto").action((options) => {
     const cwd = path6.resolve(options.cwd);
     const formatOption = String(options.format ?? "auto").toLowerCase();
     if (!isValidFormat(formatOption)) {
-      error(chalk6.red(`Invalid format "${formatOption}". Use auto, mjs, js, or cjs.`));
+      error(chalk6.red(`Invalid format "${formatOption}". Use auto, mjs, js, cjs, or yaml.`));
       process.exitCode = 1;
       return;
     }
@@ -1897,7 +1905,7 @@ function registerInitCommand(program, dependencies = {}) {
     if (targetFormat === "js" && packageType !== "module") {
       log(chalk6.yellow('Package is not marked as "type": "module"; creating doccov.config.js may require enabling ESM.'));
     }
-    const fileName = `doccov.config.${targetFormat}`;
+    const fileName = targetFormat === "yaml" ? "doccov.yml" : `doccov.config.${targetFormat}`;
     const outputPath = path6.join(cwd, fileName);
     if (fileExists2(outputPath)) {
       error(chalk6.red(`Cannot create ${fileName}; file already exists.`));
@@ -1910,7 +1918,7 @@ function registerInitCommand(program, dependencies = {}) {
   });
 }
 var isValidFormat = (value) => {
-  return value === "auto" || value === "mjs" || value === "js" || value === "cjs";
+  return ["auto", "mjs", "js", "cjs", "yaml"].includes(value);
 };
 var findExistingConfig = (cwd, fileExists2) => {
   let current = path6.resolve(cwd);
@@ -1962,12 +1970,34 @@ var findNearestPackageJson = (cwd, fileExists2) => {
   return null;
 };
 var resolveFormat = (format, packageType) => {
+  if (format === "yaml")
+    return "yaml";
   if (format === "auto") {
     return packageType === "module" ? "js" : "mjs";
   }
   return format;
 };
 var buildTemplate = (format) => {
+  if (format === "yaml") {
+    return `# doccov.yml
+# include:
+#   - "MyClass"
+#   - "myFunction"
+# exclude:
+#   - "internal*"
+
+check:
+  # minCoverage: 80
+  # maxDrift: 20
+  # examples: typecheck
+
+quality:
+  rules:
+    # has-description: warn
+    # has-params: off
+    # has-returns: off
+`;
+  }
   const configBody = `{
   // Filter which exports to analyze
   // include: ['MyClass', 'myFunction'],
@@ -2022,7 +2052,7 @@ import { DocCov as DocCov3, NodeFileSystem as NodeFileSystem3, resolveTarget as
 import { normalize, validateSpec } from "@openpkg-ts/spec";
 import chalk8 from "chalk";
 // package.json
-var version = "0.15.1";
+var version = "0.16.0";
 
 // src/utils/filter-options.ts
 import { mergeFilters, parseListFlag } from "@doccov/sdk";

package/dist/config/index.d.ts

@@ -38,7 +38,7 @@ declare const docCovConfigSchema: z.ZodObject<{
 }>;
 type DocCovConfigInput = z.infer<typeof docCovConfigSchema>;
 type NormalizedDocCovConfig = DocCovConfig;
-declare const DOCCOV_CONFIG_FILENAMES: readonly ["doccov.config.ts", "doccov.config.mts", "doccov.config.cts", "doccov.config.js", "doccov.config.mjs", "doccov.config.cjs"];
+declare const DOCCOV_CONFIG_FILENAMES: readonly ["doccov.config.ts", "doccov.config.mts", "doccov.config.cts", "doccov.config.js", "doccov.config.mjs", "doccov.config.cjs", "doccov.yml", "doccov.yaml"];
 interface LoadedDocCovConfig extends NormalizedDocCovConfig {
 	filePath: string;
 }

package/dist/config/index.js

@@ -1,7 +1,8 @@
 // src/config/doccov-config.ts
-import { access } from "node:fs/promises";
+import { access, readFile } from "node:fs/promises";
 import path from "node:path";
 import { pathToFileURL } from "node:url";
+import { parse as parseYaml } from "yaml";
 
 // src/config/schema.ts
 import { z } from "zod";
@@ -93,7 +94,9 @@ var DOCCOV_CONFIG_FILENAMES = [
   "doccov.config.cts",
   "doccov.config.js",
   "doccov.config.mjs",
-  "doccov.config.cjs"
+  "doccov.config.cjs",
+  "doccov.yml",
+  "doccov.yaml"
 ];
 var fileExists = async (filePath) => {
   try {
@@ -120,6 +123,11 @@ var findConfigFile = async (cwd) => {
   }
 };
 var importConfigModule = async (absolutePath) => {
+  const ext = path.extname(absolutePath);
+  if (ext === ".yml" || ext === ".yaml") {
+    const content = await readFile(absolutePath, "utf-8");
+    return parseYaml(content);
+  }
   const fileUrl = pathToFileURL(absolutePath);
   fileUrl.searchParams.set("t", Date.now().toString());
   const module = await import(fileUrl.href);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@doccov/cli",
-  "version": "0.16.0",
+  "version": "0.17.0",
   "description": "DocCov CLI - Documentation coverage and drift detection for TypeScript",
   "keywords": [
     "typescript",
@@ -56,6 +56,7 @@
     "commander": "^14.0.0",
     "glob": "^11.0.0",
     "simple-git": "^3.27.0",
+    "yaml": "^2.8.2",
     "zod": "^3.25.0"
   },
   "devDependencies": {