@doccov/cli 0.2.1 → 0.3.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Ryan Waits
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/cli.js

@@ -18,7 +18,7 @@ var __toESM = (mod, isNodeMode, target) => {
 };
 var __require = /* @__PURE__ */ createRequire(import.meta.url);
 
-// src/config/openpkg-config.ts
+// src/config/doccov-config.ts
 import { access } from "node:fs/promises";
 import path from "node:path";
 import { pathToFileURL } from "node:url";
@@ -52,20 +52,14 @@ var normalizeConfig = (input) => {
   };
 };
 
-// src/config/openpkg-config.ts
+// src/config/doccov-config.ts
 var DOCCOV_CONFIG_FILENAMES = [
   "doccov.config.ts",
   "doccov.config.mts",
   "doccov.config.cts",
   "doccov.config.js",
   "doccov.config.mjs",
-  "doccov.config.cjs",
-  "openpkg.config.ts",
-  "openpkg.config.mts",
-  "openpkg.config.cts",
-  "openpkg.config.js",
-  "openpkg.config.mjs",
-  "openpkg.config.cjs"
+  "doccov.config.cjs"
 ];
 var fileExists = async (filePath) => {
   try {
@@ -126,8 +120,6 @@ ${formatIssues(issues)}`);
     ...normalized
   };
 };
-var loadOpenPkgConfigInternal = loadDocCovConfig;
-var loadOpenPkgConfig = loadDocCovConfig;
 
 // src/config/index.ts
 var defineConfig = (config) => config;
@@ -294,7 +286,7 @@ function registerCheckCommand(program, dependencies = {}) {
     ...defaultDependencies,
     ...dependencies
   };
-  program.command("check [entry]").description("Fail if documentation coverage falls below a threshold").option("--cwd <dir>", "Working directory", process.cwd()).option("--package <name>", "Target package name (for monorepos)").option("--min-coverage <percentage>", "Minimum docs coverage percentage (0-100)", (value) => Number(value)).option("--require-examples", "Require at least one @example for every export").option("--no-external-types", "Skip external type resolution from node_modules").action(async (entry, options) => {
+  program.command("check [entry]").description("Fail if documentation coverage falls below a threshold").option("--cwd <dir>", "Working directory", process.cwd()).option("--package <name>", "Target package name (for monorepos)").option("--min-coverage <percentage>", "Minimum docs coverage percentage (0-100)", (value) => Number(value)).option("--require-examples", "Require at least one @example for every export").option("--ignore-drift", "Do not fail on documentation drift").option("--no-external-types", "Skip external type resolution from node_modules").action(async (entry, options) => {
     try {
       let targetDir = options.cwd;
       let entryFile = entry;
@@ -339,7 +331,7 @@ function registerCheckCommand(program, dependencies = {}) {
       const driftExports = collectDrift(spec.exports ?? []);
       const coverageFailed = coverageScore < minCoverage;
       const hasMissingExamples = missingExamples.length > 0;
-      const hasDrift = driftExports.length > 0;
+      const hasDrift = !options.ignoreDrift && driftExports.length > 0;
       if (!coverageFailed && !hasMissingExamples && !hasDrift) {
         log(chalk.green(`✓ Docs coverage ${coverageScore}% (min ${minCoverage}%)`));
         if (failingExports.length > 0) {
@@ -348,6 +340,16 @@ function registerCheckCommand(program, dependencies = {}) {
             log(chalk.gray(`  • ${name}: missing ${missing?.join(", ")}`));
           }
         }
+        if (options.ignoreDrift && driftExports.length > 0) {
+          log("");
+          log(chalk.yellow(`⚠️ ${driftExports.length} drift issue(s) detected (ignored):`));
+          for (const drift of driftExports.slice(0, 10)) {
+            log(chalk.yellow(`  • ${drift.name}: ${drift.issue}`));
+            if (drift.suggestion) {
+              log(chalk.gray(`    Suggestion: ${drift.suggestion}`));
+            }
+          }
+        }
         return;
       }
       error("");
@@ -471,7 +473,7 @@ function loadSpec(filePath, readFileSync3) {
     throw new Error(`Failed to parse ${filePath}: ${parseError instanceof Error ? parseError.message : parseError}`);
   }
 }
-function printTextDiff(diff, log, error) {
+function printTextDiff(diff, log, _error) {
   log("");
   log(chalk2.bold("DocCov Diff Report"));
   log("─".repeat(40));

package/dist/config/index.d.ts

@@ -11,18 +11,10 @@ interface NormalizedDocCovConfig {
 	exclude?: string[];
 	plugins?: unknown[];
 }
-/** @deprecated Use NormalizedDocCovConfig instead */
-type NormalizedOpenPkgConfig = NormalizedDocCovConfig;
-declare const DOCCOV_CONFIG_FILENAMES: readonly ["doccov.config.ts", "doccov.config.mts", "doccov.config.cts", "doccov.config.js", "doccov.config.mjs", "doccov.config.cjs", "openpkg.config.ts", "openpkg.config.mts", "openpkg.config.cts", "openpkg.config.js", "openpkg.config.mjs", "openpkg.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"];
 interface LoadedDocCovConfig extends NormalizedDocCovConfig {
 	filePath: string;
 }
-/** @deprecated Use LoadedDocCovConfig instead */
-type LoadedOpenPkgConfig = LoadedDocCovConfig;
 declare const loadDocCovConfig: (cwd: string) => Promise<LoadedDocCovConfig | null>;
-/** @deprecated Use loadDocCovConfig instead */
-declare const loadOpenPkgConfigInternal: typeof loadDocCovConfig;
-/** @deprecated Use loadDocCovConfig instead */
-declare const loadOpenPkgConfig: typeof loadDocCovConfig;
 declare const defineConfig: (config: DocCovConfigInput) => DocCovConfigInput;
-export { loadOpenPkgConfigInternal, loadOpenPkgConfig, loadDocCovConfig, defineConfig, NormalizedOpenPkgConfig, NormalizedDocCovConfig, LoadedOpenPkgConfig, LoadedDocCovConfig, DocCovConfigInput, DOCCOV_CONFIG_FILENAMES };
+export { loadDocCovConfig, defineConfig, NormalizedDocCovConfig, LoadedDocCovConfig, DocCovConfigInput, DOCCOV_CONFIG_FILENAMES };

package/dist/config/index.js

@@ -17,7 +17,7 @@ var __toESM = (mod, isNodeMode, target) => {
 };
 var __require = /* @__PURE__ */ createRequire(import.meta.url);
 
-// src/config/openpkg-config.ts
+// src/config/doccov-config.ts
 import { access } from "node:fs/promises";
 import path from "node:path";
 import { pathToFileURL } from "node:url";
@@ -51,20 +51,14 @@ var normalizeConfig = (input) => {
   };
 };
 
-// src/config/openpkg-config.ts
+// src/config/doccov-config.ts
 var DOCCOV_CONFIG_FILENAMES = [
   "doccov.config.ts",
   "doccov.config.mts",
   "doccov.config.cts",
   "doccov.config.js",
   "doccov.config.mjs",
-  "doccov.config.cjs",
-  "openpkg.config.ts",
-  "openpkg.config.mts",
-  "openpkg.config.cts",
-  "openpkg.config.js",
-  "openpkg.config.mjs",
-  "openpkg.config.cjs"
+  "doccov.config.cjs"
 ];
 var fileExists = async (filePath) => {
   try {
@@ -125,14 +119,10 @@ ${formatIssues(issues)}`);
     ...normalized
   };
 };
-var loadOpenPkgConfigInternal = loadDocCovConfig;
-var loadOpenPkgConfig = loadDocCovConfig;
 
 // src/config/index.ts
 var defineConfig = (config) => config;
 export {
-  loadOpenPkgConfigInternal,
-  loadOpenPkgConfig,
   loadDocCovConfig,
   defineConfig,
   DOCCOV_CONFIG_FILENAMES

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@doccov/cli",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "description": "DocCov CLI - Documentation coverage and drift detection for TypeScript",
   "keywords": [
     "typescript",
@@ -49,8 +49,8 @@
     "@ai-sdk/anthropic": "^1.0.0",
     "@ai-sdk/openai": "^1.0.0",
     "@inquirer/prompts": "^7.8.0",
-    "@doccov/sdk": "^0.2.1",
-    "@openpkg-ts/spec": "^0.2.1",
+    "@doccov/sdk": "^0.2.2",
+    "@openpkg-ts/spec": "^0.2.2",
     "ai": "^4.0.0",
     "chalk": "^5.4.1",
     "commander": "^14.0.0",