README

构建

项目

质量

社区

Laravel 扩展包模板

这是一个模板仓库，旨在通过预配置的基本工具和设置快速开始 Laravel 扩展包的开发。

如果您 喜欢/使用 这个包，请考虑 ⭐️ 给它加星。谢谢！

🚀 功能

此模板仓库包括几个功能，以简化 Laravel 扩展包的开发

→ 测试

• 配置了 PHPUnit 进行单元测试。
• 集成了 Pest PHP 以提供优雅的命令行支持和架构测试。
• Orchestra Testbench 用于 Laravel 扩展包测试。
• PHPStan 扩展用于 PHPUnit 和 Laravel。
• Infection 用于突变测试以确保质量。
• 突变测试报告上传到 Stryker Mutator Dashboard。

→ 静态分析

• PHPStan 用于静态分析，确保代码质量和健壮性。
• Larastan 用于 Laravel 特定静态分析。
• PHPStan 严格规则 用于强制执行严格的类型检查和标准。
• Psalm 通过静态分析在 PHP 应用程序中查找错误。
• PHP Rector 用于自动代码升级和重构，以维护现代代码标准。

→ 编码规范

• PHP CS Fixer 配置，具有自定义配置以实现一致的代码风格。
• Composer Normalize 以确保一致的 composer.json 格式。
• Yamllint 用于 YAML 文件检查。
• Actionlint 用于 GitHub Actions 工作流程检查。
• Markdownlint 用于 Markdown 文件检查。

→ 持续集成

• 使用 PHPUnit 和 Xdebug 自动测试和生成代码覆盖率报告，上传到 Codecov。
• 使用 ibiqlik/action-yamllint 自动检查 YAML 文件。
• 使用 wayofdev/php-cs-fixer-config 自动检查 PHP 代码，以确保代码质量和标准。
• 使用 DavidAnson/markdownlint-cli2 进行 Markdown 检查。
• 使用Composer检查过时的或不安全的依赖项。
• 使用Infection和Stryker Mutator进行变异测试，以评估测试套件的质量。
• 进行安全检查以识别依赖项中的漏洞。
• 使用PHPStan和Psalm进行全面的静态分析。
• 在不同配置下进行广泛的测试，以确保兼容性和稳定性。

→ 开发环境

• 支持Docker，以实现一致的开发环境。
• 设置Pre-commit钩子，以确保提交前的代码质量。

→ 问题模板

• 此包配备了一套现成的模板，以简化贡献和问题报告。

  您可以在.github/ISSUE_TEMPLATE目录中找到这些模板。

→ 其他

• 支持PHP 8.2+和Laravel 10.x/11.x。
• 配置了autoload和autoload-dev以实现最佳命名空间管理。
• 使用Phive管理PHAR依赖项。

💿 安装

要使用此模板，请克隆存储库并安装依赖项

$ git clone https://github.com/wayofdev/laravel-package-tpl.git
$ cd laravel-package-tpl

$ make env install

### full list of available commands:
$ make help

🧪 运行测试

→ PHPUnit测试

要运行测试，请运行以下命令

make test

→ 变异测试

要运行变异测试，请使用infection/infection

make infect

→ 静态分析

使用PHPStan进行代码质量检查

make lint-stan

并使用Psalm

make lint-psalm

→ 修复编码标准

使用PHP编码标准修复器（PHP CS Fixer）修复代码，以遵循我们的标准

make lint-php

→ 检查Yaml文件

检查项目中的所有yaml文件

make lint-yaml

→ 检查Markdown文件

检查项目中的所有yaml文件

make lint-md

→ 检查GitHub Actions

检查项目中的所有yaml文件

make lint-actions

🔒 安全策略

该项目有一个安全策略。

🙌 想要贡献吗？

感谢您考虑为wayofdev社区做出贡献！我们欢迎各种类型的贡献。如果您想

• 🤔 建议一个功能
• 🐛 报告一个问题
• 📖 改进文档
• 👨‍💻 为代码做出贡献

非常欢迎您。在贡献之前，请参阅我们的贡献指南。

🫡 贡献者

🌐 社交链接

• Twitter: 关注我们的组织 @wayofdev 和作者 @wlotyp。
• Discord: 加入我们的社区Discord。

⚖️ 许可证