@ankhorage/paradox 0.0.8 → 0.0.10

package/dist/render/renderers/markdown.js

@@ -26,27 +26,37 @@ function renderReadme(model, outputDir, badges, diagrams) {
         }
         lines.push('```', '');
     }
-    if (model.config !== null) {
+    const { config } = model;
+    if (config !== null) {
         lines.push('## Configuration', '');
-        lines.push(`Create a \`${model.config.configFile}\` file:`, '');
+        lines.push(`Create a \`${config.configFile}\` file:`, '');
         lines.push('```ts');
-        if (model.config.factoryName !== null) {
-            lines.push(`import { ${model.config.factoryName} } from '${model.packageId}';`);
+        if (config.factoryName !== null) {
+            lines.push(`import { ${config.factoryName} } from '${model.packageId}';`);
             lines.push('');
-            lines.push(`export default ${model.config.factoryName}({`);
+            lines.push(`export default ${config.factoryName}({`);
             lines.push('  // ...');
             lines.push('});');
         }
         else {
-            lines.push(`import type { ${model.config.exportName} } from '${model.packageId}';`);
+            lines.push(`import type { ${config.exportName} } from '${model.packageId}';`);
             lines.push('');
             lines.push('const config = {');
             lines.push('  // ...');
-            lines.push(`} satisfies ${model.config.exportName};`);
+            lines.push(`} satisfies ${config.exportName};`);
             lines.push('');
             lines.push('export default config;');
         }
         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('');
+        }
     }
     lines.push('## Generated documentation', '');
     lines.push(`- [Interactive documentation app](./${outputDir}/index.html)`);
@@ -144,6 +154,20 @@ function renderComponents(model) {
 function escapeTableCell(value) {
     return value.replaceAll('|', '\\|');
 }
+function flattenConfigMembers(members, prefix = '') {
+    return members.flatMap((member) => {
+        const path = prefix ? `${prefix}.${member.name}` : member.name;
+        const current = {
+            path,
+            type: member.type,
+            required: member.required,
+            description: member.description,
+            defaultValue: member.defaultValue,
+        };
+        const children = member.children ? flattenConfigMembers(member.children, path) : [];
+        return [current, ...children];
+    });
+}
 function badgeLabel(model, badgePath) {
     const fileName = badgePath.split('/').pop();
     if (!fileName) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ankhorage/paradox",
-  "version": "0.0.8",
+  "version": "0.0.10",
   "description": "Deterministic documentation generator for TypeScript packages.",
   "license": "MIT",
   "publishConfig": {
@@ -14,6 +14,14 @@
     "type": "git",
     "url": "git+https://github.com/ankhorage/paradox.git"
   },
+  "keywords": [
+    "typescript",
+    "documentation",
+    "readme-generator",
+    "static-analysis",
+    "ts-morph",
+    "developer-tools"
+  ],
   "type": "module",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -39,10 +47,11 @@
     "changeset:status": "changeset status --since=origin/main",
     "docs": "bun src/cli.ts",
     "docs:bunx": "bunx @ankhorage/paradox",
-    "format": "prettier --write .",
-    "format:check": "prettier --check .",
-    "lint": "eslint . --max-warnings=0",
-    "lint:fix": "eslint . --fix --max-warnings=0",
+    "format": "ankhorage-prettier --write .",
+    "format:check": "ankhorage-prettier --check .",
+    "knip": "ankhorage-knip",
+    "lint": "ankhorage-eslint . --max-warnings=0",
+    "lint:fix": "ankhorage-eslint . --fix --max-warnings=0",
     "prepack": "bun run build",
     "test": "bun test",
     "typecheck": "bun x tsc --noEmit -p tsconfig.json",
@@ -52,7 +61,7 @@
     "ts-morph": "^24.0.0"
   },
   "devDependencies": {
-    "@ankhorage/devtools": "^1.0.0",
+    "@ankhorage/devtools": "^1.0.5",
     "@changesets/cli": "^2.31.0",
     "@types/bun": "^1.3.13",
     "typescript": "^5.6.3"