22
33## Description
44
5- Minimal PHP QA Docker image focused on loca /CI static analysis, styling and other tools.
5+ Minimal PHP QA Docker image focused on local /CI static analysis, styling and other tools.
66
77It's plays nicely with [ kool.dev] ( https://github.com/kool-dev/kool ) managed environments, but can fit in any other PHP use-case.
88
9- #### Tools included in the image
9+ ### Tools included in the image
1010
11- ** Static analysis**
11+ #### Static analysis
1212
1313- Phan - static analyzer for PHP (` phan ` )
1414- PHP Mess Detector (` phpmd ` )
1515- PHP Copy/Paste Detector (` phpcpd ` )
1616
17- ** Code Style**
17+ #### Code Style
1818
1919- PHP Coding Standards Fixer (` php-cs-fixer ` )
2020
21- ** Security**
21+ #### Security
2222
2323- Local PHP Security Checker (` local-php-security-checker ` )
2424
25- ** Testing**
25+ #### Testing
2626
2727- PHPUnit 9.5 (` phpunit ` )
2828- PHPUnit 10 (` phpunit10 ` for cutting-edge testing)
@@ -31,16 +31,16 @@ It's plays nicely with [kool.dev](https://github.com/kool-dev/kool) managed envi
3131
3232Just execute any QA tool available straight from a new container. Using [ ` kool ` ] ( https://github.com/kool-dev/kool ) is the prefered way:
3333
34- ``` console
35- $ cd my-laravel-project/
36- $ kool docker kooldev/phpqa:7.4 phan
37- $ kool docker kooldev/phpqa:7.4 php-cs-fixer
34+ ``` sh
35+ cd my-laravel-project/
36+ kool docker kooldev/phpqa:7.4 phan
37+ kool docker kooldev/phpqa:7.4 php-cs-fixer
3838```
3939
4040With vanilla Docker you would need to run:
4141
42- ```
43- $ docker run --rm --init -it -v $(pwd):/app -w /app kooldev/phpqa:7.4
42+ ``` sh
43+ docker run --rm --init -it -v $( pwd) :/app -w /app kooldev/phpqa:7.4
4444```
4545
4646> We strongly recommend checking out [ ` kool ` CLI] ( https://github.com/kool-dev/kool ) for more benefits to your Docker environemnts.
@@ -49,19 +49,18 @@ $ docker run --rm --init -it -v $(pwd):/app -w /app kooldev/phpqa:7.4
4949
5050The image built is [ ` kooldev/phpqa ` ] ( https://hub.docker.com/r/kooldev/phpqa/tags?page=1&ordering=last_updated ) with tags:
5151
52- ### 7.4
53-
54- - [ 7.4] ( https://github.com/kool-dev/docker-phpqa/blob/main/7.4/Dockerfile )
52+ - [ ** ` 7.4 ` ** ] ( https://github.com/kool-dev/docker-phpqa/blob/main/7.4/Dockerfile )
53+ - [ ** ` 8.0 ` ** ] ( https://github.com/kool-dev/docker-phpqa/blob/main/8.0/Dockerfile )
5554
56- ## Using kool.yml
55+ ## Using ` kool.yml `
5756
5857Examples of what you can do in a ` kool ` powered environment. Add to your ` kool.yml ` file:
5958
6059``` yaml
6160# kool.yml
6261scripts :
6362 # just an alias to the PHPQA container
64- phpqa : kool docker kooldev/phpqa:7.4
63+ phpqa : kool docker kooldev/phpqa:8.0
6564 # using the alias to call each tool with predefined parameters
6665 # assuming your application code is located in a `app/` folder
6766 phan : kool run phpqa phan --color -p -l app -iy 5
@@ -77,7 +76,6 @@ Please feel free to use and open a PR with more QA tools you find useful to have
7776- Ship boilerplate of CI snippets for popular engines (Github Actions, CircleCI, TravisCI).
7877- Add more tools that we find helpful.
7978
80-
8179### Update images with templates
8280
8381You should change ` fwd-template.json ` for configuration and ` template/ ` folder for the actual base templates.
0 commit comments