<commit_before># php-code-quality
The objective is to include multiple PHP code quality tools in an easy to use Docker image. The 
tools include PHP static analysis, lines of PHP code report, mess detector, code smell highlighting, 
copy/paste detection, and the application compatibility from one version of PHP to another for modernization efforts.

More specifically the Docker image includes:

- phpstan/phpstan
- squizlabs/php_codesniffer
- phpcompatibility/php-compatibility
- phploc/phploc
- phpmd/phpmd
- pdepend/pdepend
- sebastian/phpcpd
- phpmetrics/phpmetrics
- phpunit/phpunit
- friendsofphp/php-cs-fixer

## Usage

Note: This image does nothing when invoking it without a followup command, such as:

```
$ cd </path/to/desired/directory>
$ docker run -it --rm -v "$PWD":/app -w /app adamculp/php-code-quality:latest <desired-command-with-arguments>
```

See additional portions of the command below.

Windows users: The use of "$PWD" for present working directory will not work as expected, instead use the full path. 
Such as "//c/Users/adamculp/project".

In the example above, Docker runs an interactive terminal to be removed when all is completed, and mounts the current host directory ($PWD) inside the container, sets this as the current working directory, and then loads the image adamculp/php-code-quality.

Following this the user can add any commands to be executed within the container. (such as running the tools provided by the image)

This is the most common use case, enabling the user to run the tools on everything in and/or below the working 
directory.

Available commands provided by the adamculp/php-code-quality image:

* php + args
* composer + args
* vendor/bin/phpstan + args
* vendor/bin/phpcs + args
* vendor/bin/phploc + args
* vendor/bin/phpmd + args
* vendor/bin/pdepend + args
* vendor/bin/phpcpd + args
* vendor/bin/phpmetrics + args
* vendor/bin/phpunit + args
* vendor/bin/php-cs-fixer + args

* sh (or any other command) + args

### Some example commands:

IMPORTANT: If using the commands below "as-is", please create a 'php_code_quality' folder within the project first. This will be used, by the commands, to contain the results of the various tools. Modify as desired.

IMPORTANT: If you run into memory issues, where the output states the process ran out of memory, you can alter the amount of memory the PHP process uses for a given command by adding the -d flag to the PHP command. Note that the following example is for extreme cases since the image already sets the memory limit to 512M. (not recommended)

```
php -d memory_limit=1G
```

#### PHPStan

