Magento Marketplace EQP 项目教程

Magento Marketplace EQP 项目教程

marketplace-eqpMagento 1.x Coding Standard项目地址:https://gitcode.com/gh_mirrors/ma/marketplace-eqp

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

marketplace-eqp/
├── bin/
├── composer.json
├── CONTRIBUTING.md
├── LICENSE.md
├── README.md
├── ruleset.xml
├── src/
│   ├── Magento/
│   │   ├── CodingStandard/
│   │   │   ├── AbstractSniff.php
│   │   │   ├── Sniffs/
│   │   │   │   ├── Classes/
│   │   │   │   ├── Functions/
│   │   │   │   ├── Methods/
│   │   │   │   ├── Namespaces/
│   │   │   │   ├── Php/
│   │   │   │   ├── Strings/
│   │   │   │   ├── WhiteSpace/
│   │   │   │   └── ...
│   │   │   └── ...
│   │   └── ...
│   └── ...
├── tests/
│   ├── bootstrap.php
│   ├── Unit/
│   │   ├── AbstractSniffTest.php
│   │   ├── Sniffs/
│   │   │   ├── Classes/
│   │   │   ├── Functions/
│   │   │   ├── Methods/
│   │   │   ├── Namespaces/
│   │   │   ├── Php/
│   │   │   ├── Strings/
│   │   │   ├── WhiteSpace/
│   │   │   └── ...
│   │   └── ...
│   └── ...
└── vendor/

目录结构介绍

• bin/: 包含可执行文件。
• composer.json: Composer 配置文件。
• CONTRIBUTING.md: 贡献指南。
• LICENSE.md: 许可证文件。
• README.md: 项目说明文档。
• ruleset.xml: PHP_CodeSniffer 规则集配置文件。
• src/: 源代码目录，包含 Magento 的 CodingStandard。
• tests/: 测试代码目录，包含单元测试。
• vendor/: Composer 依赖包目录。

2. 项目的启动文件介绍

项目的启动文件主要是 bin/ 目录下的可执行文件。这些文件通常用于运行项目的各种命令，例如代码检查、测试等。

3. 项目的配置文件介绍

• composer.json: 定义了项目的依赖关系、脚本、命名空间等信息。
• ruleset.xml: 定义了 PHP_CodeSniffer 的代码检查规则。

composer.json 示例

{
    "name": "magento/marketplace-eqp",
    "description": "Magento 1.x Coding Standard",
    "type": "project",
    "license": "OSL-3.0",
    "require": {
        "php": ">=5.6.0",
        "squizlabs/php_codesniffer": "^3.0"
    },
    "autoload": {
        "psr-4": {
            "Magento\\CodingStandard\\": "src/Magento/CodingStandard"
        }
    },
    "scripts": {
        "post-install-cmd": [
            "bin/phpcs --config-set installed_paths ../../magento/marketplace-eqp"
        ],
        "post-update-cmd": [
            "bin/phpcs --config-set installed_paths ../../magento/marketplace-eqp"
        ]
    }
}

ruleset.xml 示例

<?xml version="1.0"?>
<ruleset name="Magento1">
    <description>Magento 1.x Coding Standard</description>
    <rule ref="PSR2"/>
    <rule ref="Generic.Arrays.DisallowLongArraySyntax"/>
    <rule ref="Magento.Arrays.ArrayKey">
        <properties>
            <property name="quote_type" value="single"/>
        </properties>
    </rule>
    <rule ref="Magento.Classes.ClassDeclaration"/>
    <rule ref="Magento.ControlStructures.ControlSignature"/>
    <rule ref="Magento.ControlStructures.ElseIf"/>
    <rule ref="Magento.Files.LineLength"/>
    <rule ref="Magento.Functions.FunctionDeclaration"/>
    <rule ref="Magento.Naming

marketplace-eqpMagento 1.x Coding Standard项目地址:https://gitcode.com/gh_mirrors/ma/marketplace-eqp