PHP CodeSniffer Container

This small project exposes a php executable from a container instead of installing php locally, along with binaries for phpcs to use with VS Code.

Based on this answer on SO: https://stackoverflow.com/a/52421923.

The 'start' script creates the container and the local executables in /usr/local/bin, but won't override existing scipts if they exist. Note that it might conflict with your locally installed php.

This project is written for Ubuntu, but it should be easy to modify for other platforms.

Ruleset/standard

The rulesets are loaded into the container and made visible for phpcs/phpcbf by this excellent composer package.

Any ruleset loaded by composer this way will automatically be made visible. The default is a modified ruleset based on the official Drupal coding standard. But you can change composer.json to point at any custom ruleset, just edit the relevant entries under 'repositories' and 'require'. Remember to update "phpsab.standard" in your settings.json.

Since the package is loaded by composer, updating the ruleset is as simple as pushing it to github and running the start script to rebuild the container.

Useful resources for creating and modifying rulesets: 1 and 2.

Docker setup

This project requires docker with docker compose, version 4.2 or above.

Follow the official guides for installation. This project is only tested on Ubuntu with the docker.io package.

VS Code setup

Add the extension PHP Sniffer & Beautifier for VS Code (valeryanm.vscode-phpsab).

Configure the extension; for easy configuration place these lines in settings.json:

{
    "phpsab.executablePathCS": "/usr/local/bin/phpcs",
    "phpsab.executablePathCBF": "/usr/local/bin/phpcbf",
    "phpsab.standard": "modified-drupal-coding-standard",
    "phpsab.fixerEnable": true,
    "phpsab.snifferEnable": true,
    "phpsab.snifferShowSources": true,
    "phpsab.debug": true
}