Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kool-dev/docker-phpqa
Docker images for PHP Quality Assurance, Static Analysis, and CI tools
https://github.com/kool-dev/docker-phpqa
ci docker docker-image kool kool-dev php-docker php-qa phpqa phpqatools static-analysis
Last synced: about 2 months ago
JSON representation
Docker images for PHP Quality Assurance, Static Analysis, and CI tools
- Host: GitHub
- URL: https://github.com/kool-dev/docker-phpqa
- Owner: kool-dev
- License: mit
- Created: 2021-05-11T14:57:57.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-02-29T01:05:38.000Z (11 months ago)
- Last Synced: 2024-02-29T02:25:36.449Z (11 months ago)
- Topics: ci, docker, docker-image, kool, kool-dev, php-docker, php-qa, phpqa, phpqatools, static-analysis
- Language: Dockerfile
- Homepage:
- Size: 46.9 KB
- Stars: 4
- Watchers: 5
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
## Description
Minimal PHP QA Docker image focused on local/CI static analysis, styling and other tools.
It's plays nicely with [kool.dev](https://github.com/kool-dev/kool) managed environments, but can fit in any other PHP use-case.
### Tools included in the image
#### Static analysis
- Phan - static analyzer for PHP (`phan`)
- PHP Mess Detector (`phpmd`)
- PHP Copy/Paste Detector (`phpcpd`)
#### Code Style
- PHP Coding Standards Fixer (`php-cs-fixer`)
#### Security
- Local PHP Security Checker (`local-php-security-checker`)
#### Testing
- PHPUnit 9.5 (`phpunit`)
- PHPUnit 10 (`phpunit10` for cutting-edge testing)
## Usage
Just execute any QA tool available straight from a new container. Using [`kool`](https://github.com/kool-dev/kool) is the prefered way:
```sh
cd my-laravel-project/
kool docker kooldev/phpqa:7.4 phan
kool docker kooldev/phpqa:7.4 php-cs-fixer
```
With vanilla Docker you would need to run:
```sh
docker run --rm --init -it -v $(pwd):/app -w /app kooldev/phpqa:7.4
```
> We strongly recommend checking out [`kool` CLI](https://github.com/kool-dev/kool) for more benefits to your Docker environemnts.
## Available Tags
The image built is [`kooldev/phpqa`](https://hub.docker.com/r/kooldev/phpqa/tags?page=1&ordering=last_updated) with tags:
- [**`8.3`**](https://github.com/kool-dev/docker-phpqa/blob/main/8.3/Dockerfile)
- [**`8.2`**](https://github.com/kool-dev/docker-phpqa/blob/main/8.2/Dockerfile)
- [**`8.1`**](https://github.com/kool-dev/docker-phpqa/blob/main/8.1/Dockerfile)
- [**`8.0`**](https://github.com/kool-dev/docker-phpqa/blob/main/8.0/Dockerfile)
- [**`7.4`**](https://github.com/kool-dev/docker-phpqa/blob/main/7.4/Dockerfile)
## Using `kool.yml`
Examples of what you can do in a `kool` powered environment. Add to your `kool.yml` file:
```yaml
# kool.yml
scripts:
# just an alias to the PHPQA container
phpqa: kool docker kooldev/phpqa:8.1
# using the alias to call each tool with predefined parameters
# assuming your application code is located in a `app/` folder
phan: kool run phpqa phan --color -p -l app -iy 5
phpcpd: kool run phpqa phpcpd --fuzzy app
# ...
```
## Contributing
Please feel free to use and open a PR with more QA tools you find useful to have! As a sort of roadmap these are the goals in our mind for the short term:
- Make tools specific configurations available for the user in a friendly manner.
- Ship boilerplate of CI snippets for popular engines (Github Actions, CircleCI, TravisCI).
- Add more tools that we find helpful.
### Update images with templates
You should change `fwd-template.json` for configuration and `template/` folder for the actual base templates.
After any changes, we need to run `kool run template` to parse the templates and generate all versions folder/files.
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.