dependency cruiser

Cruiser de dependência

Validar e visualizar dependências. Com suas regras. JavaScript. TypeScript. CoffeeScript. ES6, Commonjs, AMD.

O que isso faz?

Isso percorre as dependências em qualquer projeto JavaScript, TypeScript, LiveScript ou CoffeeScript e ...

• ... valida -os contra (suas próprias) regras
• ... Relatórios violaram as regras
  • no texto (para suas construções)
  • em gráficos (para seus olhos)

Como efeito colateral, ele pode gerar gráficos de dependência em vários formatos de saída, incluindo visualizações legais, você pode grudar na parede para impressionar sua avó.

Como eu uso isso?

Instale ...

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

... e gerar uma configuração

npx depcruise --init

Isso olhará um pouco em seu ambiente, fará algumas perguntas e criará um arquivo de configuração .dependency-cruiser.js em sintonia com o seu projeto ^{1 2} .

Mostre coisas para sua avó

Para criar um gráfico das dependências na sua pasta SRC, você executaria o Cruiser de dependência com o dot de saída e executaria o GraphViz Dot ³ no resultado. Em um revestimento:

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

dependência-cruzador v12 e mais antigo: Adicionar-Config opção

Embora não seja necessário do V13 de dependência-cruzador e posterior, no V12 e mais antigo, você terá que passar na opção-Config para fazê-lo encontrar o arquivo de configuração .Dependência-cruiser.js:

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

• Você pode ler mais sobre o que pode fazer com --include-only e outras opções de linha de comando na documentação da interface da linha de comando.
• As amostras do mundo real contêm cruzeiros de dependência de alguns dos projetos mais usados ​​no NPM.
• Se sua avó gosta mais de formatos como mermaid , json , csv , html ou texto simples, também a cobrimos.

Validar coisas

Declarar algumas regras

Quando você executou depcruise --init acima, o comando também adicionou algumas regras ao .dependency-cruiser.js que fazem sentido na maioria dos projetos, como detectar dependências circulares , dependências ausentes no package.json, órfãs e código de produção depender de dev ou opcionalDependências.

Comece a adicionar suas próprias regras aprimorando esse arquivo.

Regra de amostra:

{
  "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 " }
    }
  ]
}

• Para ler mais sobre as regras de redação, verifique o tutorial das regras de escrita ou a referência de regras

Relate -os

npx depcruise src

dependência-cruzador v12 e mais antigo: Adicionar-Config opção

Embora não seja necessário do V13 de dependência-cruzador, no V12 e mais antigo, você terá que passar na opção-Config para fazê-lo encontrar o arquivo de configuração .Dependência-cruiser.js:

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

Isso validará contra suas regras e mostrará violações em um formato semelhante a Eslint:

Existem mais maneiras de relatar validações; em um gráfico (como o em cima deste readme) ou em um arquivo html autônomo.

• Leia mais sobre os repórteres ERR, DOT, CSV e HTML na documentação da interface da linha de comando.
• O cruzador de dependência se usa para verificar em seu próprio processo de construção; Veja o script depcruise no package.json

Eu quero saber mais!

Você veio ao lugar certo :-):

• Uso
  • Referência da linha de comando
  • REGRAS DE ESCRITÓRIO
  • Referência de regras
  • Referência de opções
  • Perguntas frequentes
• Hackeando em cruzador de dependência
  • API
  • Formato de saída
  • Adicionando outros formatos de saída
  • Adicionando suporte para outros idiomas Alt-JS
• Outras coisas
  • Rodoteto
  • Contato
  • Casos de show do mundo real
  • TypeScript, CoffeeScript e LiveScript Suporte
  • Suporte para .jsx, .tsx, .csx/ .cjsx, .vue e .svelte
  • Suporte de alias/ módulos Webpack

Licença

Mit

Obrigado

• Marijn Haverbeke e outras pessoas que colaboraram no ACORN - o excelente cítrico de dependência do Parser JavaScript usa para inferir dependências.
• Katerina Limpitsouni de Uncraw para o Ollie na imagem de mídia social do Cruiser de dependência.
• Todos os membros da comunidade de código aberto que tiveram a gentileza de levantar problemas, fazer perguntas e fazer pedidos de puxar para que o cruzador de dependência seja uma ferramenta melhor.

Construir status

Feito com? na Holanda.

Notas de rodapé

1. Estamos usando npx nos scripts de exemplo por conveniência. Quando você usa os comandos em um script no package.json não é necessário prefixá -los com npx . ↩

2. Se você não deseja usar npx , mas, em vez disso, pnpx (do gerenciador de pacotes pnpm ) ou yarn - consulte a documentação dessa ferramenta. Particularmente, pnpx possui semântica que diferem do npx bastante significativamente e que você deseja conhecer antes de usá -lo. Nesse meio tempo: npx deve funcionar mesmo quando você instalou a dependência com um gerenciador de pacotes diferente do npm . ↩

3. Isso pressupõe que o comando GraphViz dot esteja disponível - na maioria dos sistemas Linux e comparável, este será. Caso não esteja, consulte a página de download do GraphViz para obter instruções sobre como obtê -lo em sua máquina. ↩