@clidoc/core 0.1.0 → 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,11 @@
+## [@clidoc/core-v1.0.0](https://github.com/bhouston/clidoc/compare/@clidoc/core-v0.1.0...@clidoc/core-v1.0.0) (2026-09-22)
+
+### ⚠ BREAKING CHANGES
+
+* @clidoc/adapter-yargs is now @clidoc/yargs,
+@clidoc/adapter-commander is now @clidoc/commander, and @clidoc/adapter-oclif
+is now @clidoc/oclif. Update imports and dependencies to the new names.
+
+### Code Refactoring
+
+* rename adapter packages to @clidoc/yargs, @clidoc/commander, @clidoc/oclif ([0e53199](https://github.com/bhouston/clidoc/commit/0e53199031de597485399079076b4050e7f5fa6a)), closes [#129](https://github.com/bhouston/clidoc/issues/129)

package/README.md

@@ -23,7 +23,7 @@ const pages = generatePages(document, { basePath: '/cli' });
 
 ## Adding author-supplied metadata
 
-Adapters generate a document from what your CLI's argument parser already knows, so things like
+The framework packages generate a document from what your CLI's argument parser already knows, so things like
 `examples`, `exitCodes`, `info.license`/`contact`, `install`, and `global` config are usually
 missing. Add them with `mergeDocument`, then re-validate:
 
@@ -57,7 +57,7 @@ validates an OpenCLI document and returns a standalone completion script. It
 supports nested commands, aliases, global/local flags, option and positional
 choices, and hidden entries, with no runtime dependency on Node or the target CLI.
 The optional `binary` overrides only the registered executable name. See the
-[completion guide](https://clidoc.dev/docs/guides/completion) for activation,
+[completion guide](https://clidoc.dev/docs/completion) for activation,
 supported syntax, and limitations.
 
 ## License

package/dist/discovery.d.ts

@@ -1,5 +1,5 @@
 import type { OpenCliDocument } from './types.js';
-/** Hidden subcommand upstream OpenCLI adapters use for machine discovery. */
+/** Hidden subcommand upstream OpenCLI libraries use for machine discovery. */
 export declare const OPENCLI_DISCOVERY_COMMAND: '__opencli';
 /**
  * If argv requests the OpenCLI document (`__opencli` subcommand, optionally with upstream's

package/dist/discovery.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"discovery.d.ts","sourceRoot":"","sources":["../src/discovery.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAElD,6EAA6E;AAC7E,eAAO,MAAM,yBAAyB,EAAG,WAAoB,CAAC;AAoB9D;;;;;GAKG;AACH,wBAAsB,oBAAoB,CACxC,IAAI,EAAE,SAAS,MAAM,EAAE,EACvB,QAAQ,EAAE,MAAM,eAAe,EAC/B,KAAK,GAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAA6C,GACtE,OAAO,CAAC,OAAO,CAAC,CAUlB"}
+{"version":3,"file":"discovery.d.ts","sourceRoot":"","sources":["../src/discovery.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAElD,8EAA8E;AAC9E,eAAO,MAAM,yBAAyB,EAAG,WAAoB,CAAC;AAoB9D;;;;;GAKG;AACH,wBAAsB,oBAAoB,CACxC,IAAI,EAAE,SAAS,MAAM,EAAE,EACvB,QAAQ,EAAE,MAAM,eAAe,EAC/B,KAAK,GAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAA6C,GACtE,OAAO,CAAC,OAAO,CAAC,CAUlB"}

package/dist/discovery.js

@@ -1,11 +1,11 @@
 import { writeOpenCliDocument } from './docgen.js';
-/** Hidden subcommand upstream OpenCLI adapters use for machine discovery. */
+/** Hidden subcommand upstream OpenCLI libraries use for machine discovery. */
 export const OPENCLI_DISCOVERY_COMMAND = '__opencli';
 /** Sentinel returned by {@link parseOutArg} for argv this module doesn't recognize. */
 const INVALID = Symbol('invalid');
 /**
  * Parse `-o <file>` / `--out <file>` / `--out=<file>` from the args following `__opencli`,
- * matching upstream OpenCLI's `ocobra` adapter flag. Returns `undefined` for no args (write to
+ * matching upstream OpenCLI's `ocobra` flag. Returns `undefined` for no args (write to
  * stdout), the file path for a recognized flag, or {@link INVALID} for anything else.
  */
 function parseOutArg(args) {

package/dist/discovery.js.map

@@ -1 +1 @@
-{"version":3,"file":"discovery.js","sourceRoot":"","sources":["../src/discovery.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAGnD,6EAA6E;AAC7E,MAAM,CAAC,MAAM,yBAAyB,GAAG,WAAoB,CAAC;AAE9D,uFAAuF;AACvF,MAAM,OAAO,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC;AAElC;;;;GAIG;AACH,SAAS,WAAW,CAAC,IAAuB;IAC1C,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,SAAS,CAAC;IACxC,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACtB,MAAM,KAAK,GAAG,qBAAqB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAE,CAAC,CAAC;QACnD,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAE,CAAC,CAAC,CAAC,OAAO,CAAC;IACrC,CAAC;IACD,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC;QAAE,OAAO,IAAI,CAAC,CAAC,CAAC,CAAC;IACnF,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACxC,IAAuB,EACvB,QAA+B,EAC/B,KAAK,GAA4B,CAAC,KAAK,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC;IAEvE,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,yBAAyB;QAAE,OAAO,KAAK,CAAC;IACxD,MAAM,OAAO,GAAG,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IAC3C,IAAI,OAAO,KAAK,OAAO;QAAE,OAAO,KAAK,CAAC;IACtC,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;QAC1B,KAAK,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC;IACpD,CAAC;SAAM,CAAC;QACN,MAAM,oBAAoB,CAAC,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAClD,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC"}
+{"version":3,"file":"discovery.js","sourceRoot":"","sources":["../src/discovery.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAGnD,8EAA8E;AAC9E,MAAM,CAAC,MAAM,yBAAyB,GAAG,WAAoB,CAAC;AAE9D,uFAAuF;AACvF,MAAM,OAAO,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC;AAElC;;;;GAIG;AACH,SAAS,WAAW,CAAC,IAAuB;IAC1C,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,SAAS,CAAC;IACxC,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACtB,MAAM,KAAK,GAAG,qBAAqB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAE,CAAC,CAAC;QACnD,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAE,CAAC,CAAC,CAAC,OAAO,CAAC;IACrC,CAAC;IACD,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC;QAAE,OAAO,IAAI,CAAC,CAAC,CAAC,CAAC;IACnF,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACxC,IAAuB,EACvB,QAA+B,EAC/B,KAAK,GAA4B,CAAC,KAAK,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC;IAEvE,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,yBAAyB;QAAE,OAAO,KAAK,CAAC;IACxD,MAAM,OAAO,GAAG,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IAC3C,IAAI,OAAO,KAAK,OAAO;QAAE,OAAO,KAAK,CAAC;IACtC,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;QAC1B,KAAK,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC;IACpD,CAAC;SAAM,CAAC;QACN,MAAM,oBAAoB,CAAC,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAClD,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC"}

package/dist/docgen.d.ts

@@ -7,7 +7,7 @@ export type PackageJsonLike = {
     bin?: string | Record<string, string>;
 };
 /**
- * Derive an {@link InfoObject} from a parsed `package.json`, so adapters don't each need their
+ * Derive an {@link InfoObject} from a parsed `package.json`, so framework packages don't each need their
  * own `title`/`binary`/`version` bookkeeping. `overrides` wins over anything derived from `pkg`,
  * and is required for whatever `pkg` cannot express (e.g. a package that exposes several binaries).
  */
@@ -16,7 +16,7 @@ export declare function infoFromPackageJson(pkg: PackageJsonLike, overrides?: Pa
 export type DocumentFormat = 'json' | 'yaml' | 'markdown';
 /**
  * Render `document` (JSON, YAML, or Markdown) and write it to `output`, or to stdout if `output`
- * is omitted. Shared by every adapter's docgen command and by `handleOpenCliRequest`.
+ * is omitted. Shared by every framework package's docgen command and by `handleOpenCliRequest`.
  */
 export declare function writeOpenCliDocument(document: OpenCliDocument, output?: string, format?: DocumentFormat): Promise<void>;
 //# sourceMappingURL=docgen.d.ts.map

package/dist/docgen.js

@@ -6,7 +6,7 @@ function unscopedName(name) {
     return name.replace(/^@[^/]+\//, '');
 }
 /**
- * Derive an {@link InfoObject} from a parsed `package.json`, so adapters don't each need their
+ * Derive an {@link InfoObject} from a parsed `package.json`, so framework packages don't each need their
  * own `title`/`binary`/`version` bookkeeping. `overrides` wins over anything derived from `pkg`,
  * and is required for whatever `pkg` cannot express (e.g. a package that exposes several binaries).
  */
@@ -27,7 +27,7 @@ export function infoFromPackageJson(pkg, overrides = {}) {
 }
 /**
  * Render `document` (JSON, YAML, or Markdown) and write it to `output`, or to stdout if `output`
- * is omitted. Shared by every adapter's docgen command and by `handleOpenCliRequest`.
+ * is omitted. Shared by every framework package's docgen command and by `handleOpenCliRequest`.
  */
 export async function writeOpenCliDocument(document, output, format = 'json') {
     const content = format === 'markdown'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@clidoc/core",
-  "version": "0.1.0",
+  "version": "1.0.0",
   "description": "OpenCLI specification types, validation, and Markdown documentation generation",
   "keywords": [
     "cli",

package/src/discovery.ts

@@ -1,7 +1,7 @@
 import { writeOpenCliDocument } from './docgen.js';
 import type { OpenCliDocument } from './types.js';
 
-/** Hidden subcommand upstream OpenCLI adapters use for machine discovery. */
+/** Hidden subcommand upstream OpenCLI libraries use for machine discovery. */
 export const OPENCLI_DISCOVERY_COMMAND = '__opencli' as const;
 
 /** Sentinel returned by {@link parseOutArg} for argv this module doesn't recognize. */
@@ -9,7 +9,7 @@ const INVALID = Symbol('invalid');
 
 /**
  * Parse `-o <file>` / `--out <file>` / `--out=<file>` from the args following `__opencli`,
- * matching upstream OpenCLI's `ocobra` adapter flag. Returns `undefined` for no args (write to
+ * matching upstream OpenCLI's `ocobra` flag. Returns `undefined` for no args (write to
  * stdout), the file path for a recognized flag, or {@link INVALID} for anything else.
  */
 function parseOutArg(args: readonly string[]): string | undefined | typeof INVALID {

package/src/docgen.ts

@@ -17,7 +17,7 @@ function unscopedName(name: string): string {
 }
 
 /**
- * Derive an {@link InfoObject} from a parsed `package.json`, so adapters don't each need their
+ * Derive an {@link InfoObject} from a parsed `package.json`, so framework packages don't each need their
  * own `title`/`binary`/`version` bookkeeping. `overrides` wins over anything derived from `pkg`,
  * and is required for whatever `pkg` cannot express (e.g. a package that exposes several binaries).
  */
@@ -40,7 +40,7 @@ export type DocumentFormat = 'json' | 'yaml' | 'markdown';
 
 /**
  * Render `document` (JSON, YAML, or Markdown) and write it to `output`, or to stdout if `output`
- * is omitted. Shared by every adapter's docgen command and by `handleOpenCliRequest`.
+ * is omitted. Shared by every framework package's docgen command and by `handleOpenCliRequest`.
  */
 export async function writeOpenCliDocument(
   document: OpenCliDocument,