Magento Coding Standard 项目教程

Magento Coding Standard 项目教程

magento-coding-standardMagento Coding Standard项目地址:https://gitcode.com/gh_mirrors/ma/magento-coding-standard

1. 项目的目录结构及介绍

Magento Coding Standard 项目的目录结构如下：

magento-coding-standard/
├── Magento2/
│   ├── Ruleset.xml
│   └── ...
├── composer.json
├── LICENSE.txt
├── README.md
└── ...

目录结构介绍

• Magento2/: 包含 Magento2 代码规范的规则集文件 Ruleset.xml 以及其他相关文件。
• composer.json: 项目的 Composer 配置文件，定义了项目的依赖关系。
• LICENSE.txt: 项目的许可证文件，遵循 OSL-3.0 许可证。
• README.md: 项目的自述文件，包含项目的基本信息和使用说明。

2. 项目的启动文件介绍

Magento Coding Standard 项目没有传统意义上的“启动文件”，因为它主要是一个代码规范检查工具。项目的核心功能是通过命令行工具 phpcs 和 phpcbf 来执行代码规范检查和自动修复。

主要命令

• phpcs: 用于执行代码规范检查。
• phpcbf: 用于自动修复代码规范问题。

示例命令

vendor/bin/phpcs --standard=Magento2 <path to inspect>
vendor/bin/phpcbf --standard=Magento2 <path to inspect>

3. 项目的配置文件介绍

Magento Coding Standard 项目的主要配置文件是 composer.json 和 Magento2/Ruleset.xml。

composer.json

composer.json 文件定义了项目的依赖关系和脚本配置。以下是部分内容示例：

{
    "name": "magento/magento-coding-standard",
    "description": "Magento Coding Standard",
    "type": "phpcodesniffer-standard",
    "require": {
        "php": ">=7.1",
        "squizlabs/php_codesniffer": "^3.5",
        "phpcompatibility/php-compatibility": "^9.3"
    },
    "scripts": {
        "post-install-cmd": [
            "([ $COMPOSER_DEV_MODE -eq 0 ] || vendor/bin/phpcs --config-set installed_paths / /magento/magento-coding-standard/)"
        ],
        "post-update-cmd": [
            "([ $COMPOSER_DEV_MODE -eq 0 ] || vendor/bin/phpcs --config-set installed_paths / /magento/magento-coding-standard/)"
        ]
    }
}

Magento2/Ruleset.xml

Magento2/Ruleset.xml 文件定义了 Magento2 代码规范的具体规则。以下是部分内容示例：

<ruleset name="Magento2">
    <description>Magento 2 Coding Standard</description>
    <rule ref="PSR2"/>
    <rule ref="Generic.Files.LineLength">
        <properties>
            <property name="lineLimit" value="120"/>
            <property name="absoluteLineLimit" value="0"/>
        </properties>
    </rule>
    <!-- 其他规则 -->
</ruleset>

通过这些配置文件，开发者可以自定义代码规范检查的规则和行为。

magento-coding-standardMagento Coding Standard项目地址:https://gitcode.com/gh_mirrors/ma/magento-coding-standard