@ankhorage/paradox 0.0.10 → 0.1.1

package/dist/render/renderers/markdown.js

@@ -9,7 +9,13 @@ export function renderMarkdown({ badges, diagrams, model, outputDir, }) {
     };
 }
 function renderReadme(model, outputDir, badges, diagrams) {
-    const lines = [`# ${model.packageName}`, ''];
+    const lines = [
+        '<!-- markdownlint-disable MD013 MD033 -->',
+        '<!-- This file is generated by Paradox. Do not edit manually. -->',
+        '',
+        `# ${model.packageName}`,
+        '',
+    ];
     if (badges.length > 0) {
         lines.push(badges
             .map((badge) => `![${badgeLabel(model, badge.path)}](./${outputDir}/${badge.path})`)
@@ -19,45 +25,100 @@ function renderReadme(model, outputDir, badges, diagrams) {
         lines.push(model.description, '');
     }
     if (model.usage !== null) {
-        lines.push('## Usage', '');
+        lines.push('## Installation', '');
         lines.push('```bash');
         for (const command of model.usage.commands) {
             lines.push(command.command);
         }
         lines.push('```', '');
     }
-    const { config } = model;
-    if (config !== null) {
-        lines.push('## Configuration', '');
-        lines.push(`Create a \`${config.configFile}\` file:`, '');
-        lines.push('```ts');
-        if (config.factoryName !== null) {
-            lines.push(`import { ${config.factoryName} } from '${model.packageId}';`);
-            lines.push('');
-            lines.push(`export default ${config.factoryName}({`);
-            lines.push('  // ...');
-            lines.push('});');
+    renderCliScenarios(lines, model, outputDir, diagrams);
+    renderDocumentationTags(lines);
+    if (model.config?.isReadme) {
+        renderConfiguration(lines, model);
+    }
+    renderGeneratedDocumentation(lines, outputDir, diagrams);
+    renderArchitecturePreview(lines, diagrams);
+    renderPathResolution(lines);
+    renderReadmeApi(lines, model);
+    return `${lines.join('\n').trimEnd()}\n`;
+}
+function renderCliScenarios(lines, model, outputDir, diagrams) {
+    const scenarios = model.sequenceScenarios.filter((scenario) => scenario.kind === 'bin' && scenario.isReadme);
+    if (scenarios.length === 0)
+        return;
+    lines.push('## CLI', '');
+    for (const scenario of scenarios) {
+        lines.push(`### ${scenario.name}`, '');
+        if (scenario.description !== null) {
+            lines.push(scenario.description, '');
         }
-        else {
-            lines.push(`import type { ${config.exportName} } from '${model.packageId}';`);
-            lines.push('');
-            lines.push('const config = {');
-            lines.push('  // ...');
-            lines.push(`} satisfies ${config.exportName};`);
-            lines.push('');
-            lines.push('export default config;');
+        const command = model.usage?.commands.find((item) => item.name === scenario.name);
+        if (command !== undefined) {
+            lines.push('```bash');
+            lines.push(command.command);
+            lines.push('```', '');
         }
-        lines.push('```', '');
-        if (config.members.length > 0) {
-            lines.push('### Configuration options', '');
-            lines.push('| Field | Type | Required | Default | Description |');
-            lines.push('| --- | --- | --- | --- | --- |');
-            for (const configMember of flattenConfigMembers(config.members)) {
-                lines.push(`| ${escapeTableCell(configMember.path)} | \`${escapeTableCell(configMember.type)}\` | ${configMember.required ? 'yes' : 'no'} | ${escapeTableCell(configMember.defaultValue ?? '')} | ${escapeTableCell(configMember.description ?? '')} |`);
-            }
-            lines.push('');
+        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>', '');
         }
     }
+}
+function findScenarioDiagram(diagrams, scenario) {
+    return diagrams.find((diagram) => diagram.path === `diagrams/sequences/${toFileStem(scenario.name)}.mmd`);
+}
+function renderDocumentationTags(lines) {
+    lines.push('## Documentation Tags', '');
+    for (const tag of DOCUMENTATION_TAGS) {
+        lines.push('<details>');
+        lines.push(`<summary>@${tag.name}</summary>`, '');
+        lines.push(tag.description, '');
+        lines.push('</details>', '');
+    }
+}
+function renderConfiguration(lines, model) {
+    const { config } = model;
+    if (config === null)
+        return;
+    lines.push('## Configuration', '');
+    lines.push(`Create a \`${config.configFile}\` file:`, '');
+    lines.push('```ts');
+    if (config.factoryName !== null) {
+        lines.push(`import { ${config.factoryName} } from '${model.packageId}';`);
+        lines.push('');
+        lines.push(`export default ${config.factoryName}({`);
+        lines.push('  // ...');
+        lines.push('});');
+    }
+    else {
+        lines.push(`import type { ${config.exportName} } from '${model.packageId}';`);
+        lines.push('');
+        lines.push('const config = {');
+        lines.push('  // ...');
+        lines.push(`} satisfies ${config.exportName};`);
+        lines.push('');
+        lines.push('export default config;');
+    }
+    lines.push('```', '');
+    if (config.members.length > 0) {
+        lines.push('<details>');
+        lines.push('<summary>Configuration options</summary>', '');
+        lines.push('| Field | Type | Required | Default | Description |');
+        lines.push('| --- | --- | --- | --- | --- |');
+        for (const configMember of flattenConfigMembers(config.members)) {
+            lines.push(`| ${escapeTableCell(configMember.path)} | \`${escapeTableCell(configMember.type)}\` | ${configMember.required ? 'yes' : 'no'} | ${renderDefault(configMember.defaultValue)} | ${escapeTableCell(configMember.description ?? '')} |`);
+        }
+        lines.push('', '</details>', '');
+    }
+}
+function renderGeneratedDocumentation(lines, outputDir, diagrams) {
     lines.push('## Generated documentation', '');
     lines.push(`- [Interactive documentation app](./${outputDir}/index.html)`);
     lines.push(`- [Public API reference](./${outputDir}/exports.md)`);
@@ -66,12 +127,19 @@ function renderReadme(model, outputDir, badges, diagrams) {
         lines.push(`- [${diagram.title}](./${outputDir}/${diagram.path})`);
     }
     lines.push('');
+}
+function renderArchitecturePreview(lines, diagrams) {
     lines.push('## Architecture preview', '');
     if (diagrams.length > 0) {
+        lines.push('<details>');
+        lines.push('<summary>Architecture overview</summary>', '');
         lines.push('```mermaid');
-        lines.push(diagrams[0].content.trimEnd());
+        lines.push(diagrams[0]?.content.trimEnd() ?? '');
         lines.push('```', '');
+        lines.push('</details>', '');
     }
+}
+function renderPathResolution(lines) {
     lines.push('## Path resolution', '');
     lines.push('- Config discovery: searches upward from `process.cwd()` for `paradox.config.ts/js/mjs/cjs` (required; no fallback).');
     lines.push('- Package root: defaults to the directory containing `paradox.config.*`; `package.root` (when relative) resolves relative to that directory.');
@@ -79,22 +147,131 @@ function renderReadme(model, outputDir, badges, diagrams) {
     lines.push('- Modes:');
     lines.push('  - `safe`: writes generated artifacts only under the output directory');
     lines.push('  - `write`: additionally updates `<packageRoot>/README.md`', '');
-    if (model.exports.length > 0) {
-        lines.push('## Public API', '');
-        for (const item of model.exports) {
-            lines.push(`### ${item.name}`, '');
-            lines.push(item.description ?? `\`${item.kind}\` export.`, '');
-            lines.push(`- Kind: \`${item.kind}\``);
-            lines.push(`- Module: \`${item.modulePath}\``);
-            lines.push(`- Source: \`${item.sourceLocation.filePath}:${item.sourceLocation.line}:${item.sourceLocation.column}\``);
-            lines.push(`- Export paths: ${item.exportPaths.map((path) => `\`${path}\``).join(', ')}`);
-            if (item.relatedSymbols.length > 0) {
-                lines.push(`- Related symbols: ${item.relatedSymbols.map((symbol) => `\`${symbol}\``).join(', ')}`);
+}
+function renderReadmeApi(lines, model) {
+    const groups = getReadmeGroups(model);
+    if (groups.length === 0)
+        return;
+    lines.push('## Public API', '');
+    for (const group of groups) {
+        lines.push(`### ${group.title}`, '');
+        for (const item of group.items) {
+            if (item.kind === 'component') {
+                renderComponentAccordion(lines, item.component, item.exportEntry);
+            }
+            else {
+                renderExportAccordion(lines, item.exportEntry);
             }
-            lines.push('');
         }
     }
-    return `${lines.join('\n').trimEnd()}\n`;
+}
+function renderComponentAccordion(lines, component, exportEntry) {
+    lines.push('<details>');
+    lines.push(`<summary>${component.name}</summary>`, '');
+    renderSignature(lines, exportEntry);
+    if (component.description)
+        lines.push(component.description, '');
+    renderExamples(lines, component.examples);
+    if (exportEntry && exportEntry.relatedSymbols.length > 0) {
+        lines.push(`Related types: ${exportEntry.relatedSymbols.map((symbol) => `\`${symbol}\``).join(', ')}`, '');
+    }
+    if (component.props.length > 0) {
+        lines.push('<details>');
+        lines.push('<summary>Props</summary>', '');
+        lines.push('| Prop | Type | Required | Default | Description |');
+        lines.push('| --- | --- | --- | --- | --- |');
+        for (const prop of component.props) {
+            lines.push(`| ${escapeTableCell(prop.name)} | \`${escapeTableCell(prop.type)}\` | ${prop.required ? 'yes' : 'no'} | ${renderDefault(prop.defaultValue)} | ${escapeTableCell(prop.description ?? '')} |`);
+        }
+        lines.push('', '</details>', '');
+    }
+    lines.push('</details>', '');
+}
+function renderExportAccordion(lines, item) {
+    lines.push('<details>');
+    lines.push(`<summary>${item.name}</summary>`, '');
+    renderSignature(lines, item);
+    lines.push(item.description ?? `\`${item.kind}\` export.`, '');
+    renderExamples(lines, item.examples);
+    lines.push(`Module: \`${item.modulePath}\``);
+    lines.push(`Source: \`${item.sourceLocation.filePath}:${item.sourceLocation.line}:${item.sourceLocation.column}\``);
+    if (item.relatedSymbols.length > 0) {
+        lines.push(`Related symbols: ${item.relatedSymbols.map((symbol) => `\`${symbol}\``).join(', ')}`);
+    }
+    lines.push('', '</details>', '');
+}
+function renderSignature(lines, item) {
+    const signature = item?.signatures[0]?.label;
+    if (!signature)
+        return;
+    lines.push('```ts');
+    lines.push(`${item.name}${signature}`);
+    lines.push('```', '');
+}
+function renderExamples(lines, examples) {
+    for (const example of examples) {
+        if (example.title)
+            lines.push(`#### ${example.title}`, '');
+        lines.push(`\`\`\`${example.language ?? ''}`);
+        lines.push(example.code);
+        lines.push('```', '');
+    }
+}
+function getReadmeGroups(model) {
+    const exportsByName = new Map(model.exports.map((entry) => [entry.name, entry]));
+    const componentNames = new Set(model.components.map((component) => component.name));
+    const groups = new Map();
+    for (const component of model.components.filter((entry) => entry.isReadme)) {
+        addReadmeItem(groups, getReadmeCategory(component.modulePath, component.name), {
+            kind: 'component',
+            component,
+            exportEntry: exportsByName.get(component.name),
+        });
+    }
+    for (const item of model.exports.filter((entry) => entry.isReadme)) {
+        if (componentNames.has(item.name))
+            continue;
+        addReadmeItem(groups, getReadmeCategory(item.modulePath, item.name), {
+            kind: 'export',
+            exportEntry: item,
+        });
+    }
+    return CATEGORY_ORDER.flatMap((title) => {
+        const items = groups.get(title);
+        if (!items || items.length === 0)
+            return [];
+        return [{ title, items: sortReadmeItems(items) }];
+    });
+}
+function addReadmeItem(groups, title, item) {
+    const existing = groups.get(title) ?? [];
+    existing.push(item);
+    groups.set(title, existing);
+}
+function sortReadmeItems(items) {
+    return [...items].sort((left, right) => getReadmeItemName(left).localeCompare(getReadmeItemName(right)));
+}
+function getReadmeItemName(item) {
+    return item.kind === 'component' ? item.component.name : item.exportEntry.name;
+}
+function getReadmeCategory(modulePath, name) {
+    if (modulePath.includes('/config/'))
+        return 'Configuration';
+    if (modulePath.includes('/primitives/'))
+        return 'Primitives';
+    if (modulePath.includes('/components/'))
+        return 'Components';
+    if (modulePath.includes('/patterns/'))
+        return 'Patterns';
+    if (modulePath.includes('/layout/'))
+        return 'Layout';
+    if (modulePath.includes('/hooks/') || /^use[A-Z]/.test(name))
+        return 'Hooks';
+    if (modulePath.includes('/utils/'))
+        return 'Utilities';
+    if (modulePath.endsWith('types.ts') || modulePath.includes('/types/'))
+        return 'Types';
+    return 'Utilities';
 }
 function renderExports(model) {
     const lines = ['# Public API', ''];
@@ -141,10 +318,10 @@ function renderComponents(model) {
             lines.push(`Export paths: ${component.exportPaths.map((path) => `\`${path}\``).join(', ')}`, '');
         }
         if (component.props.length > 0) {
-            lines.push('| Prop | Type | Required | Description |');
-            lines.push('| --- | --- | --- | --- |');
+            lines.push('| Prop | Type | Required | Default | Description |');
+            lines.push('| --- | --- | --- | --- | --- |');
             for (const prop of component.props) {
-                lines.push(`| ${escapeTableCell(prop.name)} | \`${escapeTableCell(prop.type)}\` | ${prop.required ? 'yes' : 'no'} | ${escapeTableCell(prop.description ?? '')} |`);
+                lines.push(`| ${escapeTableCell(prop.name)} | \`${escapeTableCell(prop.type)}\` | ${prop.required ? 'yes' : 'no'} | ${renderDefault(prop.defaultValue)} | ${escapeTableCell(prop.description ?? '')} |`);
             }
             lines.push('');
         }
@@ -154,6 +331,9 @@ function renderComponents(model) {
 function escapeTableCell(value) {
     return value.replaceAll('|', '\\|');
 }
+function renderDefault(value) {
+    return value === undefined ? '—' : `\`${escapeTableCell(value)}\``;
+}
 function flattenConfigMembers(members, prefix = '') {
     return members.flatMap((member) => {
         const path = prefix ? `${prefix}.${member.name}` : member.name;
@@ -177,3 +357,34 @@ function badgeLabel(model, badgePath) {
     const badge = model.badges.find((entry) => entry.id === id);
     return badge ? `${badge.label}: ${badge.value}` : badgePath;
 }
+function toFileStem(value) {
+    return value
+        .replace(/([a-z0-9])([A-Z])/g, '$1-$2')
+        .replace(/[^A-Za-z0-9]+/g, '-')
+        .replace(/^-+|-+$/g, '')
+        .toLowerCase();
+}
+const CATEGORY_ORDER = [
+    'Configuration',
+    'Primitives',
+    'Components',
+    'Patterns',
+    'Layout',
+    'Hooks',
+    'Utilities',
+    'Types',
+];
+const DOCUMENTATION_TAGS = [
+    {
+        name: 'readme',
+        description: 'Includes a documentation block or exported symbol in README output.',
+    },
+    {
+        name: 'config',
+        description: 'Marks a type or interface as part of the Paradox configuration model. `@config` alone does not imply README inclusion; use `@config` plus `@readme` for README output.',
+    },
+    {
+        name: 'example',
+        description: 'Adds a titled fenced code example to the generated documentation for a symbol.',
+    },
+];

package/package.json

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