@openpkg-ts/cli 0.2.0 → 0.2.1

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @openpkg-ts/cli
 
+## 0.2.1
+
+### Patch Changes
+
+- fix workspace:\* deps to use published versions for npm compatibility
+- Updated dependencies
+  - @openpkg-ts/sdk@0.30.1
+
 ## 0.2.0
 
 ### Minor Changes

package/README.md

@@ -120,7 +120,7 @@ openpkg diff baseline.json new.json --summary
 ## Programmatic Use
 
 ```typescript
-import { getExport, listExports } from '@openpkg-ts/cli';
+import { getExport, listExports } from '@openpkg-ts/sdk';
 
 // Same primitives as CLI
 const { exports } = await listExports({ entryFile: './src/index.ts' });

package/bin/openpkg.ts

@@ -1,10 +1,10 @@
 #!/usr/bin/env bun
-import { Command } from 'commander';
+import * as path from 'node:path';
 import { getExport, listExports } from '@openpkg-ts/sdk';
-import { createSnapshotCommand } from '../src/commands/snapshot';
+import { Command } from 'commander';
 import { createDiffCommand } from '../src/commands/diff';
 import { createDocsCommand } from '../src/commands/docs';
-import * as path from 'node:path';
+import { createSnapshotCommand } from '../src/commands/snapshot';
 
 const program = new Command();
 
@@ -39,9 +39,8 @@ program
     const result = await getExport({ entryFile, exportName: name });
 
     if (!result.export) {
-      const errorMsg = result.errors.length > 0
-        ? result.errors.join('; ')
-        : `Export '${name}' not found`;
+      const errorMsg =
+        result.errors.length > 0 ? result.errors.join('; ') : `Export '${name}' not found`;
       console.error(JSON.stringify({ error: errorMsg }, null, 2));
       process.exit(1);
     }

package/package.json

@@ -1,7 +1,13 @@
 {
   "name": "@openpkg-ts/cli",
-  "version": "0.2.0",
-  "description": "CLI for OpenPkg TypeScript API extraction",
+  "version": "0.2.1",
+  "description": "CLI for OpenPkg TypeScript API extraction and documentation generation",
+  "homepage": "https://github.com/ryanwaits/openpkg-ts#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ryanwaits/openpkg-ts.git",
+    "directory": "packages/cli"
+  },
   "type": "module",
   "bin": {
     "openpkg": "./bin/openpkg.ts"
@@ -12,7 +18,7 @@
     "test": "bun test"
   },
   "dependencies": {
-    "@openpkg-ts/sdk": "workspace:*",
+    "@openpkg-ts/sdk": "^0.30.1",
     "commander": "^14.0.0"
   },
   "devDependencies": {

package/src/commands/diff.ts

@@ -1,15 +1,15 @@
-import { Command } from 'commander';
+import * as fs from 'node:fs';
+import * as path from 'node:path';
 import {
-  diffSpec,
+  type CategorizedBreaking,
   categorizeBreakingChanges,
-  recommendSemverBump,
+  diffSpec,
   type OpenPkg,
-  type CategorizedBreaking,
+  recommendSemverBump,
   type SemverBump,
   type SpecExportKind,
 } from '@openpkg-ts/spec';
-import * as fs from 'node:fs';
-import * as path from 'node:path';
+import { Command } from 'commander';
 
 /**
  * A changed export with details about what changed
@@ -75,7 +75,7 @@ export function enrichDiff(oldSpec: OpenPkg, newSpec: OpenPkg): DiffResult {
   const semver = recommendSemverBump(rawDiff);
 
   const oldExports = toExportMap(oldSpec);
-  const newExports = toExportMap(newSpec);
+  const _newExports = toExportMap(newSpec);
 
   // Separate removed from changed
   const removed: RemovedExport[] = [];
@@ -152,22 +152,24 @@ export function createDiffCommand(): Command {
     .argument('<new>', 'Path to new spec file (JSON)')
     .option('--json', 'Output as JSON (default)')
     .option('--summary', 'Only show summary')
-    .action(async (oldPath: string, newPath: string, options: { json?: boolean; summary?: boolean }) => {
-      try {
-        const oldSpec = loadSpec(oldPath);
-        const newSpec = loadSpec(newPath);
+    .action(
+      async (oldPath: string, newPath: string, options: { json?: boolean; summary?: boolean }) => {
+        try {
+          const oldSpec = loadSpec(oldPath);
+          const newSpec = loadSpec(newPath);
 
-        const result = enrichDiff(oldSpec, newSpec);
+          const result = enrichDiff(oldSpec, newSpec);
 
-        if (options.summary) {
-          console.log(JSON.stringify(result.summary, null, 2));
-        } else {
-          console.log(JSON.stringify(result, null, 2));
+          if (options.summary) {
+            console.log(JSON.stringify(result.summary, null, 2));
+          } else {
+            console.log(JSON.stringify(result, null, 2));
+          }
+        } catch (err) {
+          const error = err instanceof Error ? err : new Error(String(err));
+          console.error(JSON.stringify({ error: error.message }, null, 2));
+          process.exit(1);
         }
-      } catch (err) {
-        const error = err instanceof Error ? err : new Error(String(err));
-        console.error(JSON.stringify({ error: error.message }, null, 2));
-        process.exit(1);
-      }
-    });
+      },
+    );
 }

package/src/commands/docs.ts

@@ -1,8 +1,8 @@
-import { Command } from 'commander';
-import { createDocs, loadSpec, type DocsInstance } from '@openpkg-ts/sdk';
-import type { OpenPkg } from '@openpkg-ts/spec';
-import * as path from 'node:path';
 import * as fs from 'node:fs';
+import * as path from 'node:path';
+import { createDocs, type DocsInstance, loadSpec } from '@openpkg-ts/sdk';
+import type { OpenPkg } from '@openpkg-ts/spec';
+import { Command } from 'commander';
 
 type OutputFormat = 'md' | 'json' | 'html';
 
@@ -22,9 +22,12 @@ async function readStdin(): Promise<string> {
 
 function getExtension(format: OutputFormat): string {
   switch (format) {
-    case 'json': return '.json';
-    case 'html': return '.html';
-    default: return '.md';
+    case 'json':
+      return '.json';
+    case 'html':
+      return '.html';
+    default:
+      return '.md';
   }
 }
 

package/src/commands/snapshot.ts

@@ -1,7 +1,7 @@
-import { Command } from 'commander';
-import { extractSpec, type ExtractOptions, type Diagnostic } from '@openpkg-ts/sdk';
-import * as path from 'node:path';
 import * as fs from 'node:fs';
+import * as path from 'node:path';
+import { type Diagnostic, type ExtractOptions, extractSpec } from '@openpkg-ts/sdk';
+import { Command } from 'commander';
 
 interface SnapshotCommandOptions {
   output?: string;
@@ -15,11 +15,14 @@ interface SnapshotCommandOptions {
 
 function parseFilter(value: string | undefined): string[] | undefined {
   if (!value) return undefined;
-  return value.split(',').map(s => s.trim()).filter(Boolean);
+  return value
+    .split(',')
+    .map((s) => s.trim())
+    .filter(Boolean);
 }
 
 function formatDiagnostics(diagnostics: Diagnostic[]): object[] {
-  return diagnostics.map(d => ({
+  return diagnostics.map((d) => ({
     message: d.message,
     severity: d.severity,
     ...(d.code && { code: d.code }),
@@ -32,7 +35,11 @@ export function createSnapshotCommand(): Command {
   return new Command('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(
+      '-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')
@@ -65,14 +72,14 @@ export function createSnapshotCommand(): Command {
               extracted: result.verification.extracted,
               skipped: result.verification.skipped,
               failed: result.verification.failed,
-            }
+            },
           }),
           ...(result.runtimeSchemas && {
             runtime: {
               extracted: result.runtimeSchemas.extracted,
               merged: result.runtimeSchemas.merged,
               vendors: result.runtimeSchemas.vendors,
-            }
+            },
           }),
         };
 
@@ -102,7 +109,6 @@ export function createSnapshotCommand(): Command {
           fs.writeFileSync(outputPath, specJson);
           console.error(`Wrote ${outputPath}`);
         }
-
       } catch (err) {
         const error = err instanceof Error ? err : new Error(String(err));
         const errorOutput = {

package/test/diff.test.ts

@@ -1,6 +1,6 @@
 import { describe, expect, test } from 'bun:test';
-import { enrichDiff, type DiffResult } from '../src/commands/diff';
 import type { OpenPkg, SpecExport } from '@openpkg-ts/spec';
+import { enrichDiff } from '../src/commands/diff';
 
 // Helper to create minimal spec
 function makeSpec(exports: SpecExport[], types: OpenPkg['types'] = []): OpenPkg {

package/test/docs.test.ts

@@ -1,19 +1,19 @@
-import { describe, expect, test, beforeAll, afterAll } from 'bun:test';
+import { afterAll, beforeAll, describe, expect, test } from 'bun:test';
+import * as fs from 'node:fs';
+import * as os from 'node:os';
+import * as path from 'node:path';
 import {
   createDocs,
+  exportToMarkdown,
   loadSpec,
-  toMarkdown,
+  type SimplifiedExport,
+  type SimplifiedSpec,
   toHTML,
   toJSON,
   toJSONString,
-  exportToMarkdown,
-  type SimplifiedSpec,
-  type SimplifiedExport,
+  toMarkdown,
 } from '@openpkg-ts/sdk';
 import type { OpenPkg } from '@openpkg-ts/spec';
-import * as fs from 'node:fs';
-import * as path from 'node:path';
-import * as os from 'node:os';
 
 // Test fixture spec
 const testSpec: OpenPkg = {

package/test/get.test.ts

@@ -13,7 +13,11 @@ describe('getExport', () => {
         interface Client { fetch(): void; }
       `;
 
