korim/php-skeleton

通用的PHP项目骨架包

1.2.0 2023-04-17 14:58 UTC

README

你是否厌倦了每次开始新项目时都要复制粘贴样板PHP代码?

此存储库包含一条单行命令,可以自动为你设置创建现代、无杂乱且以测试为导向的PHP包所需的所有代码。

它将自动安装以下依赖项

  • PHPUnit:提供测试框架。
  • PHP_CodeSniffer:检测违反定义的编码标准。
  • PHPMD:分析代码以检测次优或过度复杂的代码。
  • PHPStan:无需运行代码即可发现代码中的错误。
  • Psalm:来自Vimeo的另一个静态分析工具。
  • PHPMetrics提供各种指标。

以及流行持续集成工具的配置文件。

创建项目

要创建项目,请在您的控制台输入以下命令。

composer create-project koriym/php-skeleton <project-path>

您将需要回答几个问题以配置项目

What is the vendor name ?

(MyVendor):Koriym

What is the package name ?

(MyPackage):AwesomePackage

What is your name ?

(Akihito Koriyama):

What is your email address ?

(akihito.koriyama@gmail.com):

Composer命令

安装后,项目将自动配置,因此您可以在应用程序的根目录中运行以下命令

测试

composer test运行phpunit

测试

composer tests运行cssatest

覆盖率、phpdbg、pcov

composer coverage生成测试覆盖率报告。coverage使用XDebugphpdbg使用phpdbgpcov使用pcov

cs、cs-fix

composer cs检查编码标准。composer cs-fix修复PHP代码。

sa

composer sa运行静态代码分析工具。(phpstan和psalm)

指标

composer metrics报告代码指标

构建

composer build构建所有报告。