Docker image for phpcs

All #awesome-ci Docker images

ansible • ansible-lint • awesome-ci • black • checkmake • eslint • file-lint • gofmt • goimports • golint • jsonlint • linkcheck • mypy • phpcbf • phpcs • phplint • php-cs-fixer • pycodestyle • pydocstyle • pylint • terraform-docs • terragrunt • terragrunt-fmt • yamlfmt • yamllint

All #awesome-ci Makefiles

Visit cytopia/makefiles for seamless project integration, minimum required best-practice code linting and CI.

View Dockerfile on GitHub.

Tiny Alpine-based multistage-builld dockerized version of phpcs^[1]. The image is built nightly against multiple stable versions and pushed to Dockerhub.

^{[1] Official project: https://github.com/squizlabs/PHP_CodeSniffer}

Available Docker image versions

Docker images for PHP CodeSniffer come with all available PHP versions. In doubt use latest tag.

Latest stable phpcs version

Docker tag	phpcs version	PHP version
latest	latest stable	latest stable
latest-php7.4	latest stable	latest stable 7.4.x
latest-php7.3	latest stable	latest stable 7.3.x
latest-php7.2	latest stable	latest stable 7.2.x
latest-php7.1	latest stable	latest stable 7.1.x
latest-php7.0	latest stable	latest stable 7.0.x
latest-php5.6	latest stable	latest stable 5.6.x

Latest stable phpcs 3.x.x version

Docker tag	phpcs version	PHP version
3	latest stable 3.x.x	latest stable
3-php7.4	latest stable 3.x.x	latest stable 7.4.x
3-php7.3	latest stable 3.x.x	latest stable 7.3.x
3-php7.2	latest stable 3.x.x	latest stable 7.2.x
3-php7.1	latest stable 3.x.x	latest stable 7.1.x
3-php7.0	latest stable 3.x.x	latest stable 7.0.x
3-php5.6	latest stable 3.x.x	latest stable 5.6.x

Latest stable phpcs 2.x.x version

Docker tag	phpcs version	PHP version
2	latest stable 2.x.x	latest stable
2-php7.4	latest stable 2.x.x	latest stable 7.4.x
2-php7.3	latest stable 2.x.x	latest stable 7.3.x
2-php7.2	latest stable 2.x.x	latest stable 7.2.x
2-php7.1	latest stable 2.x.x	latest stable 7.1.x
2-php7.0	latest stable 2.x.x	latest stable 7.0.x
2-php5.6	latest stable 2.x.x	latest stable 5.6.x

Docker mounts

The working directory inside the Docker container is /data/ and should be mounted locally to the root of your project.

Usage

Basic

$ docker run --rm -v $(pwd):/data cytopia/phpcs .

----------------------------------------------------------------------
FOUND 4 ERRORS AFFECTING 3 LINES
----------------------------------------------------------------------
 2 | ERROR | [ ] Missing file doc comment
 5 | ERROR | [x] First condition of a multi-line IF statement must
   |       |     directly follow the opening parenthesis
 6 | ERROR | [x] Line indented incorrectly; expected at least 4
   |       |     spaces, found 1
 6 | ERROR | [x] Closing brace must be on a line by itself
----------------------------------------------------------------------
PHPCBF CAN FIX THE 3 MARKED SNIFF VIOLATIONS AUTOMATICALLY
----------------------------------------------------------------------

Custom standard

Custom standards must be mounted inside the container to /usr/bin/CodeSniffer.conf

# Via command line
$ docker run --rm -v $(pwd):/data -v CodeSniffer.conf:/usr/bin/CodeSniffer.conf cytopia/phpcs .

# Docker compose
phpcs:
  image: cytopia/phpcs
  volumes:
    - .:/data
    - CodeSniffer.conf:/usr/bin/CodeSniffer.conf

Related #awesome-ci projects

Docker images

Save yourself from installing lot's of dependencies and pick a dockerized version of your favourite linter below for reproducible local or remote CI tests:

GitHub	DockerHub	Type	Description
awesome-ci		Basic	Tools for git, file and static source code analysis
file-lint		Basic	Baisc source code analysis
linkcheck		Basic	Search for URLs in files and validate their HTTP status code
ansible		Ansible	Multiple versions and flavours of Ansible
ansible-lint		Ansible	Lint Ansible
gofmt		Go	Format Go source code [1]
goimports		Go	Format Go source code [1]
golint		Go	Lint Go code
eslint		Javascript	Lint Javascript code
jsonlint		JSON	Lint JSON files [1]
checkmake		Make	Lint Makefiles
phpcbf		PHP	PHP Code Beautifier and Fixer
phpcs		PHP	PHP Code Sniffer
phplint		PHP	PHP Code Linter [1]
php-cs-fixer		PHP	PHP Coding Standards Fixer
black		Python	The uncompromising Python code formatter
mypy		Python	Static source code analysis
pycodestyle		Python	Python style guide checker
pydocstyle		Python	Python docstyle checker
pylint		Python	Python source code, bug and quality checker
terraform-docs		Terraform	Terraform doc generator (TF 0.12 ready) [1]
terragrunt		Terraform	Terragrunt and Terraform
terragrunt-fmt		Terraform	terraform fmt for Terragrunt files [1]
yamlfmt		Yaml	Format Yaml files [1]
yamllint		Yaml	Lint Yaml files

^[1] Uses a shell wrapper to add enhanced functionality not available by original project.

Makefiles

Visit cytopia/makefiles for dependency-less, seamless project integration and minimum required best-practice code linting for CI. The provided Makefiles will only require GNU Make and Docker itself removing the need to install anything else.

License

MIT License

Copyright (c) 2019 cytopia