2017 © Pedro Peláez
 

library deptrac

Deptrac is a static code analysis tool that helps to enforce rules for dependencies between software layers.

image

sensiolabs-de/deptrac

Deptrac is a static code analysis tool that helps to enforce rules for dependencies between software layers.

  • Friday, July 27, 2018
  • by andreashucks
  • Repository
  • 39 Watchers
  • 704 Stars
  • 1,394 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 44 Forks
  • 22 Open issues
  • 24 Versions
  • 37 % Grown

The README.md

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., (*1)

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., (*2)

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., (*3)

Documentation

You can find the documentation in the /docs directory or visit the doc page: https://qossmic.github.io/deptrac, (*4)

Getting Started

You can install Deptrac via Composer. We recommend using the deptrac-shim package for this:, (*5)

$ composer require --dev qossmic/deptrac-shim

Alternatively, you can also use PHIVE or download the PHAR 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., (*6)

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 and, by default, is stored with the name deptrac.yaml in your project's root directory., (*7)

Deptrac can generate a template for you, using the init command., (*8)

vendor/bin/deptrac init

When you have this file, you can analyse your code by running the analyse command:, (*9)

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., (*10)

You can analyse projects that require an older PHP version as long as nikic/php-parser can parse it., (*11)

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

The Versions

27/07 2018

dev-master

9999999-dev

Deptrac is a static code analysis tool that helps to enforce rules for dependencies between software layers.

  Sources   Download

MIT

The Requires

 

The Development Requires

by Avatar timglabisch

27/07 2018

dev-lazy-phar-updater

dev-lazy-phar-updater

Deptrac is a static code analysis tool that helps to enforce rules for dependencies between software layers.

  Sources   Download

MIT

The Requires

 

The Development Requires

by Avatar timglabisch

27/07 2018

dev-box-json-dist

dev-box-json-dist

Deptrac is a static code analysis tool that helps to enforce rules for dependencies between software layers.

  Sources   Download

MIT

The Requires

 

The Development Requires

by Avatar timglabisch

18/05 2018

dev-collector-registry

dev-collector-registry

Deptrac is a static code analysis tool that helps to enforce rules for dependencies between software layers.

  Sources   Download

MIT

The Requires

 

The Development Requires

by Avatar timglabisch

18/05 2018

dev-custom-regex

dev-custom-regex

Deptrac is a static code analysis tool that helps to enforce rules for dependencies between software layers.

  Sources   Download

MIT

The Requires

 

The Development Requires

by Avatar timglabisch

03/05 2018

dev-refactory-collector-registry-injection

dev-refactory-collector-registry-injection

Deptrac is a static code analysis tool that helps to enforce rules for dependencies between software layers.

  Sources   Download

MIT

The Requires

 

The Development Requires

by Avatar timglabisch

20/04 2018

dev-dependency-analyzer

dev-dependency-analyzer

Deptrac is a static code analysis tool that helps to enforce rules for dependencies between software layers.

  Sources   Download

MIT

The Requires

 

The Development Requires

by Avatar timglabisch

20/04 2018

dev-fix-collectors

dev-fix-collectors

Deptrac is a static code analysis tool that helps to enforce rules for dependencies between software layers.

  Sources   Download

MIT

The Requires

 

The Development Requires

by Avatar timglabisch

20/04 2018

dev-file-resolver

dev-file-resolver

Deptrac is a static code analysis tool that helps to enforce rules for dependencies between software layers.

  Sources   Download

MIT

The Requires

 

The Development Requires

by Avatar timglabisch

20/04 2018

dev-astrunner-inject-event-dispatcher

dev-astrunner-inject-event-dispatcher

Deptrac is a static code analysis tool that helps to enforce rules for dependencies between software layers.

  Sources   Download

MIT

The Requires

 

The Development Requires

by Avatar timglabisch

23/03 2018

dev-refactoring-configuration-loading-dumping

dev-refactoring-configuration-loading-dumping

Deptrac is a static code analysis tool that helps to enforce rules for dependencies between software layers.

  Sources   Download

MIT

The Requires

 

The Development Requires

by Avatar timglabisch

23/03 2018

dev-use-fqcn-as-service-ids

dev-use-fqcn-as-service-ids

Deptrac is a static code analysis tool that helps to enforce rules for dependencies between software layers.

  Sources   Download

MIT

The Requires

 

The Development Requires

by Avatar timglabisch

23/03 2018

dev-improve-service-configuration

dev-improve-service-configuration

Deptrac is a static code analysis tool that helps to enforce rules for dependencies between software layers.

  Sources   Download

MIT

The Requires

 

The Development Requires

by Avatar timglabisch

23/03 2018

dev-add-analyse-alias

dev-add-analyse-alias

Deptrac is a static code analysis tool that helps to enforce rules for dependencies between software layers.

  Sources   Download

MIT

The Requires

 

The Development Requires

by Avatar timglabisch

23/03 2018

0.2.0

0.2.0.0

Deptrac is a static code analysis tool that helps to enforce rules for dependencies between software layers.

  Sources   Download

MIT

The Requires

 

The Development Requires

by Avatar timglabisch

23/03 2018

dev-fix-directory-collector

dev-fix-directory-collector

Deptrac is a static code analysis tool that helps to enforce rules for dependencies between software layers.

  Sources   Download

MIT

The Requires

 

The Development Requires

by Avatar timglabisch

28/02 2018

dev-feature-directory-collector

dev-feature-directory-collector

Deptrac is a static code analysis tool that helps to enforce rules for dependencies between software layers.

  Sources   Download

MIT

The Requires

 

The Development Requires

by Avatar timglabisch

27/01 2018

dev-type-hints

dev-type-hints

Deptrac is a static code analysis tool that helps to enforce rules for dependencies between software layers.

  Sources   Download

MIT

The Requires

 

The Development Requires

by Avatar timglabisch

22/12 2017

dev-drop-php-eol

dev-drop-php-eol

Deptrac is a static code analysis tool that helps to enforce rules for dependencies between software layers.

  Sources   Download

MIT

The Requires

 

The Development Requires

by Avatar timglabisch

22/12 2017

dev-phpunit-namespaced

dev-phpunit-namespaced

Deptrac is a static code analysis tool that helps to enforce rules for dependencies between software layers.

  Sources   Download

MIT

The Requires

 

The Development Requires

by Avatar timglabisch

19/09 2017

dev-some-improvements

dev-some-improvements

Deptrac is a static code analysis tool that helps to enforce rules for dependencies between software layers.

  Sources   Download

MIT

The Requires

 

The Development Requires

by Avatar timglabisch

03/10 2016

dev-feature_phpparser3

dev-feature_phpparser3

Deptrac is a static code analysis tool that helps to enforce rules for dependencies between software layers.

  Sources   Download

MIT

The Requires

 

The Development Requires

by Avatar timglabisch

09/04 2016

dev-feature/methodname-collector

dev-feature/methodname-collector

  Sources   Download

The Requires

 

The Development Requires

by Avatar timglabisch

08/04 2016

dev-methodname-collector

dev-methodname-collector

  Sources   Download

The Requires

 

The Development Requires

by Avatar timglabisch