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

package/dist/utils/config.d.ts

@@ -0,0 +1,709 @@
+/**
+ * 設定ファイル読み込みユーティリティ
+ */
+/**
+ * Application type - determines document structure
+ */
+export type AppType = "web" | "api" | "cli" | "library";
+/**
+ * API protocol type
+ */
+export type ApiProtocol = "mcp" | "rest" | "graphql" | "grpc";
+/**
+ * Section type for applications
+ */
+export type SectionType = "overview" | "featureMap" | "dbSchema" | "testCases" | "tools" | "endpoints" | "commands" | "modules";
+/**
+ * Application configuration
+ */
+export interface ApplicationConfig {
+    /** Unique identifier */
+    id: string;
+    /** Application type */
+    type: AppType;
+    /** Display name */
+    name: string;
+    /** Description */
+    description?: string;
+    /** Source directory (e.g., "apps/web", "apps/mcp") */
+    source?: string;
+    /** Icon name (lucide-react compatible) */
+    icon?: string;
+    /** Theme color */
+    color?: string;
+    /** API protocol (for type: "api") */
+    protocol?: ApiProtocol;
+    /** Tools file path (for api type) */
+    toolsFile?: string;
+    /** Section definitions */
+    sections?: Array<{
+        type: SectionType;
+        label?: string;
+        icon?: string;
+        filter?: {
+            paths?: string[];
+        };
+    }>;
+    /** Database tables used by this app */
+    dbTables?: string[];
+    /** Test file patterns */
+    tests?: {
+        match: string[];
+    };
+}
+/**
+ * スキーマソース設定（複数DB対応）
+ *
+ * DB名はpathから自動取得:
+ * - packages/database/src/schema -> "database"
+ * - packages/analytics-db/src/schema -> "analytics-db"
+ */
+export interface SchemaSourceConfig {
+    /** スキーマディレクトリパス（必須） */
+    path: string;
+    /** 説明（オプション） */
+    description?: string;
+}
+/**
+ * Package configuration for monorepo shared packages
+ *
+ * Allows documenting packages under packages/ directory
+ * with their modules, types, and exports.
+ */
+export interface PackageConfig {
+    /** Package name (e.g., "database", "shared") */
+    name: string;
+    /** Path to package directory (e.g., "packages/database") */
+    path: string;
+    /** Package prefix/scope (e.g., "@repo/database") */
+    prefix: string;
+    /** Package description */
+    description?: string;
+    /** Entry point files to scan (e.g., ["src/index.ts"]) */
+    entryPoints?: string[];
+    /** Icon name (lucide-react compatible) */
+    icon?: string;
+    /** Theme color */
+    color?: string;
+}
+/**
+ * shirokuma-docs 設定
+ */
+export interface ShirokumaConfig {
+    /** CLI locale (en | ja) - determines CLI output language */
+    locale?: "en" | "ja";
+    /** プロジェクト情報 */
+    project: {
+        /** プロジェクト名 */
+        name: string;
+        /** プロジェクト説明 */
+        description?: string;
+        /** プロジェクトURL */
+        url?: string;
+    };
+    /** 出力設定 */
+    output: {
+        /** メイン出力ディレクトリ */
+        dir: string;
+        /** ポータル出力ディレクトリ */
+        portal?: string;
+        /** 生成ファイル出力ディレクトリ */
+        generated?: string;
+    };
+    /** TypeDoc 設定 */
+    typedoc?: {
+        /** エントリーポイント */
+        entryPoints?: string[];
+        /** tsconfig パス */
+        tsconfig?: string;
+        /** 出力ディレクトリ */
+        out?: string;
+        /** プラグイン */
+        plugin?: string[];
+        /** 除外パターン */
+        exclude?: string[];
+    };
+    /** スキーマ生成設定 */
+    schema?: {
+        /** スキーマソース（複数DB対応） */
+        sources: SchemaSourceConfig[];
+        /** スキーマファイルパターン（共通設定） */
+        pattern?: string;
+    };
+    /** 依存関係グラフ設定 */
+    deps?: {
+        /** 含めるパス */
+        include?: string[];
+        /** 除外パス */
+        exclude?: string[];
+        /** 出力ディレクトリ */
+        output?: string;
+        /** 出力フォーマット (svg, json) */
+        formats?: ("svg" | "json")[];
+    };
+    /** テストケース設定 */
+    testCases?: {
+        /** Jest 設定 */
+        jest?: {
+            /** 設定ファイル */
+            config?: string;
+            /** テストマッチパターン */
+            testMatch?: string[];
+        };
+        /** Playwright 設定 */
+        playwright?: {
+            /** 設定ファイル */
+            config?: string;
+            /** テストディレクトリ */
+            testDir?: string;
+        };
+        /** 出力ディレクトリ (オーバーライド用) */
+        output?: string;
+        /** BDD アノテーション設定 */
+        bddAnnotations?: {
+            /** BDD アノテーションを有効にする (デフォルト: true) */
+            enabled?: boolean;
+            /** サポートするタグ (デフォルト: ["given", "when", "then", "and"]) */
+            tags?: string[];
+        };
+    };
+    /** ポータル設定 */
+    portal?: {
+        /** サイトタイトル */
+        title?: string;
+        /** 追加リンク */
+        links?: Array<{
+            name: string;
+            url: string;
+            description?: string;
+        }>;
+        /** 開発ツールリンク */
+        devTools?: Array<{
+            name: string;
+            url: string;
+            description?: string;
+        }>;
+    };
+    /** アプリケーション設定 (マルチアプリ対応) */
+    applications?: {
+        /** 共通セクション */
+        shared?: {
+            sections?: Array<{
+                /** セクションタイプ */
+                type: "overview" | "dbSchema" | "testCases";
+                /** 表示ラベル */
+                label?: string;
+                /** アイコン名 (lucide互換) */
+                icon?: string;
+            }>;
+        };
+        /** アプリケーション定義 */
+        apps?: Array<ApplicationConfig>;
+    };
+    /** パッケージ設定 (モノレポ共有パッケージ対応) */
+    packages?: PackageConfig[];
+    /** lint-tests 設定 */
+    lintTests?: {
+        /** 有効にするルール */
+        rules?: {
+            /** testdoc-required ルール */
+            "testdoc-required"?: boolean | "error" | "warning" | "info" | "off";
+            /** testdoc-japanese ルール */
+            "testdoc-japanese"?: boolean | "error" | "warning" | "info" | "off";
+            /** testdoc-min-length ルール */
+            "testdoc-min-length"?: boolean | "error" | "warning" | "info" | "off";
+            /** duplicate-testdoc ルール */
+            "duplicate-testdoc"?: boolean | "error" | "warning" | "info" | "off";
+            /** describe-coverage ルール */
+            "describe-coverage"?: boolean | "error" | "warning" | "info" | "off";
+        };
+        /** strictモード（warningもエラーとして扱う） */
+        strict?: boolean;
+        /** カバレッジ閾値 (%) */
+        coverageThreshold?: number;
+        /** 無視するパターン */
+        ignore?: string[];
+    };
+    /** lint-coverage 設定 */
+    lintCoverage?: {
+        /** 有効フラグ */
+        enabled?: boolean;
+        /** strictモード (missingがあれば失敗) */
+        strict?: boolean;
+        /** @skip-test に理由が必須か */
+        requireSkipReason?: boolean;
+        /** 規約マッピング */
+        conventions?: Array<{
+            /** ソースファイルのglobパターン */
+            source: string;
+            /** テストファイルのglobパターン */
+            test: string;
+        }>;
+        /** 除外パターン */
+        exclude?: string[];
+    };
+    /** ADR (Architecture Decision Records) 設定 */
+    adr?: {
+        /** 有効フラグ */
+        enabled?: boolean;
+        /** ADR 出力ディレクトリ */
+        directory?: string;
+        /** テンプレート形式 (現在は madr のみ) */
+        template?: "madr";
+        /** 言語 */
+        language?: "ja" | "en";
+    };
+    /** カバレッジ可視化設定 */
+    coverage?: {
+        /** 有効フラグ */
+        enabled?: boolean;
+        /** Istanbul coverage-summary.json のパス */
+        source?: string;
+        /** 閾値設定 */
+        thresholds?: {
+            lines?: number;
+            branches?: number;
+            functions?: number;
+            statements?: number;
+        };
+        /** 閾値未満で失敗する (CI用) */
+        failUnder?: boolean;
+    };
+    /** 検索機能設定 */
+    search?: {
+        /** 検索機能の有効/無効 (デフォルト: true) */
+        enabled?: boolean;
+        /** 検索エンジン (flexsearch のみサポート) */
+        engine?: "flexsearch";
+        /** インデックス出力パス */
+        indexOutput?: string;
+        /** 検索対象に含めるパターン */
+        include?: string[];
+        /** 検索対象から除外するパターン */
+        exclude?: string[];
+    };
+    /** API-テスト関連付け設定 */
+    linkDocs?: {
+        /** 有効フラグ (デフォルト: true) */
+        enabled?: boolean;
+        /** カバレッジ率を表示するか (デフォルト: true) */
+        showCoverage?: boolean;
+        /** API ドキュメントのパス */
+        apiDocsPath?: string;
+        /** テストケース HTML のパス */
+        testCasesPath?: string;
+        /** 出力ファイル名 (デフォルト: linked-docs.html) */
+        outputFile?: string;
+    };
+    /** Feature Map 設定 */
+    featureMap?: {
+        /** 有効フラグ (デフォルト: true) */
+        enabled?: boolean;
+        /** 含めるパターン */
+        include?: string[];
+        /** 除外パターン */
+        exclude?: string[];
+        /** 外部ドキュメントリンク設定 */
+        externalDocs?: Array<{
+            /** 設定名 (識別用) */
+            name: string;
+            /** マッチングパターン (正規表現) */
+            pattern: string;
+            /** URL テンプレート ({name}, {kebab-name}, {lower-name} が使用可能) */
+            urlTemplate: string;
+            /** リンクラベル */
+            label: string;
+            /** 対象タイプ (component, action, table, all) */
+            type?: "component" | "action" | "table" | "all";
+        }>;
+        /** Storybook 設定 */
+        storybook?: {
+            /** 有効フラグ */
+            enabled?: boolean;
+            /** Storybook URL */
+            url?: string;
+            /** パステンプレート ({name}, {kebab-name}, {lower-name} が使用可能) */
+            pathTemplate?: string;
+            /** リンクラベル */
+            label?: string;
+        };
+    };
+    /** Overview 設定 */
+    overview?: {
+        /** 有効フラグ (デフォルト: true) */
+        enabled?: boolean;
+        /** 詳細説明 Markdown ファイルパス */
+        file?: string;
+        /** アーキテクチャ層 */
+        layers?: Array<{
+            /** 層名 */
+            name: string;
+            /** 説明 */
+            description: string;
+            /** アイコン名 (lucide互換) */
+            icon?: string;
+            /** 色 (blue, green, purple, orange, pink, cyan) */
+            color?: string;
+        }>;
+        /** 機能サマリー */
+        features?: Array<{
+            /** 機能名 */
+            name: string;
+            /** 説明 */
+            description: string;
+            /** ステータス (stable, beta, planned) */
+            status?: "stable" | "beta" | "planned";
+            /** 優先度 (core, standard, optional) */
+            priority?: "core" | "standard" | "optional";
+        }>;
+        /** 技術スタック */
+        techStack?: Array<{
+            /** カテゴリ名 */
+            category: string;
+            /** 技術リスト */
+            items: string[];
+        }>;
+        /** クイックコマンド */
+        quickLinks?: Array<{
+            /** 表示テキスト */
+            text: string;
+            /** コマンド */
+            command: string;
+        }>;
+    };
+    /** スクリーンショット生成設定 */
+    screenshots?: {
+        /** 有効フラグ (デフォルト: true) */
+        enabled?: boolean;
+        /** ソース指定 ('annotations' | 'feature-map' | 'config' | 'both') デフォルト: 'feature-map' */
+        source?: "annotations" | "feature-map" | "config" | "both";
+        /** アノテーションスキャン対象パス (source: 'annotations' または 'both' 用) */
+        scanPaths?: string[];
+        /** 直接定義された screens (source: 'config' 用) */
+        screens?: Array<{
+            name: string;
+            route: string;
+            description?: string;
+            viewport?: {
+                width: number;
+                height: number;
+            };
+            auth?: "required" | "none" | "optional";
+            waitFor?: string;
+            delay?: number;
+        }>;
+        /** ベースURL */
+        baseUrl?: string;
+        /** ロケール */
+        locale?: string;
+        /** 複数アカウント定義 (マルチアカウント対応) */
+        accounts?: Record<string, {
+            /** メールアドレス */
+            email: string;
+            /** パスワード */
+            password: string;
+            /** 表示ラベル */
+            label?: string;
+        }>;
+        /** デフォルトアカウント (@screenshotAccount 未指定時に使用) */
+        defaultAccount?: string;
+        /** ログインパス (accounts使用時) */
+        loginPath?: string;
+        /** 認証設定 (後方互換性のため残す) */
+        auth?: {
+            /** メールアドレス */
+            email?: string;
+            /** パスワード */
+            password?: string;
+            /** ログインパス */
+            loginPath?: string;
+        };
+        /** ビューポートサイズ */
+        viewport?: {
+            /** 幅 */
+            width?: number;
+            /** 高さ */
+            height?: number;
+        };
+        /** 出力ディレクトリ */
+        outputDir?: string;
+        /** テストファイル出力パス */
+        testFile?: string;
+        /** 動的ルート置換マッピング */
+        routeParams?: Record<string, string>;
+        /** スクリーン単位のルート上書き (スクリーン名 -> 完全ルートまたはURL) */
+        screenOverrides?: Record<string, string>;
+        /**
+         * 動的ルート解決設定（E2Eテストフィクスチャー連携）
+         * テストDBから実際のエンティティIDを取得してルートを構築
+         */
+        dynamicRoutes?: {
+            /** 有効フラグ */
+            enabled?: boolean;
+            /** データベースヘルパーモジュールへのパス（例: "./tests/helpers/database"） */
+            helperModule?: string;
+            /** ルートパラメータとメソッドのマッピング */
+            paramMethods?: Record<string, string>;
+            /** テスト環境のデータベースURL（直接接続する場合） */
+            databaseUrl?: string;
+        };
+        /**
+         * アプリ別設定（マルチアプリ対応）
+         * キー: アプリID (例: "admin", "public")
+         * 設定されている場合、アプリごとに別々のテストファイルを生成
+         */
+        apps?: Record<string, {
+            /** ベースURL */
+            baseUrl?: string;
+            /** 認証設定（nullで認証スキップ） */
+            auth?: {
+                email?: string;
+                password?: string;
+                loginPath?: string;
+            } | null;
+            /** テストファイル出力パス */
+            testFile?: string;
+            /** 出力ディレクトリ */
+            outputDir?: string;
+            /** スクリーン単位のルート上書き */
+            screenOverrides?: Record<string, string>;
+            /** このアプリを有効にするかどうか */
+            enabled?: boolean;
+        }>;
+    };
+    /** lint-code 設定 */
+    lintCode?: {
+        /** 有効フラグ */
+        enabled?: boolean;
+        /** strictモード (エラー時に exit code 1) */
+        strict?: boolean;
+        /** Server Actions 検証設定 */
+        serverActions?: {
+            /** ファイルパターン (glob) */
+            filePattern?: string;
+            /** 除外パターン */
+            excludePattern?: string;
+            /** モジュールヘッダー必須タグ */
+            requiredFileHeader?: string[];
+            /** 関数必須タグ */
+            requiredFunctionTags?: string[];
+            /** セクション区切りコメントを必須とするか */
+            sectionSeparators?: boolean;
+        };
+    };
+    /** lint-docs 設定 */
+    lintDocs?: {
+        /** 有効フラグ */
+        enabled?: boolean;
+        /** strictモード (エラー時に exit code 1) */
+        strict?: boolean;
+        /** 必須ドキュメント設定 */
+        required?: Array<{
+            /** ファイルパス (単一ファイル) */
+            file?: string;
+            /** ファイルパターン (glob) */
+            filePattern?: string;
+            /** ドキュメントの説明 */
+            description: string;
+            /** 最小ファイル数 (filePattern 用) */
+            minCount?: number;
+            /** セクションルール */
+            sections?: Array<{
+                /** 正規表現パターン */
+                pattern: string;
+                /** セクション説明 */
+                description: string;
+                /** 必須か */
+                required: boolean;
+            }>;
+            /** 最小行数 */
+            minLength?: number;
+            /** 最大行数 */
+            maxLength?: number;
+            /** フロントマタールール */
+            frontmatter?: {
+                /** フロントマターが必須か */
+                required: boolean;
+                /** フィールドルール */
+                fields: Array<{
+                    /** フィールド名 */
+                    name: string;
+                    /** 許容値リスト */
+                    values?: string[];
+                    /** 日付フォーマット */
+                    format?: string;
+                }>;
+            };
+        }>;
+        /** リンク検証設定 */
+        validateLinks?: {
+            /** 有効か */
+            enabled: boolean;
+            /** 内部リンクをチェックするか */
+            checkInternal: boolean;
+            /** 外部リンクをチェックするか */
+            checkExternal: boolean;
+        };
+        /** フォーマット検証設定 */
+        formatting?: {
+            /** 最大行長 */
+            maxLineLength?: number;
+            /** 見出し前に空行が必要か */
+            requireBlankLineBeforeHeading?: boolean;
+        };
+    };
+    /** lint-annotations 設定 */
+    lintAnnotations?: {
+        /** 有効フラグ */
+        enabled?: boolean;
+        /** strictモード (エラー時に exit code 1) */
+        strict?: boolean;
+        /** ルール設定 */
+        rules?: {
+            /** @usedComponents 整合性チェック */
+            "usedComponents-match"?: {
+                severity?: "error" | "warning" | "info";
+                checkOrder?: boolean;
+                excludeHooks?: boolean;
+            };
+            /** @screen 必須チェック */
+            "screen-required"?: {
+                severity?: "error" | "warning" | "info";
+                paths?: string[];
+                exclude?: string[];
+            };
+            /** @component 必須チェック */
+            "component-required"?: {
+                severity?: "error" | "warning" | "info";
+                paths?: string[];
+                exclude?: string[];
+            };
+        };
+        /** グローバル除外パターン */
+        exclude?: string[];
+    };
+    /** Public/Private repo pair management */
+    repoPairs?: Record<string, {
+        /** Private repository (owner/name) */
+        private: string;
+        /** Public repository (owner/name) */
+        public: string;
+        /** Files/directories to exclude from public release */
+        exclude?: string[];
+        /** Default branch name (defaults to "main") */
+        defaultBranch?: string;
+    }>;
+    /** Cross-repository references (alias → owner/repo) */
+    crossRepos?: Record<string, string>;
+    /** lint-workflow 設定 */
+    lintWorkflow?: {
+        /** 有効フラグ */
+        enabled?: boolean;
+        /** strictモード (エラー時に exit code 1) */
+        strict?: boolean;
+        /** ルール設定 */
+        rules?: {
+            /** Issue フィールド完全性チェック */
+            "issue-fields"?: {
+                severity?: "error" | "warning" | "info";
+                enabled?: boolean;
+            };
+            /** ブランチ命名規則チェック */
+            "branch-naming"?: {
+                severity?: "error" | "warning" | "info";
+                enabled?: boolean;
+                prefixes?: string[];
+            };
+            /** 保護ブランチチェック */
+            "main-protection"?: {
+                severity?: "error" | "warning" | "info";
+                enabled?: boolean;
+                branches?: string[];
+            };
+            /** コミットメッセージ形式チェック */
+            "commit-format"?: {
+                severity?: "error" | "warning" | "info";
+                enabled?: boolean;
+                types?: string[];
+            };
+        };
+    };
+    /** lint-structure 設定 */
+    lintStructure?: {
+        /** 有効フラグ */
+        enabled?: boolean;
+        /** strictモード (エラー時に exit code 1) */
+        strict?: boolean;
+        /** 除外するアプリ (MCPサーバー等Next.js構造不要なアプリ) */
+        excludeApps?: string[];
+        /** ルール設定 */
+        rules?: {
+            /** 必須ディレクトリ */
+            "dir-required"?: {
+                severity: "error" | "warning" | "info";
+                apps?: string[];
+                packages?: Record<string, string[]>;
+            };
+            /** 必須ファイル */
+            "file-required"?: {
+                severity: "error" | "warning" | "info";
+                apps?: string[];
+                packages?: Record<string, string[]>;
+            };
+            /** lib/ 直下ファイル禁止 */
+            "lib-no-root-files"?: {
+                severity: "error" | "warning" | "info";
+                enabled: boolean;
+            };
+            /** lib/ サブディレクトリに index.ts 必須 */
+            "lib-has-index"?: {
+                severity: "error" | "warning" | "info";
+                enabled: boolean;
+            };
+            /** 推奨ディレクトリ */
+            "dir-recommended"?: {
+                severity: "error" | "warning" | "info";
+                apps?: string[];
+            };
+            /** 命名規則 */
+            "naming-convention"?: {
+                severity: "error" | "warning" | "info";
+                enabled: boolean;
+                rules?: {
+                    domainDirs?: "PascalCase" | "camelCase" | "kebab-case";
+                    components?: "PascalCase" | "camelCase";
+                    actions?: "PascalCase" | "camelCase";
+                    routeGroups?: "lowercase" | "PascalCase";
+                };
+            };
+            /** アプリ間インポート禁止 */
+            "no-cross-app-import"?: {
+                severity: "error" | "warning" | "info";
+                enabled: boolean;
+            };
+            /** components/ ドメイン別グループ化 */
+            "components-domain-grouping"?: {
+                severity: "error" | "warning" | "info";
+                enabled: boolean;
+                systemDirs?: string[];
+            };
+        };
+    };
+}
+/**
+ * デフォルト設定
+ */
+export declare const defaultConfig: ShirokumaConfig;
+/**
+ * 設定ファイルを読み込む
+ */
+export declare function loadConfig(projectPath: string, configFile: string): ShirokumaConfig;
+/**
+ * パスを解決 (プロジェクトルートからの相対パス)
+ */
+export declare function resolvePath(projectPath: string, relativePath: string): string;
+/**
+ * 出力パスを取得
+ */
+export declare function getOutputPath(config: ShirokumaConfig, projectPath: string, type: "portal" | "generated" | "base"): string;
+//# sourceMappingURL=config.d.ts.map