shirokuma-docs 0.1.0-alpha.1

package/dist/lint/annotation-lint.d.ts

@@ -0,0 +1,198 @@
+/**
+ * アノテーション整合性検証ロジック
+ *
+ * コードアノテーション（@usedComponents, @screen, @component等）の
+ * 整合性を検証するユーティリティ関数群
+ *
+ * @module lint/annotation-lint
+ */
+import type { UsedComponentsResult, AnnotationCheckResult, ExtractImportsOptions, AnnotationCheckOptions } from "./annotation-types.js";
+export type { UsedComponentsResult, AnnotationCheckResult };
+/**
+ * 修正結果の型
+ */
+export interface FixResult {
+    /** ファイル内容が変更されたか */
+    changed: boolean;
+    /** 修正後のファイル内容 */
+    content: string;
+}
+/**
+ * 複数修正結果の型
+ */
+export interface ApplyFixesResult extends FixResult {
+    /** 適用された変更のリスト */
+    changes: string[];
+}
+/**
+ * 修正オプション
+ */
+export interface FixOptions {
+    /** @usedComponents を修正するか */
+    fixUsedComponents?: boolean;
+    /** @screen を修正するか */
+    fixScreen?: boolean;
+    /** @route を修正するか */
+    fixRoute?: boolean;
+}
+/**
+ * JSDoc から @usedComponents アノテーションを抽出
+ *
+ * @param content - ファイル内容
+ * @returns コンポーネント名の配列
+ *
+ * @example
+ * ```typescript
+ * const components = extractUsedComponentsAnnotation(`
+ *   /**
+ *    * @usedComponents Button, Card, Dialog
+ *    *\/
+ *   export function MyComponent() {}
+ * `);
+ * // Returns: ["Button", "Card", "Dialog"]
+ * ```
+ */
+export declare function extractUsedComponentsAnnotation(content: string): string[];
+/**
+ * import文からコンポーネント名を抽出
+ *
+ * components ディレクトリからのインポートのみを対象とする
+ *
+ * @param content - ファイル内容
+ * @param options - 抽出オプション
+ * @returns コンポーネント名の配列
+ *
+ * @example
+ * ```typescript
+ * const components = extractComponentsFromImports(`
+ *   import { Button, Card } from "@/components/ui/button";
+ * `, { excludeHooks: true });
+ * // Returns: ["Button", "Card"]
+ * ```
+ */
+export declare function extractComponentsFromImports(content: string, options?: ExtractImportsOptions): string[];
+/**
+ * @usedComponents アノテーションとインポートを比較
+ *
+ * @param annotated - アノテーションに記載されたコンポーネント
+ * @param imported - インポートされているコンポーネント
+ * @returns 比較結果
+ *
+ * @example
+ * ```typescript
+ * const result = compareUsedComponents(
+ *   ["Button", "Card"],
+ *   ["Button", "Card", "Dialog"]
+ * );
+ * // result.missing: ["Dialog"]
+ * // result.extra: []
+ * // result.valid: false
+ * ```
+ */
+export declare function compareUsedComponents(annotated: string[], imported: string[]): UsedComponentsResult;
+/**
+ * @screen アノテーションの存在をチェック
+ *
+ * page.tsx ファイルに @screen アノテーションがあるか確認
+ *
+ * @param content - ファイル内容
+ * @param filePath - ファイルパス
+ * @param options - チェックオプション
+ * @returns チェック結果
+ *
+ * @example
+ * ```typescript
+ * const result = checkScreenAnnotation(
+ *   content,
+ *   "app/[locale]/dashboard/page.tsx",
+ *   { exclude: ["*\/not-found.tsx"] }
+ * );
+ * ```
+ */
+export declare function checkScreenAnnotation(content: string, filePath: string, options?: AnnotationCheckOptions): AnnotationCheckResult;
+/**
+ * @component アノテーションの存在をチェック
+ *
+ * コンポーネントファイルに @component アノテーションがあるか確認
+ *
+ * @param content - ファイル内容
+ * @param filePath - ファイルパス
+ * @param options - チェックオプション
+ * @returns チェック結果
+ *
+ * @example
+ * ```typescript
+ * const result = checkComponentAnnotation(
+ *   content,
+ *   "components/project-list.tsx",
+ *   { exclude: ["*\/ui\/**"] }
+ * );
+ * ```
+ */
+export declare function checkComponentAnnotation(content: string, filePath: string, options?: AnnotationCheckOptions): AnnotationCheckResult;
+/**
+ * ファイルパスからスクリーン名を生成
+ *
+ * @param filePath - ファイルパス
+ * @returns スクリーン名 (PascalCase + "Screen")
+ *
+ * @example
+ * ```typescript
+ * generateScreenName("app/[locale]/dashboard/page.tsx")
+ * // Returns: "DashboardScreen"
+ *
+ * generateScreenName("app/[locale]/settings/profile/page.tsx")
+ * // Returns: "SettingsProfileScreen"
+ * ```
+ */
+export declare function generateScreenName(filePath: string): string;
+/**
+ * ファイルパスからルートを生成
+ *
+ * @param filePath - ファイルパス
+ * @returns ルートパス
+ *
+ * @example
+ * ```typescript
+ * generateRoute("app/[locale]/posts/page.tsx")
+ * // Returns: "/posts"
+ *
+ * generateRoute("app/[locale]/posts/[id]/page.tsx")
+ * // Returns: "/posts/[id]"
+ * ```
+ */
+export declare function generateRoute(filePath: string): string;
+/**
+ * @usedComponents アノテーションを自動修正
+ *
+ * @param content - ファイル内容
+ * @param filePath - ファイルパス (未使用だが将来の拡張用)
+ * @returns 修正結果
+ */
+export declare function fixUsedComponentsAnnotation(content: string, filePath: string): FixResult;
+/**
+ * @screen アノテーションを自動修正
+ *
+ * @param content - ファイル内容
+ * @param filePath - ファイルパス
+ * @returns 修正結果
+ */
+export declare function fixScreenAnnotation(content: string, filePath: string): FixResult;
+/**
+ * @route アノテーションを自動修正
+ *
+ * @param content - ファイル内容
+ * @param filePath - ファイルパス
+ * @returns 修正結果
+ */
+export declare function fixRouteAnnotation(content: string, filePath: string): FixResult;
+/**
+ * 複数の修正を一度に適用
+ *
+ * @param content - ファイル内容
+ * @param filePath - ファイルパス
+ * @param options - 修正オプション
+ * @returns 修正結果
+ */
+export declare function applyFixes(content: string, filePath: string, options: FixOptions): ApplyFixesResult;
+//# sourceMappingURL=annotation-lint.d.ts.map

