@ankhorage/paradox 0.1.8 → 0.1.9

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.
Files changed (4) hide show
  1. package/CHANGELOG.md +6 -0
  2. package/README.md +1 -193
  3. package/dist/render/renderers/markdown.js +0 -12
  4. package/package.json +1 -1
package/CHANGELOG.md CHANGED
@@ -1,5 +1,11 @@
1
1
  # Changelog
2
2
 
3
+ ## 0.1.9
4
+
5
+ ### Patch Changes
6
+
7
+ - 9b43e55: Keep generated README files compact by linking diagram artifacts from the generated documentation section instead of embedding the architecture preview inline.
8
+
3
9
  ## 0.1.8
4
10
 
5
11
  ### 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.8](./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.9](./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
 
@@ -99,198 +99,6 @@ export default defineParadoxConfig({
99
99
  - [isParadoxDocTagName sequence](./paradox/diagrams/sequences/is-paradox-doc-tag-name.mmd)
100
100
  - [paradox sequence](./paradox/diagrams/sequences/paradox.mmd)
101
101
 
102
- ## Architecture preview
103
-
104
- <details>
105
- <summary>Architecture overview</summary>
106
-
107
- ```mermaid
108
- graph TD
109
- package__ankhorage_paradox["@ankhorage/paradox"]
110
- entrypoint_src_index_ts["src/index.ts"]
111
- package__ankhorage_paradox --> entrypoint_src_index_ts
112
- module_src_analyze_analyze_ts["src/analyze/analyze.ts"]
113
- package__ankhorage_paradox -.-> module_src_analyze_analyze_ts
114
- module_src_analyze_analyze_ts --> module_src_analyze_badges_ts
115
- module_src_analyze_analyze_ts --> module_src_analyze_components_ts
116
- module_src_analyze_analyze_ts --> module_src_analyze_exports_ts
117
- module_src_analyze_analyze_ts --> module_src_analyze_modules_ts
118
- module_src_analyze_analyze_ts --> module_src_analyze_project_ts
119
- module_src_analyze_analyze_ts --> module_src_analyze_semantic_createTypeScriptProgram_ts
120
- module_src_analyze_analyze_ts --> module_src_analyze_semantic_exports_ts
121
- module_src_analyze_analyze_ts --> module_src_analyze_semantic_graphs_ts
122
- module_src_analyze_analyze_ts --> module_src_analyze_sequenceScenarios_ts
123
- module_src_analyze_analyze_ts --> module_src_analyze_sourceFunctions_ts
124
- module_src_analyze_analyze_ts --> module_src_analyze_types_ts
125
- module_src_analyze_analyze_ts --> module_src_analyze_usage_ts
126
- module_src_analyze_analyze_ts --> module_src_config_types_ts
127
- module_src_analyze_badges_ts["src/analyze/badges.ts"]
128
- package__ankhorage_paradox -.-> module_src_analyze_badges_ts
129
- module_src_analyze_badges_ts --> module_src_analyze_types_ts
130
- module_src_analyze_badges_ts --> module_src_analyze_usage_ts
131
- module_src_analyze_components_ts["src/analyze/components.ts"]
132
- package__ankhorage_paradox -.-> module_src_analyze_components_ts
133
- module_src_analyze_components_ts --> module_src_analyze_semantic_exports_ts
134
- module_src_analyze_components_ts --> module_src_analyze_semantic_model_ts
135
- module_src_analyze_components_ts --> module_src_analyze_types_ts
136
- module_src_analyze_components_ts --> module_src_analyze_utils_getComponentPropsType_ts
137
- module_src_analyze_components_ts --> module_src_analyze_utils_getPropsFromType_ts
138
- module_src_analyze_components_ts --> module_src_analyze_utils_isReactComponent_ts
139
- module_src_analyze_exports_ts["src/analyze/exports.ts"]
140
- package__ankhorage_paradox -.-> module_src_analyze_exports_ts
141
- module_src_analyze_exports_ts --> module_src_analyze_types_ts
142
- module_src_analyze_exports_ts --> module_src_analyze_utils_getExportMetadata_ts
143
- module_src_analyze_exports_ts --> module_src_analyze_utils_getParadoxComment_ts
144
- module_src_analyze_exports_ts --> module_src_analyze_utils_parseParadoxComment_ts
145
- module_src_analyze_exports_ts --> module_src_analyze_utils_resolveExportSymbol_ts
146
- module_src_analyze_modules_ts["src/analyze/modules.ts"]
147
- package__ankhorage_paradox -.-> module_src_analyze_modules_ts
148
- module_src_analyze_modules_ts --> module_src_analyze_types_ts
149
- module_src_analyze_project_ts["src/analyze/project.ts"]
150
- package__ankhorage_paradox -.-> module_src_analyze_project_ts
151
- module_src_analyze_semantic_analyzeProject_ts["src/analyze/semantic/analyzeProject.ts"]
152
- package__ankhorage_paradox -.-> module_src_analyze_semantic_analyzeProject_ts
153
- module_src_analyze_semantic_analyzeProject_ts --> module_src_analyze_semantic_associateDocBlocksWithSymbols_ts
154
- module_src_analyze_semantic_analyzeProject_ts --> module_src_analyze_semantic_collectSourceFiles_ts
155
- module_src_analyze_semantic_analyzeProject_ts --> module_src_analyze_semantic_createTypeScriptProgram_ts
156
- module_src_analyze_semantic_analyzeProject_ts --> module_src_analyze_semantic_docBlocks_ts
157
- module_src_analyze_semantic_analyzeProject_ts --> module_src_analyze_semantic_exports_ts
158
- module_src_analyze_semantic_analyzeProject_ts --> module_src_analyze_semantic_graphs_ts
159
- module_src_analyze_semantic_analyzeProject_ts --> module_src_analyze_semantic_model_ts
160
- module_src_analyze_semantic_analyzeProject_ts --> module_src_analyze_semantic_tagRegistry_ts
161
- module_src_analyze_semantic_associateDocBlocksWithSymbols_ts["src/analyze/semantic/associateDocBlocksWithSymbols.ts"]
162
- package__ankhorage_paradox -.-> module_src_analyze_semantic_associateDocBlocksWithSymbols_ts
163
- module_src_analyze_semantic_associateDocBlocksWithSymbols_ts --> module_src_analyze_semantic_model_ts
164
- module_src_analyze_semantic_associateDocBlocksWithSymbols_ts --> module_src_analyze_semantic_utils_ts
165
- module_src_analyze_semantic_collectSourceFiles_ts["src/analyze/semantic/collectSourceFiles.ts"]
166
- package__ankhorage_paradox -.-> module_src_analyze_semantic_collectSourceFiles_ts
167
- module_src_analyze_semantic_collectSourceFiles_ts --> module_src_analyze_semantic_model_ts
168
- module_src_analyze_semantic_collectSourceFiles_ts --> module_src_analyze_semantic_utils_ts
169
- module_src_analyze_semantic_createTypeScriptProgram_ts["src/analyze/semantic/createTypeScriptProgram.ts"]
170
- package__ankhorage_paradox -.-> module_src_analyze_semantic_createTypeScriptProgram_ts
171
- module_src_analyze_semantic_createTypeScriptProgram_ts --> module_src_analyze_semantic_model_ts
172
- module_src_analyze_semantic_createTypeScriptProgram_ts --> module_src_analyze_semantic_utils_ts
173
- module_src_analyze_semantic_docBlocks_ts["src/analyze/semantic/docBlocks.ts"]
174
- package__ankhorage_paradox -.-> module_src_analyze_semantic_docBlocks_ts
175
- module_src_analyze_semantic_docBlocks_ts --> module_src_analyze_semantic_model_ts
176
- module_src_analyze_semantic_docBlocks_ts --> module_src_analyze_semantic_tagRegistry_ts
177
- module_src_analyze_semantic_docBlocks_ts --> module_src_analyze_semantic_utils_ts
178
- module_src_analyze_semantic_exports_ts["src/analyze/semantic/exports.ts"]
179
- package__ankhorage_paradox -.-> module_src_analyze_semantic_exports_ts
180
- module_src_analyze_semantic_exports_ts --> module_src_analyze_semantic_isReactComponent_ts
181
- module_src_analyze_semantic_exports_ts --> module_src_analyze_semantic_model_ts
182
- module_src_analyze_semantic_exports_ts --> module_src_analyze_semantic_paradoxComment_ts
183
- module_src_analyze_semantic_exports_ts --> module_src_analyze_semantic_utils_ts
184
- module_src_analyze_semantic_graphs_ts["src/analyze/semantic/graphs.ts"]
185
- package__ankhorage_paradox -.-> module_src_analyze_semantic_graphs_ts
186
- module_src_analyze_semantic_graphs_ts --> module_src_analyze_semantic_exports_ts
187
- module_src_analyze_semantic_graphs_ts --> module_src_analyze_semantic_model_ts
188
- module_src_analyze_semantic_graphs_ts --> module_src_analyze_semantic_utils_ts
189
- module_src_analyze_semantic_isReactComponent_ts["src/analyze/semantic/isReactComponent.ts"]
190
- package__ankhorage_paradox -.-> module_src_analyze_semantic_isReactComponent_ts
191
- module_src_analyze_semantic_model_ts["src/analyze/semantic/model.ts"]
192
- package__ankhorage_paradox -.-> module_src_analyze_semantic_model_ts
193
- module_src_analyze_semantic_paradoxComment_ts["src/analyze/semantic/paradoxComment.ts"]
194
- package__ankhorage_paradox -.-> module_src_analyze_semantic_paradoxComment_ts
195
- module_src_analyze_semantic_tagRegistry_ts["src/analyze/semantic/tagRegistry.ts"]
196
- package__ankhorage_paradox -.-> module_src_analyze_semantic_tagRegistry_ts
197
- module_src_analyze_semantic_utils_ts["src/analyze/semantic/utils.ts"]
198
- package__ankhorage_paradox -.-> module_src_analyze_semantic_utils_ts
199
- module_src_analyze_sequenceScenarios_ts["src/analyze/sequenceScenarios.ts"]
200
- package__ankhorage_paradox -.-> module_src_analyze_sequenceScenarios_ts
201
- module_src_analyze_sequenceScenarios_ts --> module_src_analyze_semantic_utils_ts
202
- module_src_analyze_sequenceScenarios_ts --> module_src_analyze_types_ts
203
- module_src_analyze_sequenceScenarios_ts --> module_src_analyze_usage_ts
204
- module_src_analyze_sequenceScenarios_ts --> module_src_analyze_utils_getParadoxComment_ts
205
- module_src_analyze_sequenceScenarios_ts --> module_src_analyze_utils_parseParadoxComment_ts
206
- module_src_analyze_sourceFunctions_ts["src/analyze/sourceFunctions.ts"]
207
- package__ankhorage_paradox -.-> module_src_analyze_sourceFunctions_ts
208
- module_src_analyze_sourceFunctions_ts --> module_src_analyze_types_ts
209
- module_src_analyze_sourceFunctions_ts --> module_src_analyze_utils_getParadoxComment_ts
210
- module_src_analyze_sourceFunctions_ts --> module_src_analyze_utils_parseParadoxComment_ts
211
- module_src_analyze_types_ts["src/analyze/types.ts"]
212
- package__ankhorage_paradox -.-> module_src_analyze_types_ts
213
- module_src_analyze_usage_ts["src/analyze/usage.ts"]
214
- package__ankhorage_paradox -.-> module_src_analyze_usage_ts
215
- module_src_analyze_usage_ts --> module_src_analyze_types_ts
216
- module_src_analyze_utils_getComponentPropsType_ts["src/analyze/utils/getComponentPropsType.ts"]
217
- package__ankhorage_paradox -.-> module_src_analyze_utils_getComponentPropsType_ts
218
- module_src_analyze_utils_getExportMetadata_ts["src/analyze/utils/getExportMetadata.ts"]
219
- package__ankhorage_paradox -.-> module_src_analyze_utils_getExportMetadata_ts
220
- module_src_analyze_utils_getExportMetadata_ts --> module_src_analyze_types_ts
221
- module_src_analyze_utils_getExportMetadata_ts --> module_src_analyze_utils_getParadoxComment_ts
222
- module_src_analyze_utils_getExportMetadata_ts --> module_src_analyze_utils_parseParadoxComment_ts
223
- module_src_analyze_utils_getParadoxComment_ts["src/analyze/utils/getParadoxComment.ts"]
224
- package__ankhorage_paradox -.-> module_src_analyze_utils_getParadoxComment_ts
225
- module_src_analyze_utils_getPropsFromType_ts["src/analyze/utils/getPropsFromType.ts"]
226
- package__ankhorage_paradox -.-> module_src_analyze_utils_getPropsFromType_ts
227
- module_src_analyze_utils_getPropsFromType_ts --> module_src_analyze_types_ts
228
- module_src_analyze_utils_getPropsFromType_ts --> module_src_analyze_utils_getParadoxComment_ts
229
- module_src_analyze_utils_getPropsFromType_ts --> module_src_analyze_utils_parseParadoxComment_ts
230
- module_src_analyze_utils_isReactComponent_ts["src/analyze/utils/isReactComponent.ts"]
231
- package__ankhorage_paradox -.-> module_src_analyze_utils_isReactComponent_ts
232
- module_src_analyze_utils_parseParadoxComment_ts["src/analyze/utils/parseParadoxComment.ts"]
233
- package__ankhorage_paradox -.-> module_src_analyze_utils_parseParadoxComment_ts
234
- module_src_analyze_utils_resolveExportSymbol_ts["src/analyze/utils/resolveExportSymbol.ts"]
235
- package__ankhorage_paradox -.-> module_src_analyze_utils_resolveExportSymbol_ts
236
- module_src_cli_ts["src/cli.ts"]
237
- package__ankhorage_paradox -.-> module_src_cli_ts
238
- module_src_cli_ts --> module_src_analyze_analyze_ts
239
- module_src_cli_ts --> module_src_model_buildModel_ts
240
- module_src_cli_ts --> module_src_paths_policy_ts
241
- module_src_cli_ts --> module_src_render_render_ts
242
- module_src_cli_ts --> module_src_write_write_ts
243
- module_src_config_defineParadoxConfig_ts["src/config/defineParadoxConfig.ts"]
244
- package__ankhorage_paradox -.-> module_src_config_defineParadoxConfig_ts
245
- module_src_config_defineParadoxConfig_ts --> module_src_config_types_ts
246
- module_src_config_types_ts["src/config/types.ts"]
247
- package__ankhorage_paradox -.-> module_src_config_types_ts
248
- module_src_doc_tags_registry_ts["src/doc-tags/registry.ts"]
249
- package__ankhorage_paradox -.-> module_src_doc_tags_registry_ts
250
- module_src_index_ts["src/index.ts"]
251
- module_src_model_buildModel_ts["src/model/buildModel.ts"]
252
- package__ankhorage_paradox -.-> module_src_model_buildModel_ts
253
- module_src_model_buildModel_ts --> module_src_model_types_ts
254
- module_src_model_types_ts["src/model/types.ts"]
255
- package__ankhorage_paradox -.-> module_src_model_types_ts
256
- module_src_paths_policy_ts["src/paths/policy.ts"]
257
- package__ankhorage_paradox -.-> module_src_paths_policy_ts
258
- module_src_paths_policy_ts --> module_src_config_types_ts
259
- module_src_render_render_ts["src/render/render.ts"]
260
- package__ankhorage_paradox -.-> module_src_render_render_ts
261
- module_src_render_render_ts --> module_src_model_types_ts
262
- module_src_render_render_ts --> module_src_render_renderers_badges_ts
263
- module_src_render_render_ts --> module_src_render_renderers_diagrams_ts
264
- module_src_render_render_ts --> module_src_render_renderers_html_ts
265
- module_src_render_render_ts --> module_src_render_renderers_markdown_ts
266
- module_src_render_render_ts --> module_src_render_types_ts
267
- module_src_render_renderers_badges_ts["src/render/renderers/badges.ts"]
268
- package__ankhorage_paradox -.-> module_src_render_renderers_badges_ts
269
- module_src_render_renderers_badges_ts --> module_src_model_types_ts
270
- module_src_render_renderers_badges_ts --> module_src_render_types_ts
271
- module_src_render_renderers_diagrams_ts["src/render/renderers/diagrams.ts"]
272
- package__ankhorage_paradox -.-> module_src_render_renderers_diagrams_ts
273
- module_src_render_renderers_diagrams_ts --> module_src_model_types_ts
274
- module_src_render_renderers_diagrams_ts --> module_src_render_types_ts
275
- module_src_render_renderers_html_ts["src/render/renderers/html.ts"]
276
- package__ankhorage_paradox -.-> module_src_render_renderers_html_ts
277
- module_src_render_renderers_html_ts --> module_src_model_types_ts
278
- module_src_render_renderers_html_ts --> module_src_render_types_ts
279
- module_src_render_renderers_markdown_ts["src/render/renderers/markdown.ts"]
280
- package__ankhorage_paradox -.-> module_src_render_renderers_markdown_ts
281
- module_src_render_renderers_markdown_ts --> module_src_model_types_ts
282
- module_src_render_renderers_markdown_ts --> module_src_render_types_ts
283
- module_src_render_types_ts["src/render/types.ts"]
284
- package__ankhorage_paradox -.-> module_src_render_types_ts
285
- module_src_render_types_ts --> module_src_model_types_ts
286
- module_src_write_write_ts["src/write/write.ts"]
287
- package__ankhorage_paradox -.-> module_src_write_write_ts
288
- module_src_write_write_ts --> module_src_config_types_ts
289
- module_src_write_write_ts --> module_src_render_types_ts
290
- ```
291
-
292
- </details>
293
-
294
102
  ## Public API
295
103
 
296
104
  ### Config
package/dist/render/renderers/markdown.js CHANGED
@@ -37,7 +37,6 @@ function renderReadme(model, outputDir, badges, diagrams) {
37
37
  renderConfiguration(lines, model);
38
38
  }
39
39
  renderGeneratedDocumentation(lines, outputDir, diagrams);
40
- renderArchitecturePreview(lines, diagrams);
41
40
  renderReadmeApi(lines, model);
42
41
  return `${lines.join('\n').trimEnd()}\n`;
43
42
  }
@@ -116,17 +115,6 @@ function renderGeneratedDocumentation(lines, outputDir, diagrams) {
116
115
  }
117
116
  lines.push('');
118
117
  }
119
- function renderArchitecturePreview(lines, diagrams) {
120
- lines.push('## Architecture preview', '');
121
- if (diagrams.length > 0) {
122
- lines.push('<details>');
123
- lines.push('<summary>Architecture overview</summary>', '');
124
- lines.push('```mermaid');
125
- lines.push(diagrams[0]?.content.trimEnd() ?? '');
126
- lines.push('```', '');
127
- lines.push('</details>', '');
128
- }
129
- }
130
118
  function renderReadmeApi(lines, model) {
131
119
  const groups = getReadmeGroups(model);
132
120
  if (groups.length === 0)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ankhorage/paradox",
3
- "version": "0.1.8",
3
+ "version": "0.1.9",
4
4
  "description": "Deterministic documentation generator for TypeScript packages.",
5
5
  "license": "MIT",
6
6
  "publishConfig": {