@openpkg-ts/cli 0.3.0 → 0.3.1

package/dist/shared/chunk-1dqs11h6.js

@@ -0,0 +1,20 @@
+import { createRequire } from "node:module";
+var __create = Object.create;
+var __getProtoOf = Object.getPrototypeOf;
+var __defProp = Object.defineProperty;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __toESM = (mod, isNodeMode, target) => {
+  target = mod != null ? __create(__getProtoOf(mod)) : {};
+  const to = isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target;
+  for (let key of __getOwnPropNames(mod))
+    if (!__hasOwnProp.call(to, key))
+      __defProp(to, key, {
+        get: () => mod[key],
+        enumerable: true
+      });
+  return to;
+};
+var __require = /* @__PURE__ */ createRequire(import.meta.url);
+
+export { __toESM, __require };

package/dist/{index.js → src/index.js}

@@ -1,3 +1,5 @@
+import"../shared/chunk-1dqs11h6.js";
+
 // src/index.ts
 import { getExport, listExports } from "@openpkg-ts/sdk";
 export {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openpkg-ts/cli",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "description": "CLI for OpenPkg TypeScript API extraction and documentation generation",
   "homepage": "https://github.com/ryanwaits/openpkg-ts#readme",
   "repository": {
@@ -9,9 +9,14 @@
     "directory": "packages/cli"
   },
   "type": "module",
+  "main": "./dist/src/index.js",
+  "types": "./dist/src/index.d.ts",
   "bin": {
-    "openpkg": "./bin/openpkg.ts"
+    "openpkg": "./dist/bin/openpkg.js"
   },
+  "files": [
+    "dist"
+  ],
   "scripts": {
     "build": "bunup",
     "dev": "bunup --watch",

package/CHANGELOG.md

@@ -1,44 +0,0 @@
-# @openpkg-ts/cli
-
-## 0.3.0
-
-### Minor Changes
-
-- bd70dc7: add diagnostics, filter primitives, new CLI commands (breaking, changelog, diagnostics, filter, semver, validate), registry system, render enhancements
-
-### Patch Changes
-
-- Updated dependencies [bd70dc7]
-  - @openpkg-ts/sdk@0.31.0
-  - @openpkg-ts/adapters@0.3.0
-
-## 0.2.3
-
-### Patch Changes
-
-- update @openpkg-ts/sdk dependency to ^0.30.2
-
-## 0.2.2
-
-### Patch Changes
-
-- pull version from package.json instead of hardcoding
-
-## 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
-
-- Major monorepo restructure: extract → sdk, doc-generator split into sdk/react/adapters, fumadocs-adapter deleted (use @openpkg-ts/adapters/fumadocs)
-
-### Patch Changes
-
-- Updated dependencies
-  - @openpkg-ts/sdk@0.30.0

package/bin/openpkg.ts

@@ -1,73 +0,0 @@
-#!/usr/bin/env bun
-import * as path from 'node:path';
-import { getExport, listExports } from '@openpkg-ts/sdk';
-import { Command } from 'commander';
-import pkg from '../package.json';
-import { createBreakingCommand } from '../src/commands/breaking';
-import { createChangelogCommand } from '../src/commands/changelog';
-import { createDiagnosticsCommand } from '../src/commands/diagnostics';
-import { createDiffCommand } from '../src/commands/diff';
-import { createFilterCommand } from '../src/commands/filter';
-import { createDocsCommand } from '../src/commands/docs';
-import { createSemverCommand } from '../src/commands/semver';
-import { createSnapshotCommand } from '../src/commands/snapshot';
-import { createValidateCommand } from '../src/commands/validate';
-
-const program = new Command();
-
-program
-  .name('openpkg')
-  .description('OpenPkg CLI - TypeScript API extraction primitives')
-  .version(pkg.version);
-
-program
-  .command('list')
-  .description('List exports from a TypeScript entry point')
-  .argument('<entry>', 'Entry point file path')
-  .action(async (entry: string) => {
-    const entryFile = path.resolve(entry);
-    const result = await listExports({ entryFile });
-
-    if (result.errors.length > 0) {
-      console.error(JSON.stringify({ errors: result.errors }, null, 2));
-      process.exit(1);
-    }
-
-    console.log(JSON.stringify(result.exports, null, 2));
-  });
-
-program
-  .command('get')
-  .description('Get detailed spec for a single export')
-  .argument('<entry>', 'Entry point file path')
-  .argument('<name>', 'Export name')
-  .action(async (entry: string, name: string) => {
-    const entryFile = path.resolve(entry);
-    const result = await getExport({ entryFile, exportName: name });
-
-    if (!result.export) {
-      const errorMsg =
-        result.errors.length > 0 ? result.errors.join('; ') : `Export '${name}' not found`;
-      console.error(JSON.stringify({ error: errorMsg }, null, 2));
-      process.exit(1);
-    }
-
-    // Output export with related types if any
-    const output: Record<string, unknown> = { export: result.export };
-    if (result.types.length > 0) {
-      output.types = result.types;
-    }
-    console.log(JSON.stringify(output, null, 2));
-  });
-
-program.addCommand(createSnapshotCommand());
-program.addCommand(createDiffCommand());
-program.addCommand(createDocsCommand());
-program.addCommand(createBreakingCommand());
-program.addCommand(createChangelogCommand());
-program.addCommand(createSemverCommand());
-program.addCommand(createValidateCommand());
-program.addCommand(createDiagnosticsCommand());
-program.addCommand(createFilterCommand());
-
-program.parse();

package/src/commands/breaking.ts

@@ -1,46 +0,0 @@
-import * as fs from 'node:fs';
-import * as path from 'node:path';
-import { type CategorizedBreaking, categorizeBreakingChanges, diffSpec, type OpenPkg } from '@openpkg-ts/spec';
-import { Command } from 'commander';
-
-export type BreakingResult = {
-  breaking: CategorizedBreaking[];
-  count: number;
-};
-
-function loadSpec(filePath: string): OpenPkg {
-  const resolved = path.resolve(filePath);
-  const content = fs.readFileSync(resolved, 'utf-8');
-  return JSON.parse(content) as OpenPkg;
-}
-
-export function createBreakingCommand(): Command {
-  return new Command('breaking')
-    .description('Check for breaking changes between two specs')
-    .argument('<old>', 'Path to old spec file (JSON)')
-    .argument('<new>', 'Path to new spec file (JSON)')
-    .action(async (oldPath: string, newPath: string) => {
-      try {
-        const oldSpec = loadSpec(oldPath);
-        const newSpec = loadSpec(newPath);
-
-        const diff = diffSpec(oldSpec, newSpec);
-        const categorized = categorizeBreakingChanges(diff.breaking, oldSpec, newSpec);
-
-        const result: BreakingResult = {
-          breaking: categorized,
-          count: categorized.length,
-        };
-
-        console.log(JSON.stringify(result, null, 2));
-
-        if (categorized.length > 0) {
-          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/changelog.test.ts

@@ -1,78 +0,0 @@
-import { 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 type { OpenPkg } from '@openpkg-ts/spec';
-import { $ } from 'bun';
-
-const oldSpec: OpenPkg = {
-  meta: { name: 'test-pkg', version: '1.0.0' },
-  exports: [
-    { id: 'fn-greet', name: 'greet', kind: 'function', signatures: [] },
-    { id: 'fn-removed', name: 'removed', kind: 'function', signatures: [] },
-  ],
-  types: [],
-};
-
-const newSpec: OpenPkg = {
-  meta: { name: 'test-pkg', version: '2.0.0' },
-  exports: [
-    { id: 'fn-greet', name: 'greet', kind: 'function', signatures: [] },
-    { id: 'fn-added', name: 'added', kind: 'function', signatures: [] },
-  ],
-  types: [],
-};
-
-describe('changelog command', () => {
-  test('outputs JSON format', async () => {
-    const tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'changelog-test-'));
-    const oldPath = path.join(tmpDir, 'old.json');
-    const newPath = path.join(tmpDir, 'new.json');
-
-    fs.writeFileSync(oldPath, JSON.stringify(oldSpec));
-    fs.writeFileSync(newPath, JSON.stringify(newSpec));
-
-    const result = await $`bun packages/cli/bin/openpkg.ts changelog ${oldPath} ${newPath} --format json`.text();
-    const parsed = JSON.parse(result);
-
-    expect(parsed).toHaveProperty('breaking');
-    expect(parsed).toHaveProperty('added');
-    expect(parsed).toHaveProperty('removed');
-    expect(parsed).toHaveProperty('summary');
-
-    fs.rmSync(tmpDir, { recursive: true });
-  });
-
-  test('outputs markdown format', async () => {
-    const tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'changelog-test-'));
-    const oldPath = path.join(tmpDir, 'old.json');
-    const newPath = path.join(tmpDir, 'new.json');
-
-    fs.writeFileSync(oldPath, JSON.stringify(oldSpec));
-    fs.writeFileSync(newPath, JSON.stringify(newSpec));
-
-    const result = await $`bun packages/cli/bin/openpkg.ts changelog ${oldPath} ${newPath}`.text();
-
-    expect(result).toContain('## Breaking Changes');
-    expect(result).toContain('removed');
-    expect(result).toContain('## Added');
-    expect(result).toContain('added');
-
-    fs.rmSync(tmpDir, { recursive: true });
-  });
-
-  test('empty diff shows no changes', async () => {
-    const tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'changelog-test-'));
-    const oldPath = path.join(tmpDir, 'old.json');
-    const newPath = path.join(tmpDir, 'new.json');
-
-    fs.writeFileSync(oldPath, JSON.stringify(oldSpec));
-    fs.writeFileSync(newPath, JSON.stringify(oldSpec));
-
-    const result = await $`bun packages/cli/bin/openpkg.ts changelog ${oldPath} ${newPath}`.text();
-
-    expect(result.trim()).toBe('No changes detected.');
-
-    fs.rmSync(tmpDir, { recursive: true });
-  });
-});

package/src/commands/changelog.ts

@@ -1,79 +0,0 @@
-import * as fs from 'node:fs';
-import * as path from 'node:path';
-import type { OpenPkg } from '@openpkg-ts/spec';
-import { Command } from 'commander';
-import { type DiffResult, enrichDiff } from './diff.js';
-
-function loadSpec(filePath: string): OpenPkg {
-  const resolved = path.resolve(filePath);
-  const content = fs.readFileSync(resolved, 'utf-8');
-  return JSON.parse(content) as OpenPkg;
-}
-
-/**
- * Format diff result as markdown changelog
- */
-function formatMarkdown(diff: DiffResult): string {
-  const lines: string[] = [];
-
-  // Breaking Changes
-  if (diff.removed.length > 0 || diff.changed.length > 0) {
-    lines.push('## Breaking Changes');
-    lines.push('');
-    for (const r of diff.removed) {
-      lines.push(`- **Removed** \`${r.name}\` (${r.kind})`);
-    }
-    for (const c of diff.changed) {
-      lines.push(`- **${c.name}** (${c.kind}): ${c.description}`);
-    }
-    lines.push('');
-  }
-
-  // Added
-  if (diff.added.length > 0) {
-    lines.push('## Added');
-    lines.push('');
-    for (const id of diff.added) {
-      lines.push(`- \`${id}\``);
-    }
-    lines.push('');
-  }
-
-  // Changed (docs only)
-  if (diff.docsOnly.length > 0) {
-    lines.push('## Changed');
-    lines.push('');
-    for (const id of diff.docsOnly) {
-      lines.push(`- \`${id}\` (docs)`);
-    }
-    lines.push('');
-  }
-
-  return lines.join('\n').trim() || 'No changes detected.';
-}
-
-export function createChangelogCommand(): Command {
-  return new Command('changelog')
-    .description('Generate changelog from diff between two specs')
-    .argument('<old>', 'Path to old spec file (JSON)')
-    .argument('<new>', 'Path to new spec file (JSON)')
-    .option('--format <format>', 'Output format: md or json', 'md')
-    .action(async (oldPath: string, newPath: string, options: { format?: string }) => {
-      try {
-        const oldSpec = loadSpec(oldPath);
-        const newSpec = loadSpec(newPath);
-
-        const diff = enrichDiff(oldSpec, newSpec);
-
-        if (options.format === 'json') {
-          console.log(JSON.stringify(diff, null, 2));
-        } else {
-          console.log(formatMarkdown(diff));
-        }
-      } 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/diagnostics.test.ts

@@ -1,55 +0,0 @@
-import { afterAll, beforeAll, describe, expect, it } from 'bun:test';
-import * as fs from 'node:fs';
-import * as os from 'node:os';
-import * as path from 'node:path';
-import { $ } from 'bun';
-
-describe('openpkg diagnostics', () => {
-  let tmpDir: string;
-
-  beforeAll(() => {
-    tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'diagnostics-test-'));
-  });
-
-  afterAll(() => {
-    fs.rmSync(tmpDir, { recursive: true });
-  });
-
-  it('outputs JSON with diagnostics', async () => {
-    const specPath = path.join(tmpDir, 'spec.json');
-    const spec = {
-      openpkg: '0.4.0',
-      meta: { name: 'test-pkg' },
-      exports: [
-        { id: 'a', name: 'noDesc', kind: 'function' },
-        { id: 'b', name: 'withDesc', kind: 'function', description: 'Has desc' },
-        {
-          id: 'c',
-          name: 'depNoReason',
-          kind: 'function',
-          description: 'Something',
-          deprecated: true,
-        },
-      ],
-    };
-    fs.writeFileSync(specPath, JSON.stringify(spec));
-
-    const output = await $`bun packages/cli/bin/openpkg.ts diagnostics ${specPath}`.text();
-    const result = JSON.parse(output);
-
-    expect(result.summary.total).toBe(2);
-    expect(result.summary.missingDescriptions).toBe(1);
-    expect(result.summary.deprecatedNoReason).toBe(1);
-    expect(result.diagnostics.missingDescriptions[0].exportName).toBe('noDesc');
-  });
-
-  it('handles malformed spec gracefully', async () => {
-    const specPath = path.join(tmpDir, 'bad.json');
-    fs.writeFileSync(specPath, '{ invalid json');
-
-    const output = await $`bun packages/cli/bin/openpkg.ts diagnostics ${specPath}`.text();
-    const result = JSON.parse(output);
-
-    expect(result.error).toBeDefined();
-  });
-});

package/src/commands/diagnostics.ts

@@ -1,55 +0,0 @@
-import * as fs from 'node:fs';
-import * as path from 'node:path';
-import { analyzeSpec, type SpecDiagnostics } from '@openpkg-ts/sdk';
-import type { OpenPkg } from '@openpkg-ts/spec';
-import { Command } from 'commander';
-
-export interface DiagnosticsResult {
-  summary: {
-    total: number;
-    missingDescriptions: number;
-    deprecatedNoReason: number;
-    missingParamDocs: number;
-  };
-  diagnostics: SpecDiagnostics;
-}
-
-function loadJSON(filePath: string): unknown {
-  const resolved = path.resolve(filePath);
-  const content = fs.readFileSync(resolved, 'utf-8');
-  return JSON.parse(content);
-}
-
-export function createDiagnosticsCommand(): Command {
-  return new Command('diagnostics')
-    .description('Analyze spec for quality issues (missing docs, deprecated without reason)')
-    .argument('<spec>', 'Path to spec file (JSON)')
-    .action(async (specPath: string) => {
-      try {
-        const spec = loadJSON(specPath) as OpenPkg;
-
-        const diagnostics = analyzeSpec(spec);
-
-        const result: DiagnosticsResult = {
-          summary: {
-            total:
-              diagnostics.missingDescriptions.length +
-              diagnostics.deprecatedNoReason.length +
-              diagnostics.missingParamDocs.length,
-            missingDescriptions: diagnostics.missingDescriptions.length,
-            deprecatedNoReason: diagnostics.deprecatedNoReason.length,
-            missingParamDocs: diagnostics.missingParamDocs.length,
-          },
-          diagnostics,
-        };
-
-        console.log(JSON.stringify(result, null, 2));
-        // Always exit 0 - informational only
-        process.exit(0);
-      } catch (err) {
-        const error = err instanceof Error ? err : new Error(String(err));
-        console.log(JSON.stringify({ error: error.message }, null, 2));
-        process.exit(0);
-      }
-    });
-}

package/src/commands/diff.ts

@@ -1,174 +0,0 @@
-import * as fs from 'node:fs';
-import * as path from 'node:path';
-import {
-  type CategorizedBreaking,
-  categorizeBreakingChanges,
-  diffSpec,
-  type OpenPkg,
-  recommendSemverBump,
-  type SemverBump,
-  type SpecExportKind,
-} from '@openpkg-ts/spec';
-import { Command } from 'commander';
-
-/**
- * A changed export with details about what changed
- */
-export interface ChangedExport {
-  id: string;
-  name: string;
-  kind: SpecExportKind;
-  description: string;
-}
-
-/**
- * Enriched diff result with categorized changes
- */
-export interface DiffResult {
-  breaking: CategorizedBreaking[];
-  added: string[];
-  removed: RemovedExport[];
-  changed: ChangedExport[];
-  docsOnly: string[];
-  summary: {
-    breakingCount: number;
-    addedCount: number;
-    removedCount: number;
-    changedCount: number;
-    docsOnlyCount: number;
-    semverBump: SemverBump;
-    semverReason: string;
-  };
-}
-
-export interface RemovedExport {
-  id: string;
-  name: string;
-  kind: SpecExportKind;
-}
-
-function loadSpec(filePath: string): OpenPkg {
-  const resolved = path.resolve(filePath);
-  const content = fs.readFileSync(resolved, 'utf-8');
-  return JSON.parse(content) as OpenPkg;
-}
-
-function toExportMap(spec: OpenPkg): Map<string, { name: string; kind: SpecExportKind }> {
-  const map = new Map<string, { name: string; kind: SpecExportKind }>();
-  for (const exp of spec.exports) {
-    map.set(exp.id, { name: exp.name, kind: exp.kind });
-  }
-  if (spec.types) {
-    for (const t of spec.types) {
-      map.set(t.id, { name: t.name, kind: t.kind as SpecExportKind });
-    }
-  }
-  return map;
-}
-
-/**
- * Enriches basic diffSpec output with categorization
- */
-export function enrichDiff(oldSpec: OpenPkg, newSpec: OpenPkg): DiffResult {
-  const rawDiff = diffSpec(oldSpec, newSpec);
-  const categorized = categorizeBreakingChanges(rawDiff.breaking, oldSpec, newSpec);
-  const semver = recommendSemverBump(rawDiff);
-
-  const oldExports = toExportMap(oldSpec);
-
-  // Separate removed from changed
-  const removed: RemovedExport[] = [];
-  const changed: ChangedExport[] = [];
-  const breaking: CategorizedBreaking[] = [];
-
-  for (const cat of categorized) {
-    if (cat.reason === 'removed') {
-      const info = oldExports.get(cat.id);
-      removed.push({
-        id: cat.id,
-        name: cat.name,
-        kind: info?.kind ?? cat.kind,
-      });
-    } else {
-      // It's a change, not a removal
-      changed.push({
-        id: cat.id,
-        name: cat.name,
-        kind: cat.kind,
-        description: describeChange(cat),
-      });
-      breaking.push(cat);
-    }
-  }
-
-  // Added exports
-  const added = rawDiff.nonBreaking;
-
-  return {
-    breaking,
-    added,
-    removed,
-    changed,
-    docsOnly: rawDiff.docsOnly,
-    summary: {
-      breakingCount: breaking.length,
-      addedCount: added.length,
-      removedCount: removed.length,
-      changedCount: changed.length,
-      docsOnlyCount: rawDiff.docsOnly.length,
-      semverBump: semver.bump,
-      semverReason: semver.reason,
-    },
-  };
-}
-
-/**
- * Generate human-readable description for a change
- */
-function describeChange(cat: CategorizedBreaking): string {
-  switch (cat.reason) {
-    case 'signature changed':
-      return `Function signature changed`;
-    case 'type definition changed':
-      return `Type definition changed`;
-    case 'constructor changed':
-      return `Class constructor signature changed`;
-    case 'methods removed':
-      return `Class methods removed`;
-    case 'methods changed':
-      return `Class methods changed`;
-    case 'changed':
-      return `${cat.kind} changed`;
-    default:
-      return cat.reason;
-  }
-}
-
-export function createDiffCommand(): Command {
-  return new Command('diff')
-    .description('Compare two OpenPkg specs and show differences')
-    .argument('<old>', 'Path to old spec file (JSON)')
-    .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);
-
-          const result = enrichDiff(oldSpec, newSpec);
-
-          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);
-        }
-      },
-    );
-}