package/dist/lint/annotation-lint.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"annotation-lint.d.ts","sourceRoot":"","sources":["../../src/lint/annotation-lint.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAGH,OAAO,KAAK,EACV,oBAAoB,EACpB,qBAAqB,EAErB,qBAAqB,EACrB,sBAAsB,EACvB,MAAM,uBAAuB,CAAC;AAG/B,YAAY,EAAE,oBAAoB,EAAE,qBAAqB,EAAE,CAAC;AAE5D;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,oBAAoB;IACpB,OAAO,EAAE,OAAO,CAAC;IACjB,iBAAiB;IACjB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,SAAS;IACjD,kBAAkB;IAClB,OAAO,EAAE,MAAM,EAAE,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,6BAA6B;IAC7B,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,qBAAqB;IACrB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,oBAAoB;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,+BAA+B,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,CAoCzE;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,4BAA4B,CAC1C,OAAO,EAAE,MAAM,EACf,OAAO,GAAE,qBAA0B,GAClC,MAAM,EAAE,CA+CV;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,qBAAqB,CACnC,SAAS,EAAE,MAAM,EAAE,EACnB,QAAQ,EAAE,MAAM,EAAE,GACjB,oBAAoB,CAiBtB;AASD;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,qBAAqB,CACnC,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,EAChB,OAAO,GAAE,sBAA2B,GACnC,qBAAqB,CAuCvB;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,wBAAwB,CACtC,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,EAChB,OAAO,GAAE,sBAA2B,GACnC,qBAAqB,CAwCvB;AAMD;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,kBAAkB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAyC3D;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAsBtD;AAoDD;;;;;;GAMG;AACH,wBAAgB,2BAA2B,CACzC,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,GACf,SAAS,CA4CX;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CACjC,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,GACf,SAAS,CAoBX;AAED;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAChC,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,GACf,SAAS,CAoBX;AAED;;;;;;;GAOG;AACH,wBAAgB,UAAU,CACxB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,UAAU,GAClB,gBAAgB,CAoClB"}