deptrac

디프트랙

Deptrac은 프로젝트에서 아키텍처 결정을 전달, 시각화 및 시행하는 데 도움이 되는 PHP용 정적 코드 분석 도구입니다. 클래스에 대한 아키텍처 레이어와 클래스에 적용할 규칙을 자유롭게 정의할 수 있습니다.

예를 들어 Deptrac을 사용하면 프로젝트의 번들/모듈/확장 기능이 서로 진정으로 독립적인지 확인하여 쉽게 재사용할 수 있습니다.

Deptrac은 CI 파이프라인에서 끌어오기 요청이 정의한 아키텍처 규칙을 위반하지 않는지 확인하는 데 사용할 수 있습니다. 선택적 Graphviz 또는 Mermaidjs 포맷터를 사용하면 레이어, 규칙 및 위반을 시각화할 수 있습니다.

선적 서류 비치

/docs 디렉터리에서 문서를 찾거나 문서 페이지(https://qossmic.github.io/deptrac)를 방문할 수 있습니다.

시작하기

Composer를 통해 Deptrac을 설치할 수 있습니다. 이를 위해 deptrac 패키지를 사용하는 것이 좋습니다.

 composer require --dev qossmic/deptrac

deptrac을 다운로드/설치한 후에는 레이어와 통신 규칙 세트를 정의하는 구성 파일을 생성해야 합니다. 이 구성 파일은 YAML 또는 PHP로 작성되며 기본적으로 프로젝트의 루트 디렉터리에 deptrac.yaml 이름으로 저장됩니다.

Deptrac은 init 명령을 사용하여 템플릿을 생성할 수 있습니다.

 vendor/bin/deptrac init

이 파일이 있으면 analyse 명령을 실행하여 코드를 분석할 수 있습니다.

 vendor/bin/deptrac

# which is equivalent to
vendor/bin/deptrac analyse --config-file=deptrac.yaml

Deptrac을 실행하려면 최소한 PHP 8.1이 필요합니다.

nikic/php-parser가 구문 분석할 수 있는 한 이전 PHP 버전이 필요한 프로젝트를 분석할 수 있습니다.

기여하는 방법

기여 가이드를 보거나 개발 저장소 qossmic/deptrac-src로 이동하세요.

추가 문서

• 이전 버전과의 호환성 - 이전 버전과의 호환성에 접근하는 방법에 대한 일반 정보
• 업그레이드 가이드 - Deptrac을 새 버전으로 업그레이드할 때 해결해야 하는 이전 버전의 주요 변경 사항 목록과 수행 방법.
• 핵심 개념 - 레이어, 규칙 및 위반 사항을 더 자세히 설명합니다.
• 구성 - depfile에서 사용 가능한 모든 설정에 대한 참조
• 컬렉터 - 레이어를 정의하기 위해 Deptrac에서 사용할 수 있는 컬렉터에 대한 참조입니다.
• 포맷터 - Deptrac에서 지원하는 다양한 출력 형식을 나열합니다.
• 디버깅 - 디버그 명령 개요
• 행동 강령 - 커뮤니티 표준
• 기여 - 코드 변경 기여에 대한 조언(예: 테스트 실행 방법, 프로젝트 분석에 사용할 수 있는 변경 사항이 포함된 phar 파일 빌드 방법)
• 보안 가이드 - 보안 취약점을 신고하는 방법