README

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

特性

PSR-4 自动加载。
PHP 8.2+ 要求。
预先配置了与 PHP CS Fixer、Pest、Faker、JetBrains PhpStorm 属性、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 许可证。