Support deptrac

[archfz]

It would be nice if deptrac was also support among the tools. It is useful to allow validating against architecturally disallowed dependencies.

[zdenekdrahos]

What configuration do you need?

$ vendor/bin/deptrac analyze --help

Arguments:
  depfile                                          Path to the depfile

Options:
      --formatter=FORMATTER                        Format in which to print the result of the analysis. Possible: ["console", "github-actions", "graphviz", "junit", "table", "xml", "baseline"] (multiple values allowed)
      --no-progress                                Do not show progress bar
      --fail-on-uncovered                          Fails if any uncovered dependency is found
      --report-uncovered                           Report uncovered dependencies
      --report-skipped                             Report skipped violations
      --graphviz-display[=GRAPHVIZ-DISPLAY]        Should try to open graphviz image. [default: true]
      --graphviz-dump-image[=GRAPHVIZ-DUMP-IMAGE]  Path to a dumped png file.
      --graphviz-dump-dot[=GRAPHVIZ-DUMP-DOT]      Path to a dumped dot file.
      --graphviz-dump-html[=GRAPHVIZ-DUMP-HTML]    Path to a dumped html file.
      --junit-dump-xml[=JUNIT-DUMP-XML]            Path to a dumped xml file. [default: "./junit-report.xml"]
      --xml-dump[=XML-DUMP]                        path to a dumped xml file [default: "./deptrac-report.xml"]
      --baseline-dump[=BASELINE-DUMP]              path to a dumped baseline file [default: "./depfile.baseline.yml"]
      --no-cache                                   Disable caching mechanisms
      --cache-file=CACHE-FILE                       [default: ".deptrac.cache"]

---

You can try initial version with console formatter:

$ composer update edgedesign/phpqa:dev-deptrac
$ phpqa --tools deptrac -v

[archfz]

Well at first its enough if it is able to load the depfile.yaml from root of project

[zdenekdrahos]

Yes, root file is used if deptrac.depfile is not configured:

$ phpqa --tools deptrac:0 -v
 [Edge\QA\Task\ParallelExec] Output for  "/phpqa/vendor/bin/deptrac" analyze  --formatter=console --report-uncovered
  In CouldNotReadFileException.php line 10:
  File "/phpqa/depfile.yaml" cannot be read.

[phpqa]
+---------+----------------+--------------+--------+-------------------+
| Tool    | Allowed Errors | Errors count | Is OK? | HTML report       |
+---------+----------------+--------------+--------+-------------------+
| deptrac | 0              | 1            | x      |                   |
+---------+----------------+--------------+--------+-------------------+

[phpqa] Failed tools: deptrac

[archfz]

Ok. Will test next week.

[archfz]

Tested it's working. Notify when released. As a suggestion I would keep issues open until they are added in an actual release.

[zdenekdrahos]

Released in v1.25 (demo)