dependency cruiser

依赖巡洋舰

验证和可视化依赖项。有了你的规则。 JavaScript。打字稿。咖啡本。 ES6，commonjs，amd。

这是什么？

这贯穿于任何JavaScript，Typescript，Livestript或Coffeescript项目中的依赖项和...

• ...根据（您自己的）规则验证他们
• ...报告违反规则
  • 在文本中（用于您的构建）
  • 在图形中（为您的眼球）

作为副作用，它可以以各种输出格式生成依赖图，包括凉爽的可视化，您可以粘在墙上以打动奶奶。

我该如何使用？

安装...

npm install --save-dev dependency-cruiser
# or
yarn add -D dependency-cruiser
pnpm add -D dependency-cruiser

...并生成配置

npx depcruise --init

这将在您的环境中稍微环顾四周，问您一些问题，并创建一个.dependency-cruiser.js配置文件，该文件适合您的项目^{1 2} 。

向奶奶展示东西

要在SRC文件夹中创建依赖项的图，您将使用输出类型dot运行依赖巡洋舰，并在结果上运行GraphViz Dot ³ 。在一个衬里：

npx depcruise src --include-only " ^src " --output-type dot | dot -T svg > dependency-graph.svg

依赖性 - 捕痕V12及以上：add-Config选项

虽然从依赖项 - cruiser v13及以后不需要必要，但是在V12及以后，您必须通过-Config选项，以使其找到.conipendenty-cruiser.js配置文件：

npx depcruise src --include-only " ^src " --config --output-type dot | dot -T svg > dependency-graph.svg

• 您可以在命令行界面文档中阅读有关您可以使用的信息--include-only命令行选项。
• 现实世界样本包含NPM上一些最常用的项目的依赖巡航。
• 如果您的祖母更喜欢mermaid ， json ， csv ， html或纯文本等格式，那么我们也会覆盖她。

验证事物

声明一些规则

当您在上面运行depcruise --init时，该命令还为.dependency-cruiser.js添加了一些规则，这些规则在大多数项目中都是有意义的，例如检测循环依赖项，套件中缺少的依赖项。

通过调整该文件开始添加自己的规则。

样本规则：

{
  "forbidden" : [
    {
      "name" : " not-to-test " ,
      "comment" : " don't allow dependencies from outside the test folder to test " ,
      "severity" : " error " ,
      "from" : { "pathNot" : " ^test " },
      "to" : { "path" : " ^test " }
    }
  ]
}

• 要阅读有关写入规则的更多信息，请检查写作规则教程或规则参考

报告他们

npx depcruise src

依赖性 - 捕痕V12及以上：add-Config选项

虽然从依赖关系 - 捕获器V13中没有必要，但是在V12及以上，您必须传递 - config选项才能使其找到.epentendency-cruiser.js配置文件：

npx depcruise --config .dependency-cruiser.js src

这将根据您的规则来验证，并以类似Eslint的格式显示出任何违规行为：

还有更多报告验证的方法；在图中（如此读数的顶部）或在含有自我的html文件中。

• 在命令行接口文档中阅读有关ERR，DOT，CSV和HTML记者的更多信息。
• 依赖性捕捞者在自己的构建过程中使用自身来检查自己；请参阅包装中的depcruise脚本。

我想知道更多！

您来对地方:-)：：

• 用法
  • 命令行参考
  • 写作规则
  • 规则参考
  • 选项参考
  • 常问问题
• 黑客依赖性捕捞者
  • API
  • 输出格式
  • 添加其他输出格式
  • 增加对其他Alt-JS语言的支持
• 其他事情
  • 路线图
  • 接触
  • 现实世界展示案例
  • 打字稿，咖啡本和寿命支持
  • 支持.jsx，.tsx，.csx/ .cjsx，.vue和.svelte
  • WebPack别名/模块支持

执照

麻省理工学院

谢谢

• Marijn Haverbeke和其他在Acorn合作的人 - 出色的JavaScript Parser依赖 - 挑战者用于推断依赖性。
• Ollie的Katerina Limpitsouni在依赖性挑战者的社交媒体形象中。
• 开源社区的所有成员都足够友善地提出问题，提出问题并提出拉力请求，以使依赖诉讼者成为更好的工具。

建立状态

与？在荷兰。

脚注

1. 为了方便起见，我们在示例脚本中使用npx 。当您在package.json中使用脚本中的命令时。JSON不必以npx前缀。 ↩

2. 如果您不想使用npx ，而是pnpx （来自pnpm软件包管理器）或yarn - 请参阅该工具的文档。特别是pnpx语义与npx有很大不同，并且您想在使用之前要注意。同时：即使您使用与npm不同的软件包管理器安装了依赖项， npx也应该工作。 ↩

3. 假设可以使用GraphViz dot命令 - 在大多数Linux和可比较的系统上。如果不是，请参见GraphViz的下载页面，以获取有关如何在计算机上获取的说明。 ↩