Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://qossmic.github.io/deptrac/
Keep your architecture clean.
https://qossmic.github.io/deptrac/
architecture clean-architecture php
Last synced: 4 days ago
JSON representation
Keep your architecture clean.
- Host: GitHub
- URL: https://qossmic.github.io/deptrac/
- Owner: qossmic
- License: mit
- Created: 2015-10-30T15:28:28.000Z (about 9 years ago)
- Default Branch: 2.0.x
- Last Pushed: 2024-10-28T08:04:00.000Z (19 days ago)
- Last Synced: 2024-11-04T12:38:35.602Z (12 days ago)
- Topics: architecture, clean-architecture, php
- Language: PHP
- Homepage: https://qossmic.github.io/deptrac
- Size: 25.2 MB
- Stars: 2,637
- Watchers: 44
- Forks: 135
- Open Issues: 37
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: docs/CONTRIBUTING.md
- Code of conduct: docs/CODE_OF_CONDUCT.md
- Security: docs/SECURITY.md
Awesome Lists containing this project
README
# 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
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](https://github.com/qossmic/deptrac) package for this:
```console
composer require --dev qossmic/deptrac
```
Once you have downloaded/installed deptrac, you will need to create a
[configuration file](docs/index.md#configuration), 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.
```console
vendor/bin/deptrac init
```
When you have this file, you can analyse your code by
running the `analyse` command:
```console
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](https://github.com/nikic/PHP-Parser) can parse it.
## How to Contribute
See the [contribution guide](docs/CONTRIBUTING.md) or go to development repository [qossmic/deptrac-src](https://github.com/qossmic/deptrac-src).
## Further Documentation
* [Backwards Compatibility](docs/bc_policy.md) - General info on how we approach
backwards compatibility
* [Upgrade Guide](docs/upgrade.md) - List of backwards breaking changes that
need to be addressed when upgrading Deptrac to a new version and how to do it.
* [Core Concepts](docs/concepts.md) - Explains layers, rules and violations in
more details.
* [Configuration](docs/configuration.md) - Reference for all available settings
in a depfile
* [Collectors](docs/collectors.md) - Reference for which collectors are
available in Deptrac to define your layers.
* [Formatters](docs/formatters.md) - Lists the different output formats
supported by Deptrac
* [Debugging](docs/debugging.md) - Overview of the debug commands
* [Code Of Conduct](docs/CODE_OF_CONDUCT.md) - Our community standards
* [Contribute](docs/CONTRIBUTING.md) - 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](docs/SECURITY.md) - How to report security vulnerabilities