@basemachina/bm-action-dep-parser v0.0.2

bm-action-dep-parser

BaseMachina アクション依存関係解析ツール

概要

このツールは、BaseMachinaのJavaScriptアクションとビューのコードを静的解析して、各ファイルがどのアクションに依存しているかを特定します。

注意: このプロジェクトは、ビューやJavaScriptアクションが構造化されたディレクトリに配置されていることを想定しています。例えば以下のようなディレクトリ構造を前提としています。 必ずしもこちらと同じにする必要はありませんが、ビューやJavaScriptアクションのエントリーポイントが明確になるようにしてください。

project/
├── actions/
│   └── js/
|       └── sampleAction.js
└── views/
    ├── components/
    │   └── SortableForm.tsx
    └── pages/
        ├── SortableFormPage.tsx
        └── paginatedTable/
            └── index.tsx

機能

• 解析対象（JSアクションかビューか）と対象ディレクトリを指定可能
• 各ファイルごとに依存しているアクションの識別子をリストアップ
• アクション呼び出し関数（executeAction, useExecuteAction, useExecuteActionLazy）を検出
• 変数に格納されたアクション識別子も検出
• JSON形式で結果を出力
• ビューのエントリーポイント分析: ビューのエントリーポイントから直接・間接的に依存しているすべてのアクションを可視化（ビューは常にエントリーポイント分析モード）
• カスタムエントリーポイントパターン: エントリーポイントを柔軟に指定可能（デフォルトは pages/**/*.{tsx,jsx,ts,js}）

出力例

 npx @basemachina/bm-action-dep-parser view ./bm-action-dep-parser/tests/fixtures/views 
[
  {
    "entrypoint": "pages/SortableFormPage.tsx",
    "dependencies": {
      "direct": [],
      "indirect": {
        "components/SortableForm.tsx": [
          "get-products",
          "update-category"
        ]
      }
    }
  },
  {
    "entrypoint": "pages/paginatedTable/index.tsx",
    "dependencies": {
      "direct": [
        "get-users"
      ],
      "indirect": {}
    }
  }
]

使用方法

CLIツールとして使用

npx @basemachina/bm-action-dep-parser action ./packages/actions/js
npx @basemachina/bm-action-dep-parser view ./packages/views

オプション

# 出力形式を指定（text または json）
npx @basemachina/bm-action-dep-parser action ./packages/actions/js --format json

# カスタムエントリーポイントパターンを指定（ビューの場合のみ）
npx @basemachina/bm-action-dep-parser view ./packages/views --entry-point-patterns "**/*.tsx"

# ヘルプを表示
npx @basemachina/bm-action-dep-parser --help

ローカルでの実行

pnpm run analyze action ./packages/actions/js
pnpm run analyze view ./packages/views

技術詳細

このツールは以下のモジュールで構成されています：

1. index.ts: メインエントリーポイント
2. cli.ts: コマンドラインインターフェース
3. lib/file-finder.ts: ファイル検索モジュール
4. lib/code-analyzer.ts: コード解析モジュール
5. lib/dependency-extractor.ts: 依存関係抽出モジュール
6. lib/result-formatter.ts: 結果出力モジュール
7. lib/dependency-graph-builder.ts: 依存関係グラフ構築モジュール
8. lib/entry-point-analyzer.ts: エントリーポイント解析モジュール

TypeScriptのコンパイラAPIを使用してコードを解析し、アクション呼び出しを検出しています。エントリーポイント分析モードでは、ファイル間の依存関係も解析して、間接的なアクション依存関係も検出します。