@ankhorage/paradox 0.1.1 → 0.1.3

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## 0.1.3
+
+### Patch Changes
+
+- 919d454: Render README CLI entries as per-command accordions and show sequence diagrams directly inside the expanded command section.
+
+## 0.1.2
+
+### Patch Changes
+
+- 9dc0fd2: Add sequence diagram of bin script to README.md
+
 ## 0.1.1
 
 ### Patch Changes

package/README.md

@@ -3,7 +3,7 @@
 
 # @ankhorage/paradox
 
-![license: MIT](./paradox/badges/license.svg) ![npm: v0.1.0](./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)
+![license: MIT](./paradox/badges/license.svg) ![npm: v0.1.2](./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)
 
 Deterministic documentation generator for TypeScript packages.
 
@@ -15,7 +15,8 @@ bunx @ankhorage/paradox
 
 ## CLI
 
-### paradox
+<details>
+<summary>paradox</summary>
 
 Runs the Paradox CLI.
 
@@ -27,6 +28,42 @@ and writes them to the configured output directory.
 bunx @ankhorage/paradox
 ```
 
+Diagram: [paradox sequence](./paradox/diagrams/sequences/paradox.mmd)
+
+```mermaid
+sequenceDiagram
+  participant participant_analyze as analyze
+  participant participant_buildModel as buildModel
+  participant participant_dirname as dirname
+  participant participant_findParadoxConfigFile as findParadoxConfigFile
+  participant participant_loadParadoxConfig as loadParadoxConfig
+  participant participant_main as main
+  participant participant_render as render
+  participant participant_resolveOutputRoot as resolveOutputRoot
+  participant participant_resolvePackageRoot as resolvePackageRoot
+  participant participant_write as write
+  participant_main->>participant_findParadoxConfigFile: findParadoxConfigFile()
+  participant_findParadoxConfigFile-->>participant_main: return
+  participant_main->>participant_dirname: dirname()
+  participant_dirname-->>participant_main: return
+  participant_main->>participant_loadParadoxConfig: loadParadoxConfig()
+  participant_loadParadoxConfig-->>participant_main: return
+  participant_main->>participant_resolvePackageRoot: resolvePackageRoot()
+  participant_resolvePackageRoot-->>participant_main: return
+  participant_main->>participant_resolveOutputRoot: resolveOutputRoot()
+  participant_resolveOutputRoot-->>participant_main: return
+  participant_main->>participant_analyze: analyze()
+  participant_analyze-->>participant_main: return
+  participant_main->>participant_buildModel: buildModel()
+  participant_buildModel-->>participant_main: return
+  participant_main->>participant_render: render()
+  participant_render-->>participant_main: return
+  participant_main->>participant_write: write()
+  participant_write-->>participant_main: return
+```
+
+</details>
+
 ## Documentation Tags
 
 <details>
@@ -82,6 +119,7 @@ export default defineParadoxConfig({
 - [Architecture overview](./paradox/diagrams/architecture-overview.mmd)
 - [Module relationships](./paradox/diagrams/module-relationships.mmd)
 - [Export graph](./paradox/diagrams/export-graph.mmd)
+- [paradox sequence](./paradox/diagrams/sequences/paradox.mmd)
 
 ## Architecture preview
 

package/dist/render/renderers/diagrams.js

@@ -1,5 +1,6 @@
 const MAX_SEQUENCE_CALL_EDGES = 12;
 const MAX_SEQUENCE_PARTICIPANTS = 8;
+const MAX_BIN_SEQUENCE_PARTICIPANTS = 12;
 /***
  * Generates deterministic Mermaid diagrams for the documentation app.
  */
@@ -84,6 +85,31 @@ function renderSequenceArtifacts(model) {
     });
 }
 function renderSequenceScenario(model, scenario) {
+    if (scenario.kind === 'bin') {
+        return renderBinSequenceScenario(model, scenario);
+    }
+    return renderNestedSequenceScenario(model, scenario);
+}
+function renderBinSequenceScenario(model, scenario) {
+    const callEdges = collectDirectCallEdges(model.graphs.calls, scenario.symbolName);
+    const participants = collectSequenceParticipants(callEdges);
+    if (callEdges.length === 0)
+        return null;
+    if (participants.length > MAX_BIN_SEQUENCE_PARTICIPANTS)
+        return null;
+    const lines = ['sequenceDiagram'];
+    for (const participant of participants) {
+        lines.push(`  participant ${toMermaidId(`participant-${participant}`)} as ${escapeLabel(participant)}`);
+    }
+    for (const edge of callEdges) {
+        const fromId = toMermaidId(`participant-${edge.fromSymbol}`);
+        const toId = toMermaidId(`participant-${edge.toSymbol}`);
+        lines.push(`  ${fromId}->>${toId}: ${formatCallLabel(edge.callExpression)}`);
+        lines.push(`  ${toId}-->>${fromId}: return`);
+    }
+    return `${lines.join('\n')}\n`;
+}
+function renderNestedSequenceScenario(model, scenario) {
     const lines = ['sequenceDiagram'];
     const reachableEdges = collectReachableCallEdges(model.graphs.calls, scenario.symbolName);
     const participants = collectSequenceParticipants(reachableEdges);
@@ -99,6 +125,9 @@ function renderSequenceScenario(model, scenario) {
     renderCallFlow(lines, reachableEdges, scenario.symbolName);
     return `${lines.join('\n')}\n`;
 }
+function collectDirectCallEdges(callEdges, root) {
+    return callEdges.filter((edge) => edge.fromSymbol === root);
+}
 function collectReachableCallEdges(callEdges, root) {
     const outgoing = groupCallsBySource(callEdges);
     const visited = new Set();

package/dist/render/renderers/markdown.js

@@ -49,7 +49,8 @@ function renderCliScenarios(lines, model, outputDir, diagrams) {
         return;
     lines.push('## CLI', '');
     for (const scenario of scenarios) {
-        lines.push(`### ${scenario.name}`, '');
+        lines.push('<details>');
+        lines.push(`<summary>${scenario.name}</summary>`, '');
         if (scenario.description !== null) {
             lines.push(scenario.description, '');
         }
@@ -61,14 +62,12 @@ function renderCliScenarios(lines, model, outputDir, diagrams) {
         }
         const diagram = findScenarioDiagram(diagrams, scenario);
         if (diagram !== undefined) {
-            lines.push('<details>');
-            lines.push(`<summary>${scenario.name} sequence</summary>`, '');
             lines.push(`Diagram: [${diagram.title}](./${outputDir}/${diagram.path})`, '');
             lines.push('```mermaid');
             lines.push(diagram.content.trimEnd());
             lines.push('```', '');
-            lines.push('</details>', '');
         }
+        lines.push('</details>', '');
     }
 }
 function findScenarioDiagram(diagrams, scenario) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ankhorage/paradox",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "Deterministic documentation generator for TypeScript packages.",
   "license": "MIT",
   "publishConfig": {