inviqa/magento1-coding-standard

A set of PHP_CodeSniffer rules and sniffs for Magento1

2.0 2019-02-01 14:18 UTC

Requires

• php: >=5.6.0
• magento-ecg/coding-standard: ^3.1
• magento/marketplace-eqp: ^2.0
• squizlabs/php_codesniffer: ^3.0

Requires (Dev)

• aydin-hassan/magento-core-composer-installer: ^1.5
• magento/core: ^1.9.4

MIT

README

Magento1 coding standard which consumes Magento EQP1 and Magento ECG with extra Sniffs and configuration.

Installation & Usage

composer config repositories.inviqa-magento1cs vcs https://github.com/inviqa/magento-phpcs-coding-standard
composer require inviqa/magento1-coding-standard --update-with-dependencies --dev

Composer Scripts

Utility configuration to wrapping phpcs arguments, require the package using Composer's CLI.

composer.phar require inviqa/magento-phpcs-coding-standard --dev --update-with-dependencies

Update your project's composer.json with the following root options

{
    "config": {
        "bin-dir": "bin"
    },
    "scripts": {
        "sniff": "bin/phpcs -ns --standard=vendor/inviqa/magento-phpcs-coding-standard"
    }
}

Run Composer script

composer.phar sniff Magento/app/code/local/Acme/ExampleModule/{Block,Helper,Model}

Config file

<?xml version="1.0" encoding="UTF-8"?>
<ruleset name="AcmeCompany">
    <description>AcmeCompany - PHP CodeSniffer configuration</description>

    <rule ref="vendor/inviqa/magento1-coding-standard"/>

    <exclude-pattern>*/code/community/*</exclude-pattern>
    <exclude-pattern>*/code/core/*</exclude-pattern>
    <exclude-pattern>*/tests/*</exclude-pattern>
    <exclude-pattern>*/data/*</exclude-pattern>
    <exclude-pattern>*/sql/*</exclude-pattern>
</ruleset>

Existing projects can require the Inviqa Magento1 coding standard by updating the phpcs.xml file like above.

Requirements

PHP >= 5.6

Development

A docker environment has been provided to update the composer dependencies - should composer / PHP not be available globally on the host development machine.

docker-compose up -d
docker-compose rn --rm composer bash
composer update | require acme/package

Commit the updated composer.json for peer review.

Contribution

Please feel free to contribute new sniffs or any fixes or improvements for the existing ones.