-      const result = await getExport({ entryFile: 'test.ts', exportName: 'createClient', content: code });
+      const result = await getExport({
+        entryFile: 'test.ts',
+        exportName: 'createClient',
+        content: code,
+      });
 
       expect(result.errors).toHaveLength(0);
       expect(result.export).not.toBeNull();
@@ -127,7 +131,11 @@ describe('getExport', () => {
         export type Partial<T> = { [K in keyof T]?: T[K] };
       `;
 
-      const result = await getExport({ entryFile: 'test.ts', exportName: 'Partial', content: code });
+      const result = await getExport({
+        entryFile: 'test.ts',
+        exportName: 'Partial',
+        content: code,
+      });
 
       expect(result.errors).toHaveLength(0);
       expect(result.export!.kind).toBe('type');
@@ -153,7 +161,11 @@ describe('getExport', () => {
         }
       `;
 
-      const result = await getExport({ entryFile: 'test.ts', exportName: 'ApiClient', content: code });
+      const result = await getExport({
+        entryFile: 'test.ts',
+        exportName: 'ApiClient',
+        content: code,
+      });
 
       expect(result.errors).toHaveLength(0);
       expect(result.export).not.toBeNull();
@@ -200,7 +212,11 @@ describe('getExport', () => {
         }
       `;
 
-      const result = await getExport({ entryFile: 'test.ts', exportName: 'LogLevel', content: code });
+      const result = await getExport({
+        entryFile: 'test.ts',
+        exportName: 'LogLevel',
+        content: code,
+      });
 
       expect(result.errors).toHaveLength(0);
       expect(result.export).not.toBeNull();
@@ -234,7 +250,11 @@ describe('getExport', () => {
         export const DEFAULT_CONFIG = { timeout: 5000, retries: 3 };
       `;
 
-      const result = await getExport({ entryFile: 'test.ts', exportName: 'DEFAULT_CONFIG', content: code });
+      const result = await getExport({
+        entryFile: 'test.ts',
+        exportName: 'DEFAULT_CONFIG',
+        content: code,
+      });
 
       expect(result.errors).toHaveLength(0);
       expect(result.export).not.toBeNull();
@@ -247,7 +267,11 @@ describe('getExport', () => {
         export const VERSION: string = '1.0.0';
       `;
 
-      const result = await getExport({ entryFile: 'test.ts', exportName: 'VERSION', content: code });
+      const result = await getExport({
+        entryFile: 'test.ts',
+        exportName: 'VERSION',
+        content: code,
+      });
 
       expect(result.errors).toHaveLength(0);
       expect(result.export!.kind).toBe('variable');
@@ -283,7 +307,11 @@ describe('getExport', () => {
         export function myFunc(): void {}
       `;
 
-      const result = await getExport({ entryFile: 'test.ts', exportName: 'NonExistent', content: code });
+      const result = await getExport({
+        entryFile: 'test.ts',
+        exportName: 'NonExistent',
+        content: code,
+      });
 
       expect(result.export).toBeNull();
       expect(result.errors.length).toBeGreaterThan(0);
@@ -293,7 +321,11 @@ describe('getExport', () => {
     test('returns error for empty file', async () => {
       const code = `// empty file`;
 
-      const result = await getExport({ entryFile: 'test.ts', exportName: 'anything', content: code });
+      const result = await getExport({
+        entryFile: 'test.ts',
+        exportName: 'anything',
+        content: code,
+      });
 
       expect(result.export).toBeNull();
       expect(result.errors.length).toBeGreaterThan(0);
@@ -311,7 +343,11 @@ describe('getExport', () => {
         }
       `;
 
-      const result = await getExport({ entryFile: 'test.ts', exportName: 'Response', content: code });
+      const result = await getExport({
+        entryFile: 'test.ts',
+        exportName: 'Response',
+        content: code,
+      });
 
       expect(result.errors).toHaveLength(0);
       expect(result.export).not.toBeNull();

package/test/spec.test.ts

@@ -1,8 +1,8 @@
-import { describe, expect, test, beforeAll, afterAll } from 'bun:test';
-import { extractSpec, type ExtractOptions, type ExtractResult } from '@openpkg-ts/sdk';
+import { afterAll, beforeAll, describe, expect, test } from 'bun:test';
 import * as fs from 'node:fs';
-import * as path from 'node:path';
 import * as os from 'node:os';
+import * as path from 'node:path';
+import { extractSpec } from '@openpkg-ts/sdk';
 
 // Test fixture code samples
 const FIXTURE_CODE = {
@@ -92,7 +92,7 @@ describe('spec command (extractSpec)', () => {
         content: FIXTURE_CODE.basic,
       });
 
-      const kinds = new Set(result.spec.exports.map(e => e.kind));
+      const kinds = new Set(result.spec.exports.map((e) => e.kind));
       expect(kinds.has('function')).toBe(true);
       expect(kinds.has('interface')).toBe(true);
       expect(kinds.has('variable')).toBe(true);
@@ -104,7 +104,7 @@ describe('spec command (extractSpec)', () => {
         content: FIXTURE_CODE.withClasses,
       });
 
-      const classExport = result.spec.exports.find(e => e.kind === 'class');
+      const classExport = result.spec.exports.find((e) => e.kind === 'class');
       expect(classExport).toBeDefined();
       expect(classExport!.name).toBe('Service');
     });
@@ -115,7 +115,7 @@ describe('spec command (extractSpec)', () => {
         content: FIXTURE_CODE.withEnums,
       });
 
-      const enums = result.spec.exports.filter(e => e.kind === 'enum');
+      const enums = result.spec.exports.filter((e) => e.kind === 'enum');
       expect(enums.length).toBe(2);
     });
 
@@ -165,8 +165,8 @@ describe('spec command (extractSpec)', () => {
       });
 
       // Export names and kinds should be consistent
-      const names1 = result1.spec.exports.map(e => e.name).sort();
-      const names2 = result2.spec.exports.map(e => e.name).sort();
+      const names1 = result1.spec.exports.map((e) => e.name).sort();
+      const names2 = result2.spec.exports.map((e) => e.name).sort();
       expect(names1).toEqual(names2);
     });
   });
@@ -191,7 +191,7 @@ describe('spec command (extractSpec)', () => {
       });
 
       expect(result.spec.exports.length).toBe(2);
-      expect(result.spec.exports.every(e => e.name.startsWith('create'))).toBe(true);
+      expect(result.spec.exports.every((e) => e.name.startsWith('create'))).toBe(true);
     });
 
     test('filters with wildcard suffix', async () => {
@@ -201,8 +201,8 @@ describe('spec command (extractSpec)', () => {
         only: ['*User'],
       });
 
-      const names = result.spec.exports.map(e => e.name);
-      expect(names.every(n => n.endsWith('User'))).toBe(true);
+      const names = result.spec.exports.map((e) => e.name);
+      expect(names.every((n) => n.endsWith('User'))).toBe(true);
     });
 
     test('filters multiple patterns', async () => {
@@ -213,7 +213,7 @@ describe('spec command (extractSpec)', () => {
       });
 
       expect(result.spec.exports.length).toBe(2);
-      const names = result.spec.exports.map(e => e.name);
+      const names = result.spec.exports.map((e) => e.name);
       expect(names).toContain('createUser');
       expect(names).toContain('MAX_USERS');
     });
@@ -237,7 +237,7 @@ describe('spec command (extractSpec)', () => {
         ignore: ['deleteUser'],
       });
 
-      const names = result.spec.exports.map(e => e.name);
+      const names = result.spec.exports.map((e) => e.name);
       expect(names).not.toContain('deleteUser');
     });
 
@@ -248,8 +248,8 @@ describe('spec command (extractSpec)', () => {
         ignore: ['*User'],
       });
 
-      const names = result.spec.exports.map(e => e.name);
-      expect(names.some(n => n.endsWith('User'))).toBe(false);
+      const names = result.spec.exports.map((e) => e.name);
+      expect(names.some((n) => n.endsWith('User'))).toBe(false);
     });
 
     test('ignores multiple patterns', async () => {
@@ -259,7 +259,7 @@ describe('spec command (extractSpec)', () => {
         ignore: ['deleteUser', 'MAX_USERS'],
       });
 
-      const names = result.spec.exports.map(e => e.name);
+      const names = result.spec.exports.map((e) => e.name);
       expect(names).not.toContain('deleteUser');
       expect(names).not.toContain('MAX_USERS');
     });
@@ -389,7 +389,7 @@ describe('spec command (extractSpec)', () => {
         content: FIXTURE_CODE.basic,
       });
 
-      const fn = result.spec.exports.find(e => e.kind === 'function');
+      const fn = result.spec.exports.find((e) => e.kind === 'function');
       expect(fn).toBeDefined();
       expect(fn!.signatures).toBeDefined();
     });
@@ -400,7 +400,7 @@ describe('spec command (extractSpec)', () => {
         content: FIXTURE_CODE.basic,
       });
 
-      const iface = result.spec.exports.find(e => e.kind === 'interface');
+      const iface = result.spec.exports.find((e) => e.kind === 'interface');
       expect(iface).toBeDefined();
       expect(iface!.members).toBeDefined();
     });