qossmic / deptrac
Deptrac is a static code analysis tool that helps to enforce rules for dependencies between software layers.
Installs: 1 450 140
Dependents: 13
Suggesters: 0
Security: 0
Stars: 2 675
Watchers: 43
Forks: 134
Open Issues: 36
Requires
- php: ^8.1
- ext-json: *
Suggests
- ext-dom: For using the JUnit output formatter
- dev-main
- 3.0.x-dev
- 2.0.x-dev
- 2.0.4
- 2.0.3
- 2.0.2
- 2.0.1
- 2.0.0
- 2.0.0.beta
- 2.0.0-alpha
- 1.0.x-dev
- 1.0.3
- 1.0.2
- 1.0.1
- 1.0.0
- 0.24.0
- 0.23.0
- 0.22.1
- 0.22.0
- 0.21.1
- 0.21.0
- 0.20.0
- 0.19.3
- 0.19.2
- 0.19.1
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.2
- 0.15.1
- 0.15.0
- 0.14.1
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.1
- 0.11.0
- 0.10.3
- 0.10.2
- 0.10.1
- 0.10.0
- 0.9.0
- 0.8.2
- 0.8.1
- 0.8.0
- 0.7.1
- 0.7.0
- 0.6.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- dev-poc/scoped-deptrac-src
This package is auto-updated.
Last update: 2024-12-21 22:58:44 UTC
README
Deptrac is a static code analysis tool for PHP that helps you communicate, visualize and enforce architectural decisions in your projects. You can freely define your architectural layers over classes and which rules should apply to them.
For example, you can use Deptrac to ensure that bundles/modules/extensions in your project are truly independent of each other to make them easier to reuse.
Deptrac can be used in a CI pipeline to make sure a pull request does not violate any of the architectural rules you defined. With the optional Graphviz or Mermaidjs formatter you can visualize your layers, rules and violations.
Documentation
You can find the documentation in the /docs directory or visit the doc page: https://qossmic.github.io/deptrac
Getting Started
You can install Deptrac via Composer. We recommend using the deptrac package for this:
composer require --dev qossmic/deptrac
Once you have downloaded/installed deptrac, you will need to create a
configuration file, where you define your layers and
communication ruleset. This configuration file is written in YAML or php and, by default,
is stored with the name deptrac.yaml
in your project's root directory.
Deptrac can generate a template for you, using the init
command.
vendor/bin/deptrac init
When you have this file, you can analyse your code by
running the analyse
command:
vendor/bin/deptrac # which is equivalent to vendor/bin/deptrac analyse --config-file=deptrac.yaml
In order to run Deptrac you need at least PHP 8.1.
You can analyse projects that require an older PHP version as long as nikic/php-parser can parse it.
How to Contribute
See the contribution guide or go to development repository qossmic/deptrac-src.
Further Documentation
- Backwards Compatibility - General info on how we approach backwards compatibility
- Upgrade Guide - List of backwards breaking changes that need to be addressed when upgrading Deptrac to a new version and how to do it.
- Core Concepts - Explains layers, rules and violations in more details.
- Configuration - Reference for all available settings in a depfile
- Collectors - Reference for which collectors are available in Deptrac to define your layers.
- Formatters - Lists the different output formats supported by Deptrac
- Debugging - Overview of the debug commands
- Code Of Conduct - Our community standards
- Contribute - Advice for contributing code changes, e.g. how to run tests or how to build a phar file with your changes that you can use to analyse your projects
- Security Guide - How to report security vulnerabilities