See [PHPStan Documentation](https://phpstan.org/user-guide/getting-started) for more documentation on use.

```
$ docker run -it --rm -v "$PWD":/app -w /app adamculp/php-code-quality:latest sh -c \
'php /usr/local/lib/php-code-quality/vendor/bin/phpstan analyse -l 0 \ 
--error-format=raw > ./php_code_quality/phpcompatibility_results.txt .'
```

#### PHP Codesniffer (phpcs)

See [PHP_CodeSniffer Wiki](https://github.com/squizlabs/PHP_CodeSniffer/wiki) for more usage details of this tool.

```
$ docker run -it --rm -v "$PWD":/app -w /app adamculp/php-code-quality:latest \
php /usr/local/lib/php-code-quality/vendor/bin/phpcs -sv --extensions=php --ignore=vendor \
--report-file=./php_code_quality/codesniffer_results.txt .
```

#### PHPCompatibility rules applied to PHP Codesniffer

See [PHPCompatibility Readme](https://github.com/PHPCompatibility/PHPCompatibility) and [PHP_CodeSniffer Wiki](https://github.com/squizlabs/PHP_CodeSniffer/wiki) above for more usage details of this tool. PHPCompatibility is a collection of sniffs to be used with PHP_CodeSniffer.

```
$ docker run -it --rm -v "$PWD":/app -w /app adamculp/php-code-quality:latest sh -c \
'php /usr/local/lib/php-code-quality/vendor/bin/phpcs -sv --config-set installed_paths  /usr/local/lib/php-code-quality/vendor/phpcompatibility/php-compatibility && \
php /usr/local/lib/php-code-quality/vendor/bin/phpcs -sv --standard='PHPCompatibility' --extensions=php --ignore=vendor . \
--report-file=./php_code_quality/phpcompatibility_results.txt .'
```

#### PHP Lines of Code (PHPLoc)

See [PHPLOC Readme](https://github.com/sebastianbergmann/phploc) for more usage details of this tool.

```
$ docker run -it --rm -v "$PWD":/app -w /app adamculp/php-code-quality:latest \
php /usr/local/lib/php-code-quality/vendor/bin/phploc -v --names "*.php" \
--exclude "vendor" . > ./php_code_quality/phploc.txt
```

#### PHP Mess Detector (phpmd)

See [PHPMD Readme](https://github.com/phpmd/phpmd) for more usage details of this tool.

```
$ docker run -it --rm -v "$PWD":/app -w /app adamculp/php-code-quality:latest \
php /usr/local/lib/php-code-quality/vendor/bin/phpmd . xml codesize --exclude 'vendor' \
--reportfile './php_code_quality/phpmd_results.xml'
```

#### PHP Depends (Pdepend)

See [PDepend Docs](https://pdepend.org/) for more usage details of this tool.

Note: I haven't used this for awhile, and notice it may require a Tidelift subscription for use.

```
$ docker run -it --rm -v "$PWD":/app -w /app adamculp/php-code-quality:latest \
php /usr/local/lib/php-code-quality/vendor/bin/pdepend --ignore='vendor' \
--summary-xml='./php_code_quality/pdepend_output.xml' \
--jdepend-chart='./php_code_quality/pdepend_chart.svg' \
--overview-pyramid='./php_code_quality/pdepend_pyramid.svg' .
```

#### PHP Copy/Paste Detector (phpcpd)

See [PHPCPD Readme](https://github.com/sebastianbergmann/phpcpd) for more usage details of this tool.

```
$ docker run -it --rm -v "$PWD":/app -w /app adamculp/php-code-quality:latest \
php /usr/local/lib/php-code-quality/vendor/bin/phpcpd . \
--exclude 'vendor' > ./php_code_quality/phpcpd_results.txt
```

#### PHPMetrics

See http://www.phpmetrics.org/ for more usage details of this tool.

```
$ docker run -it --rm -v "$PWD":/app -w /app adamculp/php-code-quality:latest \
php /usr/local/lib/php-code-quality/vendor/bin/phpmetrics --excluded-dirs 'vendor' \
--report-html=./php_code_quality/metrics_results .
```

## Alternative Preparations

Rather than allowing Docker to retrieve the image from Docker Hub, users could also build the docker image locally by cloning the image repo from Github.

Why? As an example, a different version of PHP may be desired. Or a specific version of any tools might be required.

After cloning, navigate to the location:
<commit_msg>Added steps to use Github container repository, and updated paths to comply with current conventions.<commit_after># php-code-quality
The objective is to include multiple PHP code quality tools in an easy to use Docker image. The 
tools include PHP static analysis, lines of PHP code report, mess detector, code smell highlighting, 
copy/paste detection, and the application compatibility from one version of PHP to another for modernization efforts.

More specifically the Docker image includes:

- phpstan/phpstan
- squizlabs/php_codesniffer
- phpcompatibility/php-compatibility
- phploc/phploc
- phpmd/phpmd
- pdepend/pdepend
- sebastian/phpcpd
- phpmetrics/phpmetrics
- phpunit/phpunit
- friendsofphp/php-cs-fixer

## Usage

Note: This image does nothing when invoking it without a followup command (as shown below in `Some example commands` for each tool), such as:

```
$ cd </path/to/desired/directory>
$ docker run -it --rm -v "$PWD":/usr/src/myapp -w /usr/src/myapp \
adamculp/php-code-quality:latest <followup-command-with-arguments>
```

Also, note the example above is for using the Docker Hub repository. Alternatively, you can also use the Github Package repository as well by prepending `ghcr.io/` to the image identifier, like the following:

```
$ cd </path/to/desired/directory>
$ docker run -it --rm -v "$PWD":/usr/src/myapp -w /usr/src/myapp \
 ghcr.io/adamculp/php-code-quality:latest <followup-command-with-arguments>
```

Windows users: The use of "$PWD" for present working directory will not work as expected, instead use the full path. 
Such as "//c/Users/adamculp/project".

In the example above, Docker runs an interactive terminal to be removed when all is completed, and mounts the current host directory ($PWD) inside the container, sets this as the current working directory, and then loads the image adamculp/php-code-quality.

Following this the user can add any commands to be executed within the container. (such as running the tools provided by the image)

This is the most common use case, enabling the user to run the tools on everything in and/or below the working 
directory.

Available commands provided by the adamculp/php-code-quality image:

* php + args
* composer + args
* vendor/bin/phpstan + args
* vendor/bin/phpcs + args
* vendor/bin/phploc + args
* vendor/bin/phpmd + args
* vendor/bin/pdepend + args
* vendor/bin/phpcpd + args
* vendor/bin/phpmetrics + args
* vendor/bin/phpunit + args
* vendor/bin/php-cs-fixer + args

* sh (or any other command) + args

### Some example commands:

IMPORTANT: If using the commands below "as-is", please create a 'php_code_quality' folder within the project first. This will be used, by the commands, to contain the results of the various tools. Modify as desired.

IMPORTANT: If you run into memory issues, where the output states the process ran out of memory, you can alter the amount of memory the PHP process uses for a given command by adding the -d flag to the PHP command. Note that the following example is for extreme cases since the image already sets the memory limit to 512M. (not recommended)

```
php -d memory_limit=1G
```

#### PHPStan

See [PHPStan Documentation](https://phpstan.org/user-guide/getting-started) for more documentation on use.

```
$ docker run -it --rm --name php-code-quality -v "$PWD":/usr/src/myapp -w /usr/src/myapp ghcr.io/adamculp/php-code-quality:latest sh -c 'php /usr/local/lib/php-code-quality/vendor/bin/phpstan analyse -l 0 --error-format=table > ./php_code_quality/phpcompatibility_results.txt .'
```

#### PHP Codesniffer (phpcs)

See [PHP_CodeSniffer Wiki](https://github.com/squizlabs/PHP_CodeSniffer/wiki) for more usage details of this tool.

```
$ docker run -it --rm -v "$PWD":/usr/src/myapp -w /usr/src/myapp adamculp/php-code-quality:latest \
php /usr/local/lib/php-code-quality/vendor/bin/phpcs -sv --extensions=php --ignore=vendor \
--report-file=./php_code_quality/codesniffer_results.txt .
```

#### PHPCompatibility rules applied to PHP Codesniffer

See [PHPCompatibility Readme](https://github.com/PHPCompatibility/PHPCompatibility) and [PHP_CodeSniffer Wiki](https://github.com/squizlabs/PHP_CodeSniffer/wiki) above for more usage details of this tool. PHPCompatibility is a collection of sniffs to be used with PHP_CodeSniffer.

```
$ docker run -it --rm -v "$PWD":/usr/src/myapp -w /usr/src/myapp adamculp/php-code-quality:latest sh -c \
'php /usr/local/lib/php-code-quality/vendor/bin/phpcs -sv --config-set installed_paths  /usr/local/lib/php-code-quality/vendor/phpcompatibility/php-compatibility && \
php /usr/local/lib/php-code-quality/vendor/bin/phpcs -sv --standard='PHPCompatibility' --extensions=php --ignore=vendor . \
--report-file=./php_code_quality/phpcompatibility_results.txt .'
```

#### PHP Lines of Code (PHPLoc)

See [PHPLOC Readme](https://github.com/sebastianbergmann/phploc) for more usage details of this tool.

```
$ docker run -it --rm -v "$PWD":/usr/src/myapp -w /usr/src/myapp adamculp/php-code-quality:latest \
php /usr/local/lib/php-code-quality/vendor/bin/phploc -v --names "*.php" \
--exclude "vendor" . > ./php_code_quality/phploc.txt
```

#### PHP Mess Detector (phpmd)

See [PHPMD Readme](https://github.com/phpmd/phpmd) for more usage details of this tool.

```
$ docker run -it --rm -v "$PWD":/usr/src/myapp -w /usr/src/myapp adamculp/php-code-quality:latest \
php /usr/local/lib/php-code-quality/vendor/bin/phpmd . xml codesize --exclude 'vendor' \
--reportfile './php_code_quality/phpmd_results.xml'
```

#### PHP Depends (Pdepend)

See [PDepend Docs](https://pdepend.org/) for more usage details of this tool.

Note: I haven't used this for awhile, and notice it may require a Tidelift subscription for use.

```
$ docker run -it --rm -v "$PWD":/usr/src/myapp -w /usr/src/myapp adamculp/php-code-quality:latest \
php /usr/local/lib/php-code-quality/vendor/bin/pdepend --ignore='vendor' \
--summary-xml='./php_code_quality/pdepend_output.xml' \
--jdepend-chart='./php_code_quality/pdepend_chart.svg' \
--overview-pyramid='./php_code_quality/pdepend_pyramid.svg' .
```

#### PHP Copy/Paste Detector (phpcpd)

See [PHPCPD Readme](https://github.com/sebastianbergmann/phpcpd) for more usage details of this tool.

```
$ docker run -it --rm -v "$PWD":/usr/src/myapp -w /usr/src/myapp adamculp/php-code-quality:latest \
php /usr/local/lib/php-code-quality/vendor/bin/phpcpd . \
--exclude 'vendor' > ./php_code_quality/phpcpd_results.txt
```

#### PHPMetrics

See http://www.phpmetrics.org/ for more usage details of this tool.

```
$ docker run -it --rm -v "$PWD":/usr/src/myapp -w /usr/src/myapp adamculp/php-code-quality:latest \
php /usr/local/lib/php-code-quality/vendor/bin/phpmetrics --excluded-dirs 'vendor' \
--report-html=./php_code_quality/metrics_results .
```

## Alternative Preparations

Rather than allowing Docker to retrieve the image from the Docker Hub or Github image repositories, users could also build the docker image locally by cloning the image repo from Github.

Why? As an example, a different version of PHP may be desired. Or a specific version of any tools might be required.

After cloning, navigate to the location:

{'fraction_non_alphanumeric': 0.12267218445167012, 'fraction_numerical': 0.0007389890629618681, 'mean_word_length': 4.014079288625417, 'pattern_counts': {'":': 19, '<': 9, '<?xml version=': 0, '>': 15, 'https://': 16, 'lorem ipsum': 0, 'www.': 2, 'xml': 8}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '278406', 'n_tokens_mistral': 4436, 'n_tokens_neox': 4275, 'n_words': 1411}