README

Eightshift Coding Standards for WordPress

This package contains Eightshift Coding Standards for WordPress for PHP_CodeSniffer. The intention of this package is to have a unified code across the WordPress projects we do at Eightshift, and to help with the code review.

Installation

Composer

Composer install is simple. Just run

composer require infinum/eightshift-coding-standards

or add to your composer.json

"require-dev": {
  "infinum/eightshift-coding-standards": "^2.0"
}

Copy and modify the configuration file into your project (from the project root)

cp vendor/infinum/eightshift-coding-standards/phpcs.xml.dist.sample phpcs.xml.dist

Then, run the following command to run the standards checks in your project:

vendor/squizlabs/php_codesniffer/bin/phpcs

You can also selectively check files or directories by specifying them.

Recommendation

It's recommended that you install a Composer plugin that will handle the registration of standards with PHP_CodeSniffer.

phpcodesniffer-composer-installer

Working in IDE

Sublime Text 3

To make the sniff work in Sublime Text 3, you need to have sublime linter set up, and add phpcs linter.

Then in your settings you need to reference the path to the coding standards. It should look something like this

"paths": {
    "linux": [],
    "osx": [
        "${project}/vendor/bin/",
        "/Users/user_name/wpcs/vendor/bin"
    ],
    "windows": []
},

The path depends on where you've installed your standards. Then in the linters user settings you'll need to add in the linters key

"phpcs": {
    "@disable": false,
    "args": [],
    "excludes": [],
    "standard": "Eightshift"
},

Or set the standard to point to the phpcs.xml.dist in your root folder (preferred method)

"phpcs": {
    "@disable": false,
    "args": [],
    "excludes": [],
    "standard": "$folder/phpcs.xml.dist"
},

Note about global installation

In your wpcs folder, when adding Eightshift folder. You can clone this repository there, be sure to comment out the <config name="installed_paths" value="vendor/wp-coding-standards/wpcs"/> part, so that your sniffer won't go looking for that folder.

Visual Studio Code

To set up phpcs in your VSCode, use vscode-phpcs extension. Once installed in the user settings set

"phpcs.enable": true,
"phpcs.standard": "Eightshift",

This will look in your project's vendor folder for the Eightshift's WordPress Coding Standards, and run the sniffs on every save. You can see the issues in the Problems tab at the bottom.

Atom

To set up phpcs in the Atom editor, you need to install a couple of packages. First install the base linter package for Atom: linter. Upon completion you will be prompted to install its dependency linter-ui-default. After that install linter-phpcs.

In linter-phpcs package settings you can set the path to previously installed phpcs or allow the package to search for phpcs executable inside your project. Also, you must set the name of the standard: "Eightshift" or path to the ruleset.xml of Eightshift's WordPress Coding Standards. We recommend you to disable searching for configuration files because that can cause some other standards to be used instead.

In config.cson linter-phpcs settings can look like this:

# If you want to use phpcs executable available in project
"linter-phpcs":
  autoConfigSearch: false
  codeStandardOrConfigFile: "Eightshift"
  disableWhenNoConfigFile: true

# If you want to use specific phpcs executable
"linter-phpcs":
  autoConfigSearch: false
  autoExecutableSearch: false
  codeStandardOrConfigFile: "Eightshift"
  disableWhenNoConfigFile: true
  executablePath: "/Users/user_name/wpcs/vendor/bin/phpcs" #For Mac users
  executablePath: "path_to_composer/vendor/bin/phpcs.bat" # For Windows users

# If you want to use specific standard
"linter-phpcs":
  autoConfigSearch: false
  codeStandardOrConfigFile: "vendor/infinum/eightshift-coding-standards/Eightshift/ruleset.xml"
  disableWhenNoConfigFile: true

Credits

Eightshift WordPress Coding Standards are maintained and sponsored by Infinum.

infinum / eightshift-coding-standards

Maintainers

Details