[meta] Coding standards review for D8 Examples

Problem/Motivation

Examples for Developers needs a better process for fixing and enforcing coding standards rules.

Proposed resolution

We can follow the example of Drupal 8 core: #2571965: [meta] Fix PHP coding standards in core, stage 1

• Add a phpcs.xml.dist file to the root of examples.
• Fix coding standards violations per rule rather than piecemeal.
• Add rules to the phpcs.xml.dist file as we progress.
• Reviewers can then use phpcs during patch review.

How To:

Install the tools

You'll need tools. Specifically, drupal/coder, which in turn requires squizlabs/php_codesniffer. These packages are dev requirements of Drupal 8 core now:

$ cd path/to/drupal/
$ composer install

Now you have to configure phpcs to use coder:

$ ./vendor/bin/phpcs --config-set installed_paths vendor/drupal/coder/code_sniffer/

You can now verify that you've installed the Drupal rules properly like this:

$ ./vendor/bin/phpcs -i
The installed coding standards are MySource, PEAR, PHPCS, PSR1, PSR2, Squiz, Zend, Drupal and DrupalPractice

Do The Work

Pick an issue. The issues are all child issues here. Specific issues might have instructions, but the general flow is this:

• Add a Drupal sniff to the ruleset in phpcs.xml.dist.
• Run phpcs to see what's broken:
  

  $ cd path/to/drupal/root/
  $ ./vendor/bin/phpcs -ps --standard=modules/examples/phpcs.xml.dist modules/examples/
  

• If necessary, use phpcfb to do some automated fixing.
• Review the work that phpcfb did, and amend as necessary.

Remember that the goal here is to make patches which are easy to write, and also easy to review. Over time, all standards will be met.

If you see a violation that doesn't have an issue here, add a child issue to this one.