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或更新。