chromatix/phpcs-config-chromatix

Chromatix custom config for phpcs. Based heavily on the WordPress Coding Standards but with some of our own too.

phpcs-config-chromatix

Shareable config for phpcs for custom standards at Chromatix Digital Agency., _(*1)

Based heavily on the WordPress Coding Standards but with some of our own too. Most notably, two spaces instead of tabs. Soz., _(*2)

This config is still in development. If you have suggestions for improvement or if you disagree with anything this config makes you do, feel free to file an issue., _(*3)

Writing PHP outside of the WordPress context? We still use WordPress standards, but obviously without the need for using WordPress-specific functions. See phpcs-config-chromatix-no-wordpress., _(*4)

Installation

Install globally to use on any project:, _(*5)

composer global require chromatix/phpcs-config-chromatix

Install locally to one project:, _(*6)

composer require chromatix/phpcs-config-chromatix

You'll also need to have phpcs installed in the same manner, and set your phpcs installed_paths like follows:, _(*7)

vendor/bin/phpcs --config-set installed_paths ../../chromatix,../../wp-coding-standards/wpcs

It's probably ideal to do this in a post-install-cmd script in your composer.json; see this package's composer.json for an example of a cross-platform way to do so (it might look a bit complicated, but unfortunately is required... at least in our testing so far, anyway!)., _(*8)

Usage

Add this to your phpcs.xml file:, _(*9)

<?xml version="1.0"?>
<ruleset>
  <rule ref="phpcs-config-chromatix"/>
</ruleset>

Then:, _(*10)

• Using globally?, _(*11)

  Run phpcs *.php, _(*12)

• Using locally?, _(*13)

  Run vendor/bin/phpcs *.php, _(*14)

  Alternatively, you'll probably find it useful to add a script to your composer.json:, _(*15)

  "scripts": { "lint": "find . -type d \( -name '.git' -o -name 'vendor' -o -name 'node_modules' \) -prune -o -type f -name '*.php' -print | xargs vendor/bin/phpcs" }, _(*16)

  Then you can just run composer lint., _(*17)

See also

• phpcs-config-chromatix-no-wordpress
• eslint-config-chromatix
• stylelint-config-chromatix

License

MIT., _(*18)