@ankhorage/paradox 0.2.21 → 0.2.23
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 +12 -0
- package/README.md +9 -9
- package/dist/analyze/analyze.js +3 -4
- package/package.json +3 -3
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,17 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 0.2.23
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- 6037036: Only render a README configuration example when the analyzed package explicitly owns an @config + @readme package configuration contract.
|
|
8
|
+
|
|
9
|
+
## 0.2.22
|
|
10
|
+
|
|
11
|
+
### Patch Changes
|
|
12
|
+
|
|
13
|
+
- 2088665: Update Ankhorage dependencies: `@ankhorage/utility`.
|
|
14
|
+
|
|
3
15
|
## 0.2.21
|
|
4
16
|
|
|
5
17
|
### Patch Changes
|
package/README.md
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
# @ankhorage/paradox
|
|
5
5
|
|
|
6
|
-
         
|
|
7
7
|
|
|
8
8
|
Deterministic documentation generator for TypeScript packages.
|
|
9
9
|
|
|
@@ -67,14 +67,14 @@ export default defineParadoxConfig({
|
|
|
67
67
|
<details>
|
|
68
68
|
<summary>Configuration options</summary>
|
|
69
69
|
|
|
70
|
-
| Field
|
|
71
|
-
|
|
|
72
|
-
| mode
|
|
73
|
-
| collaborators | `true \| undefined`
|
|
74
|
-
| donation
|
|
75
|
-
| docs
|
|
76
|
-
| package
|
|
77
|
-
| output
|
|
70
|
+
| Field | Type | Required | Default | Description |
|
|
71
|
+
| --- | --- | --- | --- | --- |
|
|
72
|
+
| mode | `'safe' \| 'write' \| undefined` | no | — | |
|
|
73
|
+
| collaborators | `true \| undefined` | no | — | |
|
|
74
|
+
| donation | `{ account: string; } \| undefined` | no | — | |
|
|
75
|
+
| docs | `{ title?: string; description?: string; } \| undefined` | no | — | |
|
|
76
|
+
| package | `{ root?: string; entrypoints?: string[]; } \| undefined` | no | — | |
|
|
77
|
+
| output | `{ dir?: string; } \| undefined` | no | — | |
|
|
78
78
|
|
|
79
79
|
</details>
|
|
80
80
|
|
package/dist/analyze/analyze.js
CHANGED
|
@@ -41,10 +41,9 @@ export async function analyze(config, runtime) {
|
|
|
41
41
|
const usageEntries = await analyzeReadmeUsage({ root });
|
|
42
42
|
const exampleCount = await countExampleDirectoriesAsync(root);
|
|
43
43
|
const comments = await collectDocumentationCommentsAsync(root);
|
|
44
|
-
const readmeConfig =
|
|
45
|
-
root,
|
|
46
|
-
|
|
47
|
-
});
|
|
44
|
+
const readmeConfig = configMetadata?.isReadme === true
|
|
45
|
+
? await analyzeReadmeConfig({ root, configFilePath: runtime.configFilePath ?? null })
|
|
46
|
+
: null;
|
|
48
47
|
const configMembers = collectConfigMembers(program, exports, configMetadata);
|
|
49
48
|
const graphs = {
|
|
50
49
|
imports: collectImportGraph(program),
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ankhorage/paradox",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.23",
|
|
4
4
|
"description": "Deterministic documentation generator for TypeScript packages.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"publishConfig": {
|
|
@@ -72,13 +72,13 @@
|
|
|
72
72
|
},
|
|
73
73
|
"dependencies": {
|
|
74
74
|
"@ankhorage/policy": "^0.6.0",
|
|
75
|
-
"@ankhorage/utility": "^1.9.
|
|
75
|
+
"@ankhorage/utility": "^1.9.54",
|
|
76
76
|
"ts-morph": "^28.0.0"
|
|
77
77
|
},
|
|
78
78
|
"devDependencies": {
|
|
79
79
|
"@ankhorage/devtools": "^2.0.0",
|
|
80
80
|
"@types/bun": "^1.4.2",
|
|
81
|
-
"@types/node": "^
|
|
81
|
+
"@types/node": "^24.13.3",
|
|
82
82
|
"typescript": "^5.9.3"
|
|
83
83
|
},
|
|
84
84
|
"packageManager": "bun@1.4.2"
|