@openpkg-ts/cli 0.3.1 → 0.4.1

package/dist/bin/openpkg.js

@@ -11,7 +11,7 @@ import { Command as Command10 } from "commander";
 // package.json
 var package_default = {
   name: "@openpkg-ts/cli",
-  version: "0.3.0",
+  version: "0.4.1",
   description: "CLI for OpenPkg TypeScript API extraction and documentation generation",
   homepage: "https://github.com/ryanwaits/openpkg-ts#readme",
   repository: {
@@ -34,8 +34,8 @@ var package_default = {
     test: "bun test"
   },
   dependencies: {
-    "@openpkg-ts/adapters": "^0.3.0",
-    "@openpkg-ts/sdk": "^0.31.0",
+    "@openpkg-ts/adapters": "^0.3.1",
+    "@openpkg-ts/sdk": "^0.32.0",
     commander: "^14.0.0"
   },
   devDependencies: {
@@ -309,7 +309,7 @@ function getExtension(format) {
       return ".md";
   }
 }
-function renderExport(docs, exportId, format) {
+function renderExport(docs, exportId, format, collapseUnionThreshold) {
   const exp = docs.getExport(exportId);
   if (!exp)
     throw new Error(`Export not found: ${exportId}`);
@@ -319,21 +319,26 @@ function renderExport(docs, exportId, format) {
     case "html":
       return docs.toHTML({ export: exportId });
     default:
-      return docs.toMarkdown({ export: exportId, frontmatter: true, codeSignatures: true });
+      return docs.toMarkdown({
+        export: exportId,
+        frontmatter: true,
+        codeSignatures: true,
+        collapseUnionThreshold
+      });
   }
 }
-function renderFull(docs, format) {
+function renderFull(docs, format, collapseUnionThreshold) {
   switch (format) {
     case "json":
       return JSON.stringify(docs.toJSON(), null, 2);
     case "html":
       return docs.toHTML();
     default:
-      return docs.toMarkdown({ frontmatter: true, codeSignatures: true });
+      return docs.toMarkdown({ frontmatter: true, codeSignatures: true, collapseUnionThreshold });
   }
 }
 function createDocsCommand() {
-  return new Command5("docs").description("Generate documentation from OpenPkg spec").argument("<spec>", "Path to openpkg.json spec file (use - for stdin)").option("-o, --output <path>", "Output file or directory (default: stdout)").option("-f, --format <format>", "Output format: md, json, html (default: md)", "md").option("--split", "Output one file per export (requires --output as directory)").option("-e, --export <name>", "Generate docs for a single export by name").option("-a, --adapter <name>", "Use adapter for generation (default: raw)").action(async (specPath, options) => {
+  return new Command5("docs").description("Generate documentation from OpenPkg spec").argument("<spec>", "Path to openpkg.json spec file (use - for stdin)").option("-o, --output <path>", "Output file or directory (default: stdout)").option("-f, --format <format>", "Output format: md, json, html (default: md)", "md").option("--split", "Output one file per export (requires --output as directory)").option("-e, --export <name>", "Generate docs for a single export by name").option("-a, --adapter <name>", "Use adapter for generation (default: raw)").option("--collapse-unions <n>", "Collapse unions with more than N members (default: no collapse)").action(async (specPath, options) => {
     const format = options.format || "md";
     try {
       if (options.adapter && options.adapter !== "raw") {
@@ -384,6 +389,7 @@ function createDocsCommand() {
         }
         docs = createDocs(specFile);
       }
+      const collapseUnionThreshold = options.collapseUnions ? parseInt(options.collapseUnions, 10) : undefined;
       if (options.export) {
         const exports = docs.getAllExports();
         const exp = exports.find((e) => e.name === options.export);
@@ -391,7 +397,7 @@ function createDocsCommand() {
           console.error(JSON.stringify({ error: `Export not found: ${options.export}` }));
           process.exit(1);
         }
-        const output2 = renderExport(docs, exp.id, format);
+        const output2 = renderExport(docs, exp.id, format, collapseUnionThreshold);
         if (options.output && options.output !== "-") {
           const outputPath = path5.resolve(options.output);
           fs5.writeFileSync(outputPath, output2);
@@ -414,13 +420,13 @@ function createDocsCommand() {
         for (const exp of exports) {
           const filename = `${exp.name}${getExtension(format)}`;
           const filePath = path5.join(outDir, filename);
-          const content = renderExport(docs, exp.id, format);
+          const content = renderExport(docs, exp.id, format, collapseUnionThreshold);
           fs5.writeFileSync(filePath, content);
         }
         console.error(`Wrote ${exports.length} files to ${outDir}`);
         return;
       }
-      const output = renderFull(docs, format);
+      const output = renderFull(docs, format, collapseUnionThreshold);
       if (options.output && options.output !== "-") {
         const outputPath = path5.resolve(options.output);
         fs5.writeFileSync(outputPath, output);
@@ -471,7 +477,7 @@ function validateKinds(kinds) {
   return kinds;
 }
 function createFilterCommand() {
-  return new Command6("filter").description("Filter an OpenPkg spec by various criteria").argument("<spec>", "Path to spec file (JSON)").option("--kind <kinds>", "Filter by kinds (comma-separated)").option("--name <names>", "Filter by exact names (comma-separated)").option("--id <ids>", "Filter by IDs (comma-separated)").option("--tag <tags>", "Filter by tags (comma-separated)").option("--deprecated", "Only deprecated exports").option("--no-deprecated", "Exclude deprecated exports").option("--has-description", "Only exports with descriptions").option("--missing-description", "Only exports without descriptions").option("--search <term>", "Search name/description (case-insensitive)").option("--module <path>", "Filter by source file path (contains)").option("-o, --output <file>", "Output file (default: stdout)").option("--summary", "Only output matched/total counts").option("--quiet", "Output raw spec only (no wrapper)").action(async (specPath, options) => {
+  return new Command6("filter").description("Filter an OpenPkg spec by various criteria").argument("<spec>", "Path to spec file (JSON)").option("--kind <kinds>", "Filter by kinds (comma-separated)").option("--name <names>", "Filter by exact names (comma-separated)").option("--id <ids>", "Filter by IDs (comma-separated)").option("--tag <tags>", "Filter by tags (comma-separated)").option("--deprecated", "Only deprecated exports").option("--no-deprecated", "Exclude deprecated exports").option("--has-description", "Only exports with descriptions").option("--missing-description", "Only exports without descriptions").option("--search <term>", "Search name/description (case-insensitive)").option("--search-members", "Also search member names/descriptions").option("--search-docs", "Also search param/return descriptions and examples").option("--module <path>", "Filter by source file path (contains)").option("-o, --output <file>", "Output file (default: stdout)").option("--summary", "Only output matched/total counts").option("--quiet", "Output raw spec only (no wrapper)").action(async (specPath, options) => {
     try {
       const spec = loadSpec5(specPath);
       const criteria = {};
@@ -494,6 +500,10 @@ function createFilterCommand() {
         criteria.hasDescription = false;
       if (options.search)
         criteria.search = options.search;
+      if (options.searchMembers)
+        criteria.searchMembers = true;
+      if (options.searchDocs)
+        criteria.searchDocs = true;
       if (options.module)
         criteria.module = options.module;
       const result = filterSpec(spec, criteria);
@@ -569,7 +579,7 @@ function formatDiagnostics(diagnostics) {
   }));
 }
 function createSnapshotCommand() {
-  return new Command8("snapshot").description("Generate full OpenPkg spec from TypeScript entry point").argument("<entry>", "Entry point file path").option("-o, --output <file>", "Output file (default: openpkg.json, use - for stdout)", "openpkg.json").option("--max-depth <n>", "Max type depth (default: 4)", "4").option("--skip-resolve", "Skip external type resolution").option("--runtime", "Enable Standard Schema runtime extraction").option("--only <exports>", "Filter exports (comma-separated, wildcards supported)").option("--ignore <exports>", "Ignore exports (comma-separated, wildcards supported)").option("--verify", "Exit 1 if any exports fail").action(async (entry, options) => {
+  return new Command8("snapshot").description("Generate full OpenPkg spec from TypeScript entry point").argument("<entry>", "Entry point file path").option("-o, --output <file>", "Output file (default: openpkg.json, use - for stdout)", "openpkg.json").option("--max-depth <n>", "Max type depth (default: 4)", "4").option("--skip-resolve", "Skip external type resolution").option("--runtime", "Enable Standard Schema runtime extraction").option("--only <exports>", "Filter exports (comma-separated, wildcards supported)").option("--ignore <exports>", "Ignore exports (comma-separated, wildcards supported)").option("--verify", "Exit 1 if any exports fail").option("--verbose", "Show detailed output including skipped exports").option("--include-private", "Include private/protected class members").action(async (entry, options) => {
     const entryFile = path8.resolve(entry);
     const extractOptions = {
       entryFile,
@@ -577,7 +587,8 @@ function createSnapshotCommand() {
       resolveExternalTypes: !options.skipResolve,
       schemaExtraction: options.runtime ? "hybrid" : "static",
       only: parseFilter(options.only),
-      ignore: parseFilter(options.ignore)
+      ignore: parseFilter(options.ignore),
+      includePrivate: options.includePrivate
     };
     try {
       const result = await extractSpec(extractOptions);
@@ -590,7 +601,10 @@ function createSnapshotCommand() {
             discovered: result.verification.discovered,
             extracted: result.verification.extracted,
             skipped: result.verification.skipped,
-            failed: result.verification.failed
+            failed: result.verification.failed,
+            ...options.verbose && result.verification.details.skipped.length > 0 && {
+              skippedDetails: result.verification.details.skipped
+            }
           }
         },
         ...result.runtimeSchemas && {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openpkg-ts/cli",
-  "version": "0.3.1",
+  "version": "0.4.1",
   "description": "CLI for OpenPkg TypeScript API extraction and documentation generation",
   "homepage": "https://github.com/ryanwaits/openpkg-ts#readme",
   "repository": {
@@ -23,8 +23,8 @@
     "test": "bun test"
   },
   "dependencies": {
-    "@openpkg-ts/adapters": "^0.3.0",
-    "@openpkg-ts/sdk": "^0.31.0",
+    "@openpkg-ts/adapters": "^0.3.1",
+    "@openpkg-ts/sdk": "^0.32.0",
     "commander": "^14.0.0"
   },
   "devDependencies": {