README

一个消耗 Magento EQP1 和 Magento ECG 的额外嗅探器和配置的 Magento1 编码标准。

安装与使用

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 脚本

用于包装 phpcs 参数的实用配置，使用 Composer 的 CLI 安装包。

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

更新项目的 composer.json 文件，包括以下根选项

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

运行 Composer 脚本

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

配置文件

<?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>

现有项目可以通过更新 phpcs.xml 文件来要求 Inviqa Magento1 编码标准，如上所述。

要求

PHP >= 5.6

开发

已提供 Docker 环境，以更新 composer 依赖项——如果全局主机开发机器上没有可用的 composer / PHP。

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

提交更新的 composer.json 以供同行审查。

贡献

请随时贡献新的嗅探器或对现有嗅探器的任何修复或改进。