dependency cruiser report action

依賴性挑戰者報告

一個github動作，以可視化更改文件的依賴性每個拉請請求。

該動作使用依賴性捕距來輸出Mermaid.js的語法。受開袖覆蓋的報告的啟發。

用法

在您的項目中安裝

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 

高級用法

指定配置文件

此操作會自動檢測依賴關係 - cruiser config file（ .dependency-cruiser.js等），但是您可以指定自己的規則文件。

 with :
  config-file : my-rules.json

有關配置文件的更多信息，請參閱官方文檔

自定義巡航腳本

此操作會根據軟件包管理器自動將必要標誌添加到您的Cruise腳本中。例如，如果您使用的是紗線，則默認腳本是：

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使用

此操作將自動下載依賴項（默認為紗線），但您也可以指定bun ， npm或pnpm ：

 with :
  package-manager : npm

或者

 with :
  package-manager : pnpm

自定義工作目錄

如果要在另一個目錄中運行此操作，請指定working-directory ：

 with :
  working-directory : <dir> 

相容性

此操作需要依賴性 - 捕獲器V11.10.0或更新。