interlutions/coding-standard

Internal PHP coding standards of Interlutions

v1.0 2018-11-16 10:46 UTC

Requires (Dev)

• phpunit/phpunit: ^4.0 || ^5.0 || ^6.0
• squizlabs/php_codesniffer: ^3.0

Conflicts

• squizlabs/php_codesniffer: <3 || >=4

MIT

• Interlutions Team

• symfony
• Neos
• phpcs
• Coding Standard
• typo3
• psr
• code sniffer

README

Interlutions Coding Standard

We at Interlutions love clean code. So we have a have an internal PHP coding standard across frameworks, e-commerce and content management systems. We are using PHP CodeSniffer to ensure its integrity.

Goals of our coding standard

• Using already existing standards (PSR-1, PSR-2)
• Coding standard across frameworks (Symfony, TYPO3, Neos)
• Avoid duplications (also between code, CVS history and documentation)

Installation

If you use Composer, you can just include the Interlutions Coding Standard in your project with the following command:

composer req interlutions/coding-standard

Usage

Just create a phpcs.xml.dist in your project's root directory with the following content:

<?xml version="1.0"?>
<ruleset name="interlutions-coding-standard">
    <rule ref="vendor/interlutions/coding-standard/Interlutions">
        <!-- If the standard is too hard, you can exclude some rules like this: -->
        <!-- <exclude name="Generic.Arrays.DisallowLongArraySyntax.Found" /> -->
        <!-- <exclude name="Generic.Files.LineLength.TooLong" /> -->
    </rule>
</ruleset>

And then you can execute the CodeSniffer like this:

vendor/bin/phpcs -s -p --colors src/

Testing & Development

If you are using just this package, you should be fine with this:

1. Download PHP CodeSniffer
2. Try it in this repository: phpcs -d installed_paths=./Interlutions --standard=Interlutions/ruleset.xml data/*