@ankhorage/paradox 0.1.14 → 0.1.16

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,17 @@
1
1
  # Changelog
2
2
 
3
+ ## 0.1.16
4
+
5
+ ### Patch Changes
6
+
7
+ - 5bbc16a: Move the standalone executable into the canonical `src/cli/` folder while keeping the provider export at `src/cli/index.ts`.
8
+
9
+ ## 0.1.15
10
+
11
+ ### Patch Changes
12
+
13
+ - 7d54020: Expose the package command provider.
14
+
3
15
  ## 0.1.14
4
16
 
5
17
  ### Patch Changes
package/README.md CHANGED
@@ -3,7 +3,7 @@
3
3
 
4
4
  # @ankhorage/paradox
5
5
 
6
- ![license: MIT](./paradox/badges/license.svg) ![npm: v0.1.14](./paradox/badges/npm.svg) ![runtime: bun](./paradox/badges/runtime.svg) ![typescript: strict](./paradox/badges/typescript.svg) ![eslint: checked](./paradox/badges/eslint.svg) ![prettier: checked](./paradox/badges/prettier.svg) ![build: checked](./paradox/badges/build.svg) ![tests: checked](./paradox/badges/tests.svg) ![docs: paradox](./paradox/badges/docs.svg)
6
+ ![license: MIT](./paradox/badges/license.svg) ![npm: v0.1.16](./paradox/badges/npm.svg) ![runtime: bun](./paradox/badges/runtime.svg) ![typescript: strict](./paradox/badges/typescript.svg) ![eslint: checked](./paradox/badges/eslint.svg) ![prettier: checked](./paradox/badges/prettier.svg) ![build: checked](./paradox/badges/build.svg) ![tests: checked](./paradox/badges/tests.svg) ![docs: paradox](./paradox/badges/docs.svg)
7
7
 
8
8
  Deterministic documentation generator for TypeScript packages.
9
9
 
@@ -0,0 +1 @@
1
+ export { default } from '../docsSurface.js';
@@ -0,0 +1 @@
1
+ export { default } from '../docsSurface.js';
@@ -1,10 +1,10 @@
1
1
  #!/usr/bin/env bun
2
2
  import { dirname } from 'node:path';
3
- import { analyze } from './analyze/analyze.js';
4
- import { buildModel } from './model/buildModel.js';
5
- import { findParadoxConfigFile, loadParadoxConfig, resolveOutputRoot, resolvePackageRoot, } from './paths/policy.js';
6
- import { render } from './render/render.js';
7
- import { write } from './write/write.js';
3
+ import { analyze } from '../analyze/analyze.js';
4
+ import { buildModel } from '../model/buildModel.js';
5
+ import { findParadoxConfigFile, loadParadoxConfig, resolveOutputRoot, resolvePackageRoot, } from '../paths/policy.js';
6
+ import { render } from '../render/render.js';
7
+ import { write } from '../write/write.js';
8
8
  /***
9
9
  * Runs the Paradox CLI.
10
10
  *
@@ -4,20 +4,12 @@ declare const _default: {
4
4
  version: string;
5
5
  capabilities: string[];
6
6
  commands: readonly [{
7
- readonly path: readonly ["docs"];
7
+ readonly path: readonly ["generate"];
8
8
  readonly summary: "Generate package documentation.";
9
9
  readonly capability: "docs.generate";
10
- }, {
11
- readonly path: readonly ["docs", "write"];
12
- readonly summary: "Generate and write package documentation.";
13
- readonly capability: "docs.generate";
14
- }, {
15
- readonly path: readonly ["docs", "check"];
16
- readonly summary: "Check package documentation generation.";
17
- readonly capability: "docs.check";
18
10
  }];
19
11
  handlers: {
20
- path: readonly ["docs"] | readonly ["docs", "write"] | readonly ["docs", "check"];
12
+ path: readonly ["generate"];
21
13
  handler(): {
22
14
  exitCode: number;
23
15
  };
@@ -1,22 +1,12 @@
1
1
  import { spawnSync } from 'node:child_process';
2
2
  const packageName = '@ankhorage/paradox';
3
- const packageVersion = '0.1.13';
3
+ const packageVersion = '0.1.14';
4
4
  const commandList = [
5
5
  {
6
- path: ['docs'],
6
+ path: ['generate'],
7
7
  summary: 'Generate package documentation.',
8
8
  capability: 'docs.generate',
9
9
  },
10
- {
11
- path: ['docs', 'write'],
12
- summary: 'Generate and write package documentation.',
13
- capability: 'docs.generate',
14
- },
15
- {
16
- path: ['docs', 'check'],
17
- summary: 'Check package documentation generation.',
18
- capability: 'docs.check',
19
- },
20
10
  ];
21
11
  const handlers = commandList.map((command) => ({
22
12
  path: command.path,
@@ -29,7 +19,7 @@ export default {
29
19
  id: packageName,
30
20
  category: 'docs',
31
21
  version: packageVersion,
32
- capabilities: ['docs.generate', 'docs.check'],
22
+ capabilities: ['docs.generate'],
33
23
  commands: commandList,
34
24
  handlers,
35
25
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ankhorage/paradox",
3
- "version": "0.1.14",
3
+ "version": "0.1.16",
4
4
  "description": "Deterministic documentation generator for TypeScript packages.",
5
5
  "license": "MIT",
6
6
  "publishConfig": {
@@ -30,6 +30,10 @@
30
30
  "types": "./dist/index.d.ts",
31
31
  "import": "./dist/index.js"
32
32
  },
33
+ "./cli": {
34
+ "types": "./dist/cli/index.d.ts",
35
+ "import": "./dist/cli/index.js"
36
+ },
33
37
  "./package.json": "./package.json"
34
38
  },
35
39
  "files": [
@@ -39,21 +43,20 @@
39
43
  "LICENSE"
40
44
  ],
41
45
  "bin": {
42
- "paradox": "./dist/cli.js"
46
+ "paradox": "./dist/cli/standalone.js"
43
47
  },
44
48
  "ankh": {
45
49
  "category": "docs",
46
- "provider": "./dist/docsSurface.js",
50
+ "provider": "./dist/cli/index.js",
47
51
  "capabilities": [
48
- "docs.generate",
49
- "docs.check"
52
+ "docs.generate"
50
53
  ]
51
54
  },
52
55
  "scripts": {
53
56
  "build": "tsc -p tsconfig.build.json",
54
57
  "changeset": "changeset",
55
58
  "changeset:status": "changeset status --since=origin/main",
56
- "docs": "bun src/cli.ts",
59
+ "docs": "bun src/cli/standalone.ts",
57
60
  "docs:bunx": "bunx @ankhorage/paradox",
58
61
  "format": "ankhorage-prettier --write .",
59
62
  "format:check": "ankhorage-prettier --check .",
File without changes