jpchateau/prototype-php-library

快速启动新PHP库的开发

1.6.1 2020-12-03 01:04 UTC

This package is auto-updated.

Last update: 2024-09-04 09:56:11 UTC


README

PHP库原型是一个快速启动新PHP库开发的工具。

功能

此原型的目标是节省在开始开发PHP库时的时间。它将

  • 下载和安装基本文件 - 一个类及其测试类,具有适当的命名空间
  • 安装流行的QA工具:phpunit、phpstan和phpcs
  • 生成基本的.gitignore和README文件

请注意,.gitignore文件基于gitignore.io API。

要求

  • PHP >= 7.3
  • php-xml 扩展
  • php-mbstring 扩展
  • Composer

查看PHP路线图以了解此库支持的PHP版本。

使用

创建库是一个简单的两步过程。

  1. 首先,从这个原型创建一个项目。将MyDirectory替换为您的值以创建项目,并移动到创建的目录
$ composer create-project jpchateau/prototype-php-library MyDirectory && cd $_
  1. 然后,运行安装命令以完成过程。将MyCompanyMyProject替换为您的值
$ make company=MyCompany project=MyProject install

您已经准备好开发了!
别忘了选择一个许可证 ;)

测试

$ make tests

QA工具

$ bin/phpcs src/ --standard=PSR2
$ bin/phpstan analyse -l 7 src/