cytopia/phpcs repository overview

⁠Docker image for phpcs

View Dockerfiles⁠ on GitHub.

Available Architectures: amd64, i386, arm64, arm/v7, arm/v6

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⁠}

⁠:whale: Available Docker image versions

⁠Rolling releaess

The following Docker image tags are rolling releases and are built and updated every night.

⁠Point in time releases

The following Docker image tags are built once and can be used for reproducible builds. Its version never changes so you will have to update tags in your pipelines from time to time in order to stay up-to-date.

⁠:open_file_folder: Docker mounts

The working directory inside the Docker container is /data/ and should be mounted locally.

⁠:computer: 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

⁠:arrows_counterclockwise: 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]
kubeval⁠		K8s	Lint Kubernetes files
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
bandit⁠		Python	A security linter from PyCQA
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

⁠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.

⁠:page_facing_up: License

MIT License⁠

Copyright (c) 2019 cytopia⁠