Repository files navigation

Provides a PHP CodeSniffer ruleset for the MO4 coding standard

The MO4 Coding Standard is an extension of theSymfony Coding Standard and adds following rules:

• In associative arrays, the=> operators must be aligned.
• In arrays, the key and=> operator must be on the same line.

• In multi line arrays, the opening bracket must be followed by newline.
• In multi line arrays, the closing bracket must be in own line.
• In multi line arrays, the elements must be indented.

• doc blocks of class properties must be multiline and have exactly one@var annotation

• use statements must be sorted lexicographically. The order function can be configured.

Theorder property of theMO4.Formatting.AlphabeticalUseStatements sniff defineswhich function is used for ordering.

Possible values for order:

• dictionary (default): based onstrcmp, the namespace separatorprecedes any other character

  useDoctrine\ORM\Query;useDoctrine\ORM\Query\Expr;useDoctrine\ORM\QueryBuilder;

• string: binary safe string comparison usingstrcmp

  useDoctrine\ORM\Query;useDoctrine\ORM\QueryBuilder;useDoctrine\ORM\Query\Expr;useExampleSub;useExamples;

• string-locale: locale based string comparison usingstrcoll
• string-case-insensitive: binary safe case-insensitive string comparisonstrcasecmp

  useExamples;useExampleSub;

To change the sorting order for your project, add this snippet to your customruleset.xml:

<ruleref="MO4.Formatting.AlphabeticalUseStatements">    <properties>        <propertyname="order"value="string-locale"/>    </properties></rule>

• The imported class name must be used, when it was imported with ause statement.

• Interpolated variables in double quoted strings must be surrounded by{ }, e.g.{$VAR} instead of$VAR.

• const must be followed by a single space.

• No more than one empty consecutive line is allowed. Taken frommediawiki/mediawiki-codesniffer.

• SeeMO4/ruleset.xml, which has each imported rule commented.

Note that with this ruleset, the followingSymfony Coding Standard rules are not enforced:

• "add doc blocks for all classes": the doc block for classes can be omitted, if they add no value
• "the license block has to be present at the top of every PHP file, before the namespace": the license block can be omitted

Most of the issues can be auto-fixed withphpcbf.

• PHP
• Composer is optional, but strongly recommended

UsingComposer is the preferred way.

1. Add the MO4 coding standard tocomposer.json

    composer require --dev mayflower/mo4-coding-standard

2. Profit

    ./vendor/bin/phpcs --standard=MO4 path/to/my/file.php

3. Optionally, you might set MO4 as default coding standard

    ./vendor/bin/phpcs --config-set default_standard MO4

1. Checkout this repository

    git clone https://github.com/mayflower/mo4-coding-standard.git

2. Install dependencies

    composer install

3. Check, that Symfony and MO4 are listed as coding standards

    ./vendor/bin/phpcs -i

4. Profit

    ./vendor/bin/phpcs --standard=MO4 path/to/my/file.php

5. Optionally, you might set MO4 as default coding standard

    ./vendor/bin/phpcs --config-set default_standard MO4

Ifphpcs complains that MO4 is not installed, please check the installed coding standards withphpcs -i and thatinstalled_paths is set correctly withphpcs --config-show

• PHP CodeSniffer
• David Joos's Symfony Coding Standard
• Composer installer for PHP_CodeSniffer coding standards
• Slevomat Coding Standard

SeeCONTRIBUTING.md for information.

This project is licensed under the MIT license.See theLICENSE file for details.