README

这是一个适用于所有 EasifyPHP 包的模板。它提供了一个起点，用于创建遵循现代 PHP 标准的库。

特性

PSR-4 自动加载。
PHP 8.2+ 要求。
预先配置以使用 PHP CS Fixer、Pest、Faker、JetBrains PhpStorm Attributes、Composer Normalize、Symfony VarDumper 和 Roave 安全建议。
测试、测试覆盖率和对代码进行修复的脚本。

使用 Composer 从此模板创建一个项目。

composer create-project easifyphp/template

安装后，将命名空间 EasifyPHP\Template 替换为您偏好的命名空间。源文件应放置在 src/ 目录中。

模板包括 Faker 用于在测试或种子脚本中生成假数据。您可以使用它如下

$faker = Faker\Factory::create();

$name = $faker->name();

此外，模板还包括 JetBrains PhpStorm Attributes 包。此包提供在使用 JetBrains PhpStorm 作为 IDE 时的附加语法支持。

use JetBrains\PhpStorm\ArrayShape;

#[ArrayShape(['id' => 'int', 'name' => 'string'])]
function getEntityData(): array
{
    // ...
}

模板还包括 Symfony VarDumper 包。此包提供了一个更好的 var_dump() 函数，更容易阅读和理解。

dump($data);

请参阅包文档以获取有关如何在项目中有效使用它的更多详细信息。

使用 Pest 进行测试。您可以使用以下命令运行测试

composer run test

要检查测试覆盖率，请运行

composer run test:coverage

此模板强制最低测试覆盖率为 90%。

模板使用 PHP CS Fixer 进行代码格式化。您可以使用以下命令运行格式化工具

composer run fix

请参阅 CONTRIBUTING.md 获取详细信息。

如果您在此模板中发现安全漏洞，请通过 hello@mmark.me 将电子邮件发送给 Mark。所有安全漏洞都将得到及时处理。

EasifyPHP 模板是开源软件，许可证为 MIT 许可证。