dependency cruiser report action

依存関係 - クルーザーレポート

変更されたファイルの依存関係を視覚化するために報告するgithubアクションは、各プルリクエストを要求します。

このアクションでは、Mermaid.jsの出力構文に依存関係 - クルーザーを使用します。 Jest-Coverage-Report-actionに触発されました。

使用法

プロジェクトにインストールしてください

npm install --save-dev dependency-cruiser

ウィザードのセットアップ依存関係 - クルーザー

npm run depcruise --init

.github/workflowsの下に新しいアクションを作成します。

 name : ' depcruise '
on :
  pull_request :

jobs :
  report :
    permissions :
      pull-requests : write
    runs-on : ubuntu-latest
    steps :
      - uses : MH4GF/dependency-cruiser-report-action@v2 

高度な使用

設定ファイルの指定

このアクションは、依存関係 - クルーザー構成ファイル（ .dependency-cruiser.jsなど）を自動的に検出しますが、独自のルールファイルを指定できます。

 with :
  config-file : my-rules.json

構成ファイルの詳細については、公式ドキュメントを参照してください

クルーズスクリプトのカスタマイズ

このアクションは、パッケージマネージャーに基づいて、必要なフラグをクルーズスクリプトに自動的に追加します。たとえば、YARNを使用している場合、デフォルトのスクリプトは次のとおりです。

yarn run -s depcruise

したがって、追加のフラグを指定する必要はありません - アクションはそれらを自動的に処理します。したがって、必要なフラグを追加した後、アクションはこのコマンドを実行します。

 --output-type mermaid --config ${SPECIFIED_CONFIG_FILE} ${DIFF_FILE_A DIFF_FILE_B ...etc}

ただし、追加のオプションを使用できます。

 with :
  cruise-script : yarn run -s depcruise --exclude "^lib"

bun 、 npm 、またはpnpmでの使用

このアクションは自動的に依存関係をダウンロードします（デフォルトはYARNです）が、 bun 、 npm 、またはpnpmを指定することもできます。

 with :
  package-manager : npm

または

 with :
  package-manager : pnpm

ワーキングディレクトリのカスタマイズ

このアクションを別のディレクトリで実行したい場合は、 working-directoryを指定します。

 with :
  working-directory : <dir> 

互換性

このアクションには、依存関係 - クルーザーv11.10.0以降が必要です。