Skip to content
main
Switch branches/tags
Code

Latest commit

Add upgrade guide to docs and add install instructions to GitHub-README
6aff9f3

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
Jan 11, 2022

Deptrac

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 formatter you can visualize your layers, rules and violations.

Stability

Deptrac is still in development. We follow semantic versioning. You should expect breaking changes between minor versions in 0.x. We advise following the upgrade guide for any breaking changes between releases and how to address them.

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-shim package for this:

composer require --dev qossmic/deptrac-shim

Alternatively, you can also use Phive or download the binary attached to each release on GitHub. We strongly advise against using the deptrac package directly as a composer dependency. We update dependencies regularly, which might cause disruptions in your project.

Once you have downloaded the phar file, you will need to create a configuration file, where you define your layers and communication ruleset. When you have this file, you can analyse your code by running the analyse command:

php deptrac.phar

# which is equivalent to
php deptrac.phar analyse --config-file=deptrac.yaml

Contribute

Deptrac is in active development. We are looking for your suggestions and help to make it better.

Feel free to open an issue if you encounter bugs, have suggestions or would like to add a new feature to Deptrac.

Please feel free to improve this documentation, fix bugs, or work on a suggested feature by making a pull request on GitHub. Don't hesitate to ask for support, if you need help at any point.

The Contribution Guide in the documentation contains some advice for making a pull request with code changes.

Code of Conduct

If you are professional and polite then everything will be alright.

Please don't be inconsiderate or mean, or anything in between.