dependency cruiser

의존성 순양함

종속성을 검증하고 시각화합니다. 당신의 규칙과 함께. 자바 스크립트. TypeScript. 커피 스크립트. 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 구성 파일 ^{1 2} 를 만듭니다.

할머니에게 물건을 보여주세요

SRC 폴더에서 종속성의 그래프를 만들려면 출력 유형 dot 로 종속성 순양함을 실행하고 결과에서 GraphViz Dot ^3을 실행합니다. 하나의 라이너에서 :

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

종속성 크루저 v12 이상 : 추가-코피그 옵션을 추가하십시오

종속성 크루저 v13 이상에서는 필요하지 않지만 v12 이상에서-config 옵션을 전달하여 .dependency-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 에 일부 규칙을 추가하여 원형 종속성 , Package.json, Orphans 에서 누락 된 종속성 및 Dev- 또는 OptionalDependencies에 의존하는 생산 코드와 같은 규칙을 추가했습니다.

해당 파일을 조정하여 자신의 규칙을 추가하십시오.

샘플 규칙 :

{
  "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 옵션을 전달하여 .Dependency-Cruiser.js 구성 파일을 찾도록해야합니다.

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

이는 귀하의 규칙에 대한 검증이 발생하고 Eslint와 같은 형식의 위반을 보여줍니다.

검증을보고하는 방법에는 더 많은 방법이 있습니다. 그래프 (이 readme 위에있는 것과 같은) 또는 자체 포함 html 파일에서.

• 명령 줄 인터페이스 문서에서 ERR, DOT, CSV 및 HTML 리포터에 대해 자세히 알아보십시오.
• 의존성 크루저는 자체 빌드 프로세스에서 자체를 확인하기 위해 스스로를 사용합니다. package.json의 depcruise 스크립트를 참조하십시오

나는 더 알고 싶다!

당신은 올바른 장소에 왔습니다 :-) :

• 용법
  • 명령 줄 참조
  • 쓰기 규칙
  • 규칙 참조
  • 옵션 참조
  • FAQ
• 의존성 크루저에 대한 해킹
  • API
  • 출력 형식
  • 다른 출력 형식 추가
  • 다른 Alt-JS 언어에 대한 지원 추가
• 다른 것들
  • 로드맵
  • 연락하다
  • 실제 쇼 케이스
  • TypeScript, CoffeeScript 및 LiveScript 지원
  • .jsx, .tsx, .csx/ .cjsx, .vue 및 .svelte 지원
  • 웹 팩 별명/ 모듈 지원

특허

MIT

감사해요

• Marijn Haverbeke와 Acorn에서 공동 작업 한 다른 사람들 - 우수한 JavaScript Parser Dependency -Cruiser는 의존성을 추론하는 데 사용합니다.
• 의존성 크루저의 소셜 미디어 이미지에서 Ollie에 대한 Undraw의 Katerina limpitsouni.
• 문제를 제기하고 질문을하고 의존성 크루저가 더 나은 도구가되도록 풀 요청을 할만 큼 친절한 오픈 소스 커뮤니티의 모든 구성원.

상태 빌드 상태

만들어 졌어? 네덜란드에서.

각주

1. 편의를 위해 예제 스크립트에서 npx 사용하고 있습니다. package.json 의 스크립트에서 명령을 사용하면 npx 로 접두사를 접두사 할 필요가 없습니다. ↩

2. npx 사용하지 않고 pnpx ( pnpm 패키지 관리자) 또는 yarn 를 사용하려면 해당 도구의 문서를 참조하십시오. 특히 pnpx npx 와는 상당히 다른 의미를 가지고 있으며 사용하기 전에 알고 싶어합니다. 그동안 : npx npm 과 다른 패키지 관리자를 사용하여 종속성을 설치했을 때에도 작동 해야합니다 . ↩

3. 이것은 GraphViz dot 명령을 사용할 수 있다고 가정합니다. 대부분의 Linux 및 비슷한 시스템에서는 이것이 될 것입니다. 그렇지 않은 경우 컴퓨터에서 가져 오는 방법에 대한 지침은 GraphViz의 다운로드 페이지를 참조하십시오. ↩