jorisros/library-boilerplate

这是一个用于创建新库的模板。

v1.3 2020-04-11 11:04 UTC

This package is auto-updated.

Last update: 2024-09-11 21:40:26 UTC


README

这是一个需要用PHP编写的库的模板,它包含以下设置:

  • PHPunit 测试
  • 代码审查工具集成

使用方法

这个模板应该通过composer安装,以下命令用于使用模板:

composer create-project jorisros/library-boilerplate <name directory>

这将直接在创建的新目录中生成所有必要的文件。不再涉及git,您需要单独为项目设置git。

运行命令

Composer中指定了一些命令,使其更易于使用(抱歉记忆不好)

运行测试

您可以通过以下命令轻松运行测试: composer test

运行PHP代码审查命令

您可以通过以下命令轻松调用代码审查命令: composer cs

运行phan

您可以通过以下命令运行phan: composer phan

Docker

在Docker容器中运行phpunit测试

docker-compose exec php composer test

待办事项

  • 将项目添加到Packagist
  • 集成Travis上的测试运行设置
  • 集成Bitbucket pipeline上的测试运行设置
  • 集成Github actions上的测试运行设置
  • 将phan添加到项目中