Clean Code PHP 项目教程-CSDN博客

本文链接：https://blog.csdn.net/gitblog_01195/article/details/142192281

Clean Code PHP 项目教程

clean-code-php 项目地址: https://gitcode.com/gh_mirrors/clea/clean-code-php

1. 项目目录结构及介绍

clean-code-php/
├── README.md
├── composer.json
├── ecs.php
├── LICENSE
├── src/
│   ├── CleanCodePrinciples.php
│   ├── CleanCodePractices.php
│   └── CleanCodeExamples.php
└── tests/
    ├── CleanCodePrinciplesTest.php
    ├── CleanCodePracticesTest.php
    └── CleanCodeExamplesTest.php

目录结构说明

README.md: 项目介绍和使用说明。
composer.json: Composer 配置文件，定义项目的依赖关系。
ecs.php: EasyCodingStandard 配置文件，用于代码风格检查。
LICENSE: 项目许可证文件。
src/: 源代码目录，包含项目的核心代码。
- CleanCodePrinciples.php: 定义了 Clean Code 的原则。
- CleanCodePractices.php: 提供了 Clean Code 的实践方法。
- CleanCodeExamples.php: 包含 Clean Code 的示例代码。
tests/: 测试代码目录，包含项目的单元测试。
- CleanCodePrinciplesTest.php: 测试 Clean Code 原则的代码。
- CleanCodePracticesTest.php: 测试 Clean Code 实践方法的代码。
- CleanCodeExamplesTest.php: 测试 Clean Code 示例代码的代码。

2. 项目启动文件介绍

项目没有传统的“启动文件”，因为这是一个代码示例和原则说明的项目，而不是一个可执行的应用程序。项目的核心内容在 src/ 目录下的各个 PHP 文件中。

3. 项目的配置文件介绍

composer.json

{
    "name": "php-cpm/clean-code-php",
    "description": "Clean Code concepts adapted for PHP",
    "type": "project",
    "license": "MIT",
    "authors": [
        {
            "name": "Your Name",
            "email": "your.email@example.com"
        }
    ],
    "require": {},
    "require-dev": {
        "phpunit/phpunit": "^9.5",
        "squizlabs/php_codesniffer": "^3.6",
        "phpstan/phpstan": "^0.12.99"
    },
    "autoload": {
        "psr-4": {
            "CleanCodePhp\\": "src/"
        }
    },
    "autoload-dev": {
        "psr-4": {
            "CleanCodePhp\\Tests\\": "tests/"
        }
    }
}

配置文件说明

name: 项目名称。
description: 项目描述。
type: 项目类型，这里是 project。
license: 项目许可证，这里是 MIT。
authors: 项目作者信息。
require: 项目依赖，这里为空，因为项目不依赖其他包。
require-dev: 开发依赖，包含 PHPUnit、PHP_CodeSniffer 和 PHPStan，用于测试和代码质量检查。
autoload: 自动加载配置，定义了命名空间和对应目录。
autoload-dev: 开发环境下的自动加载配置，定义了测试代码的命名空间和对应目录。

ecs.php

<?php

use PhpCsFixer\Finder;
use PhpCsFixer\Config;

$finder = Finder::create()
    ->in(__DIR__ . '/src')
    ->in(__DIR__ . '/tests');

return (new Config())
    ->setRules([
        '@PSR2' => true,
        'array_syntax' => ['syntax' => 'short'],
        'no_unused_imports' => true,
    ])
    ->setFinder($finder);