@shirokuma-library/shirokuma-docs 0.1.0-alpha.10

package/dist/md/utils/tokens.js

@@ -0,0 +1,31 @@
+import { encoding_for_model } from 'tiktoken';
+/**
+ * Estimate token count for text using tiktoken
+ */
+export function estimateTokens(text, model = 'gpt-4') {
+    try {
+        // Get encoding for model
+        const encoding = encoding_for_model(model);
+        const tokens = encoding.encode(text);
+        encoding.free();
+        return tokens.length;
+    }
+    catch (error) {
+        // Fallback to approximate calculation if tiktoken fails
+        // Rough estimate: ~4 characters per token
+        return Math.ceil(text.length / 4);
+    }
+}
+/**
+ * Format token count for display
+ */
+export function formatTokenCount(count) {
+    if (count < 1000) {
+        return `${count}`;
+    }
+    if (count < 1000000) {
+        return `${(count / 1000).toFixed(1)}K`;
+    }
+    return `${(count / 1000000).toFixed(2)}M`;
+}
+//# sourceMappingURL=tokens.js.map

package/dist/md/utils/tokens.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tokens.js","sourceRoot":"","sources":["../../../src/md/utils/tokens.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AAE9C;;GAEG;AACH,MAAM,UAAU,cAAc,CAAC,IAAY,EAAE,QAAgB,OAAO;IAClE,IAAI,CAAC;QACH,yBAAyB;QACzB,MAAM,QAAQ,GAAG,kBAAkB,CAAC,KAAY,CAAC,CAAC;QAClD,MAAM,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACrC,QAAQ,CAAC,IAAI,EAAE,CAAC;QAChB,OAAO,MAAM,CAAC,MAAM,CAAC;IACvB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,wDAAwD;QACxD,0CAA0C;QAC1C,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IACpC,CAAC;AACH,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,gBAAgB,CAAC,KAAa;IAC5C,IAAI,KAAK,GAAG,IAAI,EAAE,CAAC;QACjB,OAAO,GAAG,KAAK,EAAE,CAAC;IACpB,CAAC;IACD,IAAI,KAAK,GAAG,OAAO,EAAE,CAAC;QACpB,OAAO,GAAG,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC;IACzC,CAAC;IACD,OAAO,GAAG,CAAC,KAAK,GAAG,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC;AAC5C,CAAC"}

package/dist/md/validator/index.d.ts

