@ankhorage/paradox 0.1.27 → 0.2.0

package/dist/{config/types.d.ts → types/config.d.ts}

@@ -1,5 +1,7 @@
 /***
- * Configuration for running Paradox.
+ * @title Configuration
+ *
+ * Configures Paradox documentation generation for a package.
  *
  * @config
  * @readme
@@ -16,10 +18,6 @@ export interface ParadoxConfig {
     docs?: {
         title?: string;
         description?: string;
-        usage?: {
-            description?: string;
-            entrypoints?: string[];
-        };
     };
     package?: {
         root?: string;

package/dist/write/write.d.ts

@@ -1,5 +1,5 @@
-import type { ParadoxConfig } from '../config/types.js';
 import type { RenderResult } from '../render/types.js';
+import type { ParadoxConfig } from '../types/config.js';
 /***
  * Writes generated documentation artifacts to the configured output paths.
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ankhorage/paradox",
-  "version": "0.1.27",
+  "version": "0.2.0",
   "description": "Deterministic documentation generator for TypeScript packages.",
   "license": "MIT",
   "publishConfig": {
@@ -71,6 +71,7 @@
     "test:standalone": "bun test tests/cli.e2e.test.ts"
   },
   "dependencies": {
+    "@ankhorage/policy": "^0.1.0",
     "@ankhorage/utility": "^1.8.0",
     "ts-morph": "^28.0.0"
   },

package/dist/analyze/readmeCli.d.ts

@@ -1,9 +0,0 @@
-export interface AnalysisReadmeCli {
-    description: string | null;
-    sourcePath: string;
-}
-/***
- * Collects README CLI metadata from the canonical Ankhorage CLI entrypoint when its leading
- * Paradox comment opts into README output with @readme.
- */
-export declare function analyzeReadmeCli(root: string): Promise<AnalysisReadmeCli | null>;

package/dist/analyze/readmeCli.js

@@ -1,33 +0,0 @@
-import { readFile } from 'node:fs/promises';
-import { join } from 'node:path';
-import { getLeadingParadoxComment } from './utils/getLeadingParadoxComment.js';
-const CLI_INDEX_PATH = 'src/cli/index.ts';
-/***
- * Collects README CLI metadata from the canonical Ankhorage CLI entrypoint when its leading
- * Paradox comment opts into README output with @readme.
- */
-export async function analyzeReadmeCli(root) {
-    const filePath = join(root, CLI_INDEX_PATH);
-    let source;
-    try {
-        source = await readFile(filePath, 'utf-8');
-    }
-    catch (error) {
-        if (isMissingPathError(error))
-            return null;
-        throw error;
-    }
-    const comment = getLeadingParadoxComment(source);
-    if (!comment?.parsed.isReadme)
-        return null;
-    return {
-        description: comment.parsed.description,
-        sourcePath: CLI_INDEX_PATH,
-    };
-}
-function isMissingPathError(error) {
-    return (error instanceof Error &&
-        'code' in error &&
-        typeof error.code === 'string' &&
-        error.code === 'ENOENT');
-}

package/dist/analyze/utils/getLeadingParadoxComment.d.ts

@@ -1,10 +0,0 @@
-import { type ParsedParadoxComment } from './parseParadoxComment.js';
-export interface LeadingParadoxComment {
-    parsed: ParsedParadoxComment;
-    start: number;
-    end: number;
-}
-/***
- * Parses a leading Paradox comment from a source file.
- */
-export declare function getLeadingParadoxComment(source: string): LeadingParadoxComment | null;

package/dist/analyze/utils/getLeadingParadoxComment.js

@@ -1,16 +0,0 @@
-import { parseParadoxComment } from './parseParadoxComment.js';
-/***
- * Parses a leading Paradox comment from a source file.
- */
-export function getLeadingParadoxComment(source) {
-    const match = /^\s*(\/\*\*\*[\s\S]*?\*\/)/.exec(source);
-    const comment = match?.[1];
-    if (match === null || comment === undefined)
-        return null;
-    const start = match[0].indexOf(comment);
-    return {
-        parsed: parseParadoxComment(comment),
-        start,
-        end: start + comment.length,
-    };
-}