Skip to content

Latest commit

 

History

History
111 lines (79 loc) · 5.98 KB

README.md

File metadata and controls

111 lines (79 loc) · 5.98 KB

Drupal coder Docker images

This repository has several Docker images for Drupal code quality analysis...

  • eslint-es5-drupal which runs Drupal's ECMAScript 5 coding standards lints,
  • eslint-es6-drupal which runs Drupal's ECMAScript 6 coding standards lints,
  • phpcs-drupal which runs Drupal's coding standards lints,
  • phpcs-drupalpractice which runs Drupal's best practices lints,
  • stylelint which runs Drupal's CSS coding standards lints,

As well as some other useful tools...

  • dephpend which performs dependency analysis on a PHP project and its classes,
  • jsonlint which performs JSON syntax linting,
  • phpcpd ("PHP copy paste detector") which looks for duplicated code in a PHP project and its classes,
  • phpmetrics which generates a detailed report of metrics about a PHP project and its classes,
  • phpstan-drupal ("PHP static analysis - Drupal") which performs static analysis on a Drupal project,

... and several Docker images to automatically fix code quality issues...

  • phpcbf-drupal which automatically fixes code to conform to Drupal's coding standards,
  • phpcbf-drupalpractice which automatically fixes code to conform to Drupal's best practices.

These Docker images are designed to be run-able even if eslint and/or PHPCodeSniffer and/or the Coder module are not installed on your Drupal site. This is done by installing eslint and/or PHPCodeSniffer and the lints into /opt inside the Docker image. This assumes that you mount your Drupal site's file system at /app. They're ideal for use with Lando, Docksal, etc.

Building

docker build -t eslint-es5-drupal ./eslint-es5-drupal/
docker build -t eslint-es6-drupal ./eslint-es6-drupal/
docker build -t phpcs-drupal ./phpcs-drupal/
docker build -t phpcbf-drupal ./phpcbf-drupal/
docker build -t phpcs-drupalpractice ./phpcs-drupalpractice/
docker build -t phpcbf-drupalpractice ./phpcbf-drupalpractice/
docker build -t stylelint ./stylelint/

docker build -t dephpend ./dephpend/
docker build -t jsonlint ./jsonlint/
docker build -t phpcpd ./phpcpd/
docker build -t phpmetrics ./phpmetrics/
docker build -t phpstan-drupal ./phpstan-drupal/

Running

If you've built the images locally, then you can run...

docker run --rm -v $PWD:/app eslint-es5-drupal $path_to_lint
docker run --rm -v $PWD:/app eslint-es6-drupal $path_to_lint
docker run --rm -v $PWD:/app phpcs-drupal $path_to_lint # --report=summary
docker run --rm -v $PWD:/app phpcbf-drupal $path_to_lint
docker run --rm -v $PWD:/app phpcs-drupalpractice $path_to_lint # --report=summary
docker run --rm -v $PWD:/app phpcbf-drupalpractice $path_to_lint
docker run --rm -v $PWD:/app stylelint $path_to_lint

docker run --rm -v $PWD:/app dephpend text $path_to_lint
docker run --rm -v $PWD:/app jsonlint $path_to_lint
docker run --rm -v $PWD:/app phpcpd $path_to_lint
docker run --rm -v $PWD:/app phpmetrics $path_to_lint
docker run --rm -v $PWD:/app phpstan-drupal $path_to_lint

... but I've also published these to mparker17's Docker Hub, so the following should work...

docker run --rm -v $PWD:/app mparker17/eslint-es5-drupal $path_to_lint
docker run --rm -v $PWD:/app mparker17/eslint-es6-drupal $path_to_lint
docker run --rm -v $PWD:/app mparker17/phpcs-drupal $path_to_lint # --report=summary
docker run --rm -v $PWD:/app mparker17/phpcbf-drupal $path_to_lint
docker run --rm -v $PWD:/app mparker17/phpcs-drupalpractice $path_to_lint # --report=summary
docker run --rm -v $PWD:/app mparker17/phpcbf-drupalpractice $path_to_lint

docker run --rm -v $PWD:/app mparker17/dephpend text $path_to_lint
docker run --rm -v $PWD:/app mparker17/jsonlint $path_to_lint
docker run --rm -v $PWD:/app mparker17/stylelint $path_to_lint
docker run --rm -v $PWD:/app mparker17/phpcpd $path_to_lint
docker run --rm -v $PWD:/app mparker17/phpmetrics $path_to_lint
docker run --rm -v $PWD:/app mparker17/phpstan-drupal $path_to_lint

Other tools

The dockerized-php project provides some code-quality-analysis tools that are not directly related to Drupal but are still pretty useful:

  • bmitch/churn-php identifies php files that could be good candidates for refactoring based on how many git commits they have and their cyclomatic complexity. Run with:

      docker run --rm -v $PWD:/app dockerizedphp/churn run $path_to_lint

  • infection/infection measures the effectiveness of a test set in terms of its ability to detect faults. Run with:

      docker run --rm -v $PWD:/app dockerizedphp/infection run $path_to_lint

  • psecio/iniscan scans a PHP.ini file to determine if it follows security best practices. Run with:

      docker run --rm -v /path/to/php.ini:/tmp dockerizedphp/iniscan scan --path=php.ini

  • phploc/phploc ("PHP lines of code") measures the comment+non-comment+logical lines of code in a set of PHP files, and analyzes their cyclomatic complexity, dependencies between them, and how they're structured, and provides a summary. Run with:

      docker run --rm -v $PWD:/app dockerizedphp/phploc $path_to_lint

  • povils/phpmnd ("PHP magic number detector") detects numeric and string literals that could change at a later stage, and would otherwise be hard to update unless they are turned into constants. Run with:

      docker run --rm -v $PWD:/app dockerizedphp/phpmnd $path_to_lint

  • phpmd/phpmd ("PHP mess detector") detects clean code problems, code size problems, design problems, naming problems, and unused code. Run with:

      docker run --rm -v $PWD:/app dockerizedphp/phpmd $path_to_lint text cleancode,codesize

  • rector/rector ("reconstructor") automatically refactors php code. Run with:

      docker run --rm -v $PWD:/project rector/rector:latest process $path_to_lint