@@ -0,0 +1,40 @@
+import type { Config } from '../types/config.js';
+import type { ValidationResult } from '../types/validation.js';
+/**
+ * Document validator
+ * Validates documents against schemas and rules
+ */
+export declare class Validator {
+    private config;
+    constructor(config: Config);
+    /**
+     * Validates all markdown files in source directory
+     *
+     * Checks documents for:
+     * - Required frontmatter fields
+     * - Frontmatter schema compliance
+     * - Internal links (if no_internal_links enabled)
+     * - Heading depth limits
+     * - Template compliance (if enabled)
+     *
+     * @param sourceDir - Source directory containing markdown files
+     * @returns Validation result with arrays of errors, warnings, and info
+     *
+     * @example
+     * ```typescript
+     * const validator = new Validator(config);
+     * const result = await validator.validate('./docs');
+     * if (result.errors.length > 0) {
+     *   console.error(`Found ${result.errors.length} errors`);
+     * }
+     * ```
+     */
+    validate(sourceDir: string): Promise<ValidationResult>;
+    private validateDocument;
+    private detectInternalLinks;
+    private isInternalLink;
+    private getLineContext;
+    private extractHeadings;
+    private validateTemplateCompliance;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/md/validator/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/md/validator/index.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,KAAK,EAAE,gBAAgB,EAAS,MAAM,wBAAwB,CAAC;AAOtE;;;GAGG;AACH,qBAAa,SAAS;IACR,OAAO,CAAC,MAAM;gBAAN,MAAM,EAAE,MAAM;IAElC;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC;YA0C9C,gBAAgB;IAuF9B,OAAO,CAAC,mBAAmB;IAwC3B,OAAO,CAAC,cAAc;IAetB,OAAO,CAAC,cAAc;IActB,OAAO,CAAC,eAAe;YAqBT,0BAA0B;CA2EzC"}

package/dist/md/validator/index.js

@@ -0,0 +1,299 @@
+import matter from 'gray-matter';
+import * as fs from 'fs/promises';
+import * as path from 'path';
+import { loadTemplate, findMissingHeadings, findUnsubstitutedVariables, templateExists } from '../parser/template.js';
+import { FileCollector } from '../utils/file-collector.js';
+import { DEFAULT_MAX_HEADING_DEPTH } from '../constants.js';
+import { safeRegExp } from '../../utils/sanitize.js';
+/**
+ * Document validator
+ * Validates documents against schemas and rules
+ */
+export class Validator {
+    config;
+    constructor(config) {
+        this.config = config;
+    }
+    /**
+     * Validates all markdown files in source directory
+     *
+     * Checks documents for:
+     * - Required frontmatter fields
+     * - Frontmatter schema compliance
+     * - Internal links (if no_internal_links enabled)
+     * - Heading depth limits
+     * - Template compliance (if enabled)
+     *
+     * @param sourceDir - Source directory containing markdown files
+     * @returns Validation result with arrays of errors, warnings, and info
+     *
+     * @example
+     * ```typescript
+     * const validator = new Validator(config);
+     * const result = await validator.validate('./docs');
+     * if (result.errors.length > 0) {
+     *   console.error(`Found ${result.errors.length} errors`);
+     * }
+     * ```
+     */
+    async validate(sourceDir) {
+        const errors = [];
+        const warnings = [];
+        const info = [];
+        // Collect all markdown files
+        const collector = new FileCollector(this.config);
+        const allFiles = await collector.collect(sourceDir);
+        // Validate each file
+        for (const filePath of allFiles) {
+            const content = await fs.readFile(filePath, 'utf-8');
+            const parsed = matter(content);
+            const document = {
+                path: filePath,
+                frontmatter: parsed.data,
+                content: parsed.content,
+                sections: [],
+            };
+            const issues = await this.validateDocument(document, sourceDir);
+            for (const issue of issues) {
+                if (issue.severity === 'error') {
+                    errors.push(issue);
+                }
+                else if (issue.severity === 'warning') {
+                    warnings.push(issue);
+                }
+                else {
+                    info.push(issue);
+                }
+            }
+        }
+        return {
+            valid: errors.length === 0,
+            errors,
+            warnings,
+            info,
+        };
+    }
+    async validateDocument(document, projectRoot) {
+        const issues = [];
+        // 1. Validate required frontmatter fields
+        for (const field of this.config.validation.required_frontmatter) {
+            if (!(field in document.frontmatter)) {
+                issues.push({
+                    severity: 'error',
+                    message: `Missing required frontmatter field: ${field}`,
+                    file: document.path,
+                    rule: 'required-frontmatter',
+                });
+            }
+        }
+        // 2. Check dependency file existence (PRIORITY 1 - CRITICAL)
+        if (document.frontmatter.depends_on && Array.isArray(document.frontmatter.depends_on)) {
+            for (const dep of document.frontmatter.depends_on) {
+                const depPath = path.join(projectRoot, dep);
+                try {
+                    await fs.access(depPath);
+                }
+                catch {
+                    issues.push({
+                        severity: 'error',
+                        message: `Dependency file not found: ${dep}`,
+                        file: document.path,
+                        rule: 'dependency-exists',
+                    });
+                }
+            }
+        }
+        // 3. Check forbidden patterns
+        if (this.config.validation.forbidden_patterns) {
+            for (const forbiddenPattern of this.config.validation.forbidden_patterns) {
+                const regex = safeRegExp(forbiddenPattern.pattern);
+                if (!regex) {
+                    issues.push({
+                        severity: 'error',
+                        message: `Invalid regex pattern: ${forbiddenPattern.pattern}`,
+                        file: document.path,
+                        rule: 'forbidden-pattern',
+                    });
+                    continue;
+                }
+                if (regex.test(document.content)) {
+                    issues.push({
+                        severity: 'error',
+                        message: forbiddenPattern.message,
+                        file: document.path,
+                        rule: 'forbidden-pattern',
+                    });
+                }
+            }
+        }
+        // 4. Check for internal links (if enabled)
+        if (this.config.validation.no_internal_links) {
+            const internalLinks = this.detectInternalLinks(document.content, document.path);
+            issues.push(...internalLinks);
+        }
+        // 5. Check heading depth
+        const headings = this.extractHeadings(document.content);
+        const maxDepth = DEFAULT_MAX_HEADING_DEPTH;
+        for (const heading of headings) {
+            if (heading.level > maxDepth) {
+                issues.push({
+                    severity: 'warning',
+                    message: `Heading depth ${heading.level} exceeds maximum ${maxDepth}`,
+                    file: document.path,
+                    line: heading.line,
+                    rule: 'max-heading-depth',
+                });
+            }
+        }
+        // 6. Check template compliance (if enabled and template specified)
+        if (this.config.validation.template_compliance?.enabled && document.frontmatter.template) {
+            const templateIssues = await this.validateTemplateCompliance(document);
+            issues.push(...templateIssues);
+        }
+        return issues;
+    }
+    detectInternalLinks(content, filePath) {
+        const issues = [];
+        const lines = content.split('\n');
+        // Regex to match markdown links: [text](url)
+        const linkRegex = /\[([^\]]+)\]\(([^)]+)\)/g;
+        for (let i = 0; i < lines.length; i++) {
+            const line = lines[i];
+            if (!line)
+                continue;
+            let match;
+            while ((match = linkRegex.exec(line)) !== null) {
+                const linkText = match[1];
+                const linkUrl = match[2];
+                // Skip if link text or URL is undefined
+                if (!linkText || !linkUrl)
+                    continue;
+                // Check if it's an internal link (relative path to .md file)
+                const isInternal = this.isInternalLink(linkUrl);
+                if (isInternal) {
+                    // Get surrounding context for better error message
+                    const context = this.getLineContext(line, match.index, linkText, linkUrl);
+                    issues.push({
+                        severity: 'error',
+                        message: `Internal markdown link detected (redundant in LLM context)\n  Link: [${linkText}](${linkUrl})\n  Context: "${context}"\n  Action: Delete this sentence/section - all content is in one file, references are redundant\n  Note: External links (http://, https://) are OK to keep`,
+                        file: filePath,
+                        line: i + 1,
+                        rule: 'no-internal-links',
+                    });
+                }
+            }
+        }
+        return issues;
+    }
+    isInternalLink(url) {
+        // External links (keep these)
+        if (url.startsWith('http://') || url.startsWith('https://')) {
+            return false;
+        }
+        // Internal links (should be removed)
+        // Relative paths, paths starting with /, or .md files
+        if (url.includes('.md') || url.startsWith('../') || url.startsWith('./') || url.startsWith('/')) {
+            return true;
+        }
+        return false;
+    }
+    getLineContext(line, matchIndex, linkText, linkUrl) {
+        // Extract up to 60 characters around the match for context
+        const start = Math.max(0, matchIndex - 20);
+        const end = Math.min(line.length, matchIndex + linkText.length + linkUrl.length + 30);
+        let context = line.substring(start, end).trim();
+        // Add ellipsis if truncated
+        if (start > 0)
+            context = '...' + context;
+        if (end < line.length)
+            context = context + '...';
+        return context;
+    }
+    extractHeadings(content) {
+        const lines = content.split('\n');
+        const headings = [];
+        for (let i = 0; i < lines.length; i++) {
+            const line = lines[i];
+            if (line) {
+                const match = line.match(/^(#{1,6})\s+(.+)$/);
+                if (match && match[1] && match[2]) {
+                    headings.push({
+                        level: match[1].length,
+                        title: match[2].trim(),
+                        line: i + 1,
+                    });
+                }
+            }
+        }
+        return headings;
+    }
+    async validateTemplateCompliance(document) {
+        const issues = [];
+        const templateName = document.frontmatter.template;
+        const config = this.config.validation.template_compliance;
+        if (!config) {
+            return issues;
+        }
+        const severity = config.severity || 'error';
+        // Get templates directory
+        // If templates directory is specified in config, use it
+        // Otherwise, use config directory + templates
+        const templatesDir = this.config.directories.templates
+            ? this.config.directories.templates
+            : path.join(this.config.directories.config, 'templates');
+        // 1. Check template existence
+        const exists = await templateExists(templateName, templatesDir);
+        if (!exists) {
+            issues.push({
+                severity,
+                message: `Template not found: ${templateName}\n  Expected location: ${path.join(templatesDir, templateName + '.md')}`,
+                file: document.path,
+                rule: 'template-exists',
+            });
+            return issues; // Cannot proceed without template
+        }
+        // 2. Load template
+        let template;
+        try {
+            template = await loadTemplate(templateName, templatesDir);
+        }
+        catch (error) {
+            const message = error instanceof Error ? error.message : String(error);
+            issues.push({
+                severity: 'error',
+                message: `Failed to load template: ${message}`,
+                file: document.path,
+                rule: 'template-load',
+            });
+            return issues;
+        }
+        // 3. Check required sections
+        if (config.check_required_sections) {
+            const missingHeadings = findMissingHeadings(document.content, template.requiredHeadings);
+            if (missingHeadings.length > 0) {
+                const headingsList = missingHeadings.map(h => `  - ## ${h}`).join('\n');
+                issues.push({
+                    severity,
+                    message: `Template compliance check failed\n  Template: ${templateName}\n  Missing sections:\n${headingsList}`,
+                    file: document.path,
+                    rule: 'template-required-sections',
+                });
+            }
+        }
+        // 4. Check variable substitution
+        if (config.check_variable_substitution) {
+            const unsubstituted = findUnsubstitutedVariables(document.content);
+            if (unsubstituted.length > 0) {
+                const varList = unsubstituted.map(v => `  - {{${v}}}`).join('\n');
+                issues.push({
+                    severity: severity === 'error' ? 'warning' : severity, // Downgrade to warning for variables
+                    message: `Unsubstituted template variables found\n  Template: ${templateName}\n  Variables:\n${varList}`,
+                    file: document.path,
+                    rule: 'template-variable-substitution',
+                });
+            }
+        }
+        return issues;
+    }
+}
+//# sourceMappingURL=index.js.map

package/dist/md/validator/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/md/validator/index.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,aAAa,CAAC;AACjC,OAAO,KAAK,EAAE,MAAM,aAAa,CAAC;AAClC,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAI7B,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,0BAA0B,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACtH,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EAAE,yBAAyB,EAAE,MAAM,iBAAiB,CAAC;AAC5D,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAErD;;;GAGG;AACH,MAAM,OAAO,SAAS;IACA;IAApB,YAAoB,MAAc;QAAd,WAAM,GAAN,MAAM,CAAQ;IAAG,CAAC;IAEtC;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,KAAK,CAAC,QAAQ,CAAC,SAAiB;QAC9B,MAAM,MAAM,GAAY,EAAE,CAAC;QAC3B,MAAM,QAAQ,GAAY,EAAE,CAAC;QAC7B,MAAM,IAAI,GAAY,EAAE,CAAC;QAEzB,6BAA6B;QAC7B,MAAM,SAAS,GAAG,IAAI,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACjD,MAAM,QAAQ,GAAG,MAAM,SAAS,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAEpD,qBAAqB;QACrB,KAAK,MAAM,QAAQ,IAAI,QAAQ,EAAE,CAAC;YAChC,MAAM,OAAO,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;YACrD,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;YAE/B,MAAM,QAAQ,GAAa;gBACzB,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,MAAM,CAAC,IAAI;gBACxB,OAAO,EAAE,MAAM,CAAC,OAAO;gBACvB,QAAQ,EAAE,EAAE;aACb,CAAC;YAEF,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;YAEhE,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;gBAC3B,IAAI,KAAK,CAAC,QAAQ,KAAK,OAAO,EAAE,CAAC;oBAC/B,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBACrB,CAAC;qBAAM,IAAI,KAAK,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;oBACxC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBACvB,CAAC;qBAAM,CAAC;oBACN,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBACnB,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO;YACL,KAAK,EAAE,MAAM,CAAC,MAAM,KAAK,CAAC;YAC1B,MAAM;YACN,QAAQ;YACR,IAAI;SACL,CAAC;IACJ,CAAC;IAEO,KAAK,CAAC,gBAAgB,CAAC,QAAkB,EAAE,WAAmB;QACpE,MAAM,MAAM,GAAY,EAAE,CAAC;QAE3B,0CAA0C;QAC1C,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,oBAAoB,EAAE,CAAC;YAChE,IAAI,CAAC,CAAC,KAAK,IAAI,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAC;gBACrC,MAAM,CAAC,IAAI,CAAC;oBACV,QAAQ,EAAE,OAAO;oBACjB,OAAO,EAAE,uCAAuC,KAAK,EAAE;oBACvD,IAAI,EAAE,QAAQ,CAAC,IAAI;oBACnB,IAAI,EAAE,sBAAsB;iBAC7B,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QAED,6DAA6D;QAC7D,IAAI,QAAQ,CAAC,WAAW,CAAC,UAAU,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,UAAU,CAAC,EAAE,CAAC;YACtF,KAAK,MAAM,GAAG,IAAI,QAAQ,CAAC,WAAW,CAAC,UAAU,EAAE,CAAC;gBAClD,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC;gBAC5C,IAAI,CAAC;oBACH,MAAM,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;gBAC3B,CAAC;gBAAC,MAAM,CAAC;oBACP,MAAM,CAAC,IAAI,CAAC;wBACV,QAAQ,EAAE,OAAO;wBACjB,OAAO,EAAE,8BAA8B,GAAG,EAAE;wBAC5C,IAAI,EAAE,QAAQ,CAAC,IAAI;wBACnB,IAAI,EAAE,mBAAmB;qBAC1B,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;QACH,CAAC;QAED,8BAA8B;QAC9B,IAAI,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,kBAAkB,EAAE,CAAC;YAC9C,KAAK,MAAM,gBAAgB,IAAI,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,kBAAkB,EAAE,CAAC;gBACzE,MAAM,KAAK,GAAG,UAAU,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;gBACnD,IAAI,CAAC,KAAK,EAAE,CAAC;oBACX,MAAM,CAAC,IAAI,CAAC;wBACV,QAAQ,EAAE,OAAO;wBACjB,OAAO,EAAE,0BAA0B,gBAAgB,CAAC,OAAO,EAAE;wBAC7D,IAAI,EAAE,QAAQ,CAAC,IAAI;wBACnB,IAAI,EAAE,mBAAmB;qBAC1B,CAAC,CAAC;oBACH,SAAS;gBACX,CAAC;gBACD,IAAI,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;oBACjC,MAAM,CAAC,IAAI,CAAC;wBACV,QAAQ,EAAE,OAAO;wBACjB,OAAO,EAAE,gBAAgB,CAAC,OAAO;wBACjC,IAAI,EAAE,QAAQ,CAAC,IAAI;wBACnB,IAAI,EAAE,mBAAmB;qBAC1B,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;QACH,CAAC;QAED,2CAA2C;QAC3C,IAAI,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,iBAAiB,EAAE,CAAC;YAC7C,MAAM,aAAa,GAAG,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC;YAChF,MAAM,CAAC,IAAI,CAAC,GAAG,aAAa,CAAC,CAAC;QAChC,CAAC;QAED,yBAAyB;QACzB,MAAM,QAAQ,GAAG,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QACxD,MAAM,QAAQ,GAAG,yBAAyB,CAAC;QAE3C,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;YAC/B,IAAI,OAAO,CAAC,KAAK,GAAG,QAAQ,EAAE,CAAC;gBAC7B,MAAM,CAAC,IAAI,CAAC;oBACV,QAAQ,EAAE,SAAS;oBACnB,OAAO,EAAE,iBAAiB,OAAO,CAAC,KAAK,oBAAoB,QAAQ,EAAE;oBACrE,IAAI,EAAE,QAAQ,CAAC,IAAI;oBACnB,IAAI,EAAE,OAAO,CAAC,IAAI;oBAClB,IAAI,EAAE,mBAAmB;iBAC1B,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QAED,mEAAmE;QACnE,IAAI,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,mBAAmB,EAAE,OAAO,IAAI,QAAQ,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAC;YACzF,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,0BAA0B,CAAC,QAAQ,CAAC,CAAC;YACvE,MAAM,CAAC,IAAI,CAAC,GAAG,cAAc,CAAC,CAAC;QACjC,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAEO,mBAAmB,CAAC,OAAe,EAAE,QAAgB;QAC3D,MAAM,MAAM,GAAY,EAAE,CAAC;QAC3B,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAElC,6CAA6C;QAC7C,MAAM,SAAS,GAAG,0BAA0B,CAAC;QAE7C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACtC,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;YACtB,IAAI,CAAC,IAAI;gBAAE,SAAS;YAEpB,IAAI,KAAK,CAAC;YACV,OAAO,CAAC,KAAK,GAAG,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC;gBAC/C,MAAM,QAAQ,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;gBAC1B,MAAM,OAAO,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;gBAEzB,wCAAwC;gBACxC,IAAI,CAAC,QAAQ,IAAI,CAAC,OAAO;oBAAE,SAAS;gBAEpC,6DAA6D;gBAC7D,MAAM,UAAU,GAAG,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;gBAEhD,IAAI,UAAU,EAAE,CAAC;oBACf,mDAAmD;oBACnD,MAAM,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,KAAK,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;oBAE1E,MAAM,CAAC,IAAI,CAAC;wBACV,QAAQ,EAAE,OAAO;wBACjB,OAAO,EAAE,wEAAwE,QAAQ,KAAK,OAAO,kBAAkB,OAAO,6JAA6J;wBAC3R,IAAI,EAAE,QAAQ;wBACd,IAAI,EAAE,CAAC,GAAG,CAAC;wBACX,IAAI,EAAE,mBAAmB;qBAC1B,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAEO,cAAc,CAAC,GAAW;QAChC,8BAA8B;QAC9B,IAAI,GAAG,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,GAAG,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;YAC5D,OAAO,KAAK,CAAC;QACf,CAAC;QAED,qCAAqC;QACrC,sDAAsD;QACtD,IAAI,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;YAChG,OAAO,IAAI,CAAC;QACd,CAAC;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAEO,cAAc,CAAC,IAAY,EAAE,UAAkB,EAAE,QAAgB,EAAE,OAAe;QACxF,2DAA2D;QAC3D,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,UAAU,GAAG,EAAE,CAAC,CAAC;QAC3C,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,UAAU,GAAG,QAAQ,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;QAEtF,IAAI,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;QAEhD,4BAA4B;QAC5B,IAAI,KAAK,GAAG,CAAC;YAAE,OAAO,GAAG,KAAK,GAAG,OAAO,CAAC;QACzC,IAAI,GAAG,GAAG,IAAI,CAAC,MAAM;YAAE,OAAO,GAAG,OAAO,GAAG,KAAK,CAAC;QAEjD,OAAO,OAAO,CAAC;IACjB,CAAC;IAEO,eAAe,CAAC,OAAe;QACrC,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAClC,MAAM,QAAQ,GAA0D,EAAE,CAAC;QAE3E,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACtC,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;YACtB,IAAI,IAAI,EAAE,CAAC;gBACT,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAC;gBAC9C,IAAI,KAAK,IAAI,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;oBAClC,QAAQ,CAAC,IAAI,CAAC;wBACZ,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM;wBACtB,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE;wBACtB,IAAI,EAAE,CAAC,GAAG,CAAC;qBACZ,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO,QAAQ,CAAC;IAClB,CAAC;IAEO,KAAK,CAAC,0BAA0B,CAAC,QAAkB;QACzD,MAAM,MAAM,GAAY,EAAE,CAAC;QAC3B,MAAM,YAAY,GAAG,QAAQ,CAAC,WAAW,CAAC,QAAkB,CAAC;QAC7D,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,mBAAmB,CAAC;QAE1D,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,MAAM,QAAQ,GAAG,MAAM,CAAC,QAAQ,IAAI,OAAO,CAAC;QAE5C,0BAA0B;QAC1B,wDAAwD;QACxD,8CAA8C;QAC9C,MAAM,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,SAAS;YACpD,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,SAAS;YACnC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;QAE3D,8BAA8B;QAC9B,MAAM,MAAM,GAAG,MAAM,cAAc,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC;QAChE,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,CAAC,IAAI,CAAC;gBACV,QAAQ;gBACR,OAAO,EAAE,uBAAuB,YAAY,0BAA0B,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,YAAY,GAAG,KAAK,CAAC,EAAE;gBACrH,IAAI,EAAE,QAAQ,CAAC,IAAI;gBACnB,IAAI,EAAE,iBAAiB;aACxB,CAAC,CAAC;YACH,OAAO,MAAM,CAAC,CAAC,kCAAkC;QACnD,CAAC;QAED,mBAAmB;QACnB,IAAI,QAAQ,CAAC;QACb,IAAI,CAAC;YACH,QAAQ,GAAG,MAAM,YAAY,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC;QAC5D,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,OAAO,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACvE,MAAM,CAAC,IAAI,CAAC;gBACV,QAAQ,EAAE,OAAO;gBACjB,OAAO,EAAE,4BAA4B,OAAO,EAAE;gBAC9C,IAAI,EAAE,QAAQ,CAAC,IAAI;gBACnB,IAAI,EAAE,eAAe;aACtB,CAAC,CAAC;YACH,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,6BAA6B;QAC7B,IAAI,MAAM,CAAC,uBAAuB,EAAE,CAAC;YACnC,MAAM,eAAe,GAAG,mBAAmB,CAAC,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC,gBAAgB,CAAC,CAAC;YACzF,IAAI,eAAe,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC/B,MAAM,YAAY,GAAG,eAAe,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBACxE,MAAM,CAAC,IAAI,CAAC;oBACV,QAAQ;oBACR,OAAO,EAAE,iDAAiD,YAAY,0BAA0B,YAAY,EAAE;oBAC9G,IAAI,EAAE,QAAQ,CAAC,IAAI;oBACnB,IAAI,EAAE,4BAA4B;iBACnC,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QAED,iCAAiC;QACjC,IAAI,MAAM,CAAC,2BAA2B,EAAE,CAAC;YACvC,MAAM,aAAa,GAAG,0BAA0B,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;YACnE,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC7B,MAAM,OAAO,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBAClE,MAAM,CAAC,IAAI,CAAC;oBACV,QAAQ,EAAE,QAAQ,KAAK,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,EAAE,qCAAqC;oBAC5F,OAAO,EAAE,uDAAuD,YAAY,mBAAmB,OAAO,EAAE;oBACxG,IAAI,EAAE,QAAQ,CAAC,IAAI;oBACnB,IAAI,EAAE,gCAAgC;iBACvC,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;CACF"}

package/dist/parsers/details-jsdoc.d.ts

@@ -0,0 +1,42 @@
+/**
+ * details-jsdoc - JSDoc解析・コードフォーマット
+ *
+ * 詳細ページ用のJSDoc解析、コード整形、マークダウン変換を行う。
+ */
+import type { ParsedJSDoc, DetailJsonItem } from "../commands/details-types.js";
+/**
+ * JSDocを整形
+ *
+ * 行頭のインデントを保持しつつ、JSDocの * を除去する
+ */
+export declare function cleanJSDoc(jsDoc: string): string;
+/**
+ * コードをエスケープ（highlight.js はCDNから読み込み）
+ */
+export declare function formatCode(code: string): string;
+/**
+ * 簡易マークダウン変換（コードブロック対応）
+ */
+export declare function simpleMarkdown(text: string): string;
+/**
+ * JSDocコメントを抽出（共通パーサー使用）
+ *
+ * 関数宣言の位置を先に特定し、その直前にあるJSDocコメントを抽出する。
+ */
+export declare function extractJSDoc(sourceCode: string, targetName: string): string;
+/**
+ * JSDocをパースして構造化データにする
+ */
+export declare function parseJSDoc(jsDoc: string): ParsedJSDoc;
+/**
+ * JSDocをパースしてJSON出力用の構造化データにする
+ */
+export declare function parseJSDocForJson(jsDoc: string): DetailJsonItem["jsDoc"];
+/**
+ * 型定義のソースコードをJSDoc部分と定義部分に分離
+ */
+export declare function splitTypeSourceCode(sourceCode: string): {
+    jsdocHtml: string;
+    definitionCode: string;
+};
+//# sourceMappingURL=details-jsdoc.d.ts.map

package/dist/parsers/details-jsdoc.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"details-jsdoc.d.ts","sourceRoot":"","sources":["../../src/parsers/details-jsdoc.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH,OAAO,KAAK,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AAEhF;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAYhD;AAED;;GAEG;AACH,wBAAgB,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAE/C;AAED;;GAEG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAmCnD;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,MAAM,CAM3E;AAED;;GAEG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,WAAW,CAqErD;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,cAAc,CAAC,OAAO,CAAC,CAuExE;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,UAAU,EAAE,MAAM,GAAG;IACvD,SAAS,EAAE,MAAM,CAAC;IAClB,cAAc,EAAE,MAAM,CAAC;CACxB,CAoBA"}