README

描述

此编码规范旨在用于Magento项目和模块。

它使用了以下规则集

• PSR-12
• Magento编码规范
• Slevomat编码规范

安装

要使用此规则集，请在composer中引入它

composer require --dev smile/magento2-smilelab-phpcs

规则集

有两个规则集可供选择

• SmileLab (Magento >=2.4.4)
• SmileLab-237-243 (Magento >=2.3.7 <2.4.4)

旧版本的Magento (<2.4.4) 需要单独的规则集，因为这些版本使用的是过时的Magento编码规范。

配置

在项目的根目录下创建一个名为phpcs.xml.dist的配置文件。

Magento项目的示例

<?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="extensions" value="php,phtml"/>
    <arg name="colors"/>
    <arg value="p"/>
    <arg value="s"/>
    
    <rule ref="SmileLab"/>

    <file>app/code</file>
    <file>app/design</file>
</ruleset>

社区模块的示例

<?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="extensions" value="php,phtml"/>
    <arg name="colors"/>
    <arg value="p"/>
    <arg value="s"/>

    <config name="php_version" value="{{min_php_version}}"/>

    <rule ref="SmileLab"/>

    <file>.</file>
    <exclude-pattern>vendor/*</exclude-pattern>
</ruleset>

其中 {{min_php_version}} 是您模块所需的最小PHP兼容版本。例如，如果最小版本是PHP 7.4

<config name="php_version" value="70400"/>

使用方法

您可以使用以下命令运行phpcs

vendor/bin/phpcs --extensions=php,phtml

您可以使用以下命令修复大多数错误

vendor/bin/phpcbf --extensions=php,phtml

指南

如果您的类重写了父类中声明的方法，请使用 @inheritdoc

/**
 * @inheritdoc
 */
public function execute(InputInterface $input, OutputInterface $output): int
{
    // ...
}