@ankhorage/paradox 0.1.12 → 0.1.14

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.14
4
+
5
+ ### Patch Changes
6
+
7
+ - 63a2f91: Add execution handlers to the docs command surface.
8
+
9
+ ## 0.1.13
10
+
11
+ ### Patch Changes
12
+
13
+ - df28363: Expose docs command surface metadata for Ankh discovery.
14
+
3
15
  ## 0.1.12
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.12](./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.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)
7
7
 
8
8
  Deterministic documentation generator for TypeScript packages.
9
9
 
@@ -0,0 +1,26 @@
1
+ declare const _default: {
2
+ id: string;
3
+ category: string;
4
+ version: string;
5
+ capabilities: string[];
6
+ commands: readonly [{
7
+ readonly path: readonly ["docs"];
8
+ readonly summary: "Generate package documentation.";
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
+ }];
19
+ handlers: {
20
+ path: readonly ["docs"] | readonly ["docs", "write"] | readonly ["docs", "check"];
21
+ handler(): {
22
+ exitCode: number;
23
+ };
24
+ }[];
25
+ };
26
+ export default _default;
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,7 @@
1
+ import { describe, expect, test } from 'bun:test';
2
+ import surface from './docsSurface.js';
3
+ describe('docs surface handlers', () => {
4
+ test('declares handlers for every command', () => {
5
+ expect(surface.handlers).toHaveLength(surface.commands.length);
6
+ });
7
+ });
@@ -0,0 +1,35 @@
1
+ import { spawnSync } from 'node:child_process';
2
+ const packageName = '@ankhorage/paradox';
3
+ const packageVersion = '0.1.13';
4
+ const commandList = [
5
+ {
6
+ path: ['docs'],
7
+ summary: 'Generate package documentation.',
8
+ capability: 'docs.generate',
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
+ ];
21
+ const handlers = commandList.map((command) => ({
22
+ path: command.path,
23
+ handler() {
24
+ const result = spawnSync('paradox', [], { stdio: 'inherit' });
25
+ return { exitCode: result.status ?? 1 };
26
+ },
27
+ }));
28
+ export default {
29
+ id: packageName,
30
+ category: 'docs',
31
+ version: packageVersion,
32
+ capabilities: ['docs.generate', 'docs.check'],
33
+ commands: commandList,
34
+ handlers,
35
+ };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ankhorage/paradox",
3
- "version": "0.1.12",
3
+ "version": "0.1.14",
4
4
  "description": "Deterministic documentation generator for TypeScript packages.",
5
5
  "license": "MIT",
6
6
  "publishConfig": {
@@ -42,13 +42,11 @@
42
42
  "paradox": "./dist/cli.js"
43
43
  },
44
44
  "ankh": {
45
- "category": "paradox",
46
- "provider": null,
45
+ "category": "docs",
46
+ "provider": "./dist/docsSurface.js",
47
47
  "capabilities": [
48
- "paradox.package",
49
- "paradox.config",
50
- "paradox.model",
51
- "paradox.tags"
48
+ "docs.generate",
49
+ "docs.check"
52
50
  ]
53
51
  },
54
52
  "scripts": {