dependency cruiser

Крейсер зависимости

Проверить и визуализировать зависимости. С вашими правилами. JavaScript. Машинопись. CoffeeScript. Es6, Commonjs, Amd.

Что это делать?

Это проходит через зависимости в любом проекте JavaScript, TypeScript, Livescript или CoffeeScript и ...

• ... подтверждает их против (ваших собственных) правил
• ... Отчеты нарушены правила
  • в тексте (для ваших сборков)
  • в графике (для ваших глазных яблок)

В качестве побочного эффекта он может генерировать графики зависимости в различных выходных форматах, включая прохладные визуализации, которые вы можете придерживаться стены, чтобы произвести впечатление на бабушку.

Как мне его использовать?

Установите ...

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

... и создать конфигурацию

npx depcruise --init

Это немного будет ^{осмотреть} в вашей среде, задайте вам несколько вопросов и создайте файл ^{конфигурации} .dependency-cruiser.js

Покажите вещи своей бабушке

Чтобы создать график зависимостей в вашей папке SRC, вы запустите крейсер Degy Dependency с dot Type Type и запустите Dot Dot ³ в результате. В одном лайнере:

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

Зависимость-Круйзер V12 и старше: добавить-опция конфигурации

Несмотря на то, что не требуется от зависимостей V13 и позже, в V12 и старше вам придется передать опцию-config, чтобы найти файл конфигурации.

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 , которые имеют смысл в большинстве проектов, таких как обнаружение круговых зависимостей , зависимости, отсутствующих в Package.json, сиротах и ​​производственном коде, опираясь на разработки или опционы.

Начните добавлять свои собственные правила, настраивая этот файл.

Правило примера:

{
  "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 и старше: добавить-опция конфигурации

Несмотря на то, что он не требуется от зависимостей-Кризера V13, в V12 и старше вам придется передать опцию-config, чтобы найти файл конфигурации.

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

Это подтвердит ваши правила и показывает любые нарушения в формате, подобном Eslint:

Есть больше способов сообщить о валидациях; на графике (например, на вершине этого чтения) или в самодостаточном html файле.

• Узнайте больше о репортерах ERR, DOT, CSV и HTML в документации интерфейса командной строки.
• Зависимость-Крайзер использует себя, чтобы проверить себя в своем собственном процессе сборки; Смотрите сценарий depcruise в Package.json

Я хочу знать больше!

Вы пришли в нужное место :-):

• Использование
  • Ссылка на командную строку
  • Написание правил
  • Правила ссылка
  • Опции ссылка
  • Часто задаваемые вопросы
• Взлом на зависимость
  • API
  • Выходной формат
  • Добавление других выходных форматов
  • Добавление поддержки других языков Alt-JS
• Другие вещи
  • Дорожная карта
  • Контакт
  • Реал -шоу показывает случаи
  • TypeScript, CoffeeScript и поддержка Livescript
  • Поддержка .jsx, .tsx, .csx/ .cjsx, .vue и .svelte
  • WebPack Alias/ Modules поддержка

Лицензия

Грань

Спасибо

• Marijn Haverbeke и другие люди, которые сотрудничали на Acorn - отличный JavaScript Parser -Cruiser использует для вывода зависимостей.
• Katerina Limpitsouni of Undraw для Ollie в имидже в социальных сетях зависимостей.
• Все члены сообщества с открытым исходным кодом, которые были достаточно любезны, чтобы поднять проблемы, задавать вопросы и сделать запросы на привлечение, чтобы заставить зависимость-лучший инструмент.

Статус сборки

Сделано с? в Голландии.

Сноски

1. Мы используем npx в примере сценариев для удобства. Когда вы используете команды в сценарии в package.json нет необходимости префикс их с помощью npx . ↩

2. Если вы не хотите использовать npx , но вместо этого pnpx (от менеджера пакетов pnpm ) или yarn - пожалуйста, обратитесь к документации этого инструмента. В частности, pnpx имеет семантику, которая отличается от npx , и о том, что вы хотите знать, прежде чем использовать его. В то же время: npx должен работать, даже когда вы устанавливаете зависимость с диспетчера пакетов, отличающимся от npm . ↩

3. Это предполагает, что команда Graphviz dot доступна - на большинстве Linux и сопоставимых систем, что это будет. В случае, если это не так, см. Страницу загрузки Graphviz 'для инструкций о том, как получить ее на своей машине. ↩