README

PHP Coding Standard used in ShipMonk

Note

This coding standard is primarily intended for use by ShipMonk packages. For other applications or packages, consider using slevomat/coding-standard directly instead.

Installation

composer require --dev shipmonk/coding-standard

Configuration

Create phpcs.xml.dist in your project root:

<?xml version="1.0"?>
<ruleset
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:noNamespaceSchemaLocation="vendor/squizlabs/php_codesniffer/phpcs.xsd"
>
    <arg name="basepath" value="."/>
    <arg name="cache" value="var/phpcs.cache"/>

    <file>src/</file>
    <file>tests/</file>

    <config name="installed_paths" value="vendor/slevomat/coding-standard,vendor/shipmonk/coding-standard"/>
    <rule ref="ShipMonkCodingStandard"/>
</ruleset>

Usage

Check your code:

vendor/bin/phpcs

Fix auto-fixable issues:

vendor/bin/phpcbf