gasolwu/php-makefile

PHP 的 Makefile 脚本

v0.2.1 2019-11-15 09:55 UTC

This package is auto-updated.

Last update: 2024-09-15 20:56:09 UTC


README

一组 Makefile 由针对 PHP 开发的有用规则组成。

asciicast

安装

使用 Composer 安装作为开发包

composer require --dev gasolwu/php-makefile

或者,将以下片段追加到您的 composer.json 中,然后通过 composer install 手动运行安装

{
    "require-dev": {
        "gasolwu/php-makefile": "^0.1"
    }
}

入门指南

最小设置是创建自己的 Makefile 并包含 PHP.mk。

cat > Makefile <<EOF
include vendor/gasolwu/php-makefile/PHP.mk
EOF

用法

可用目标

基本

  • make syntax - 通过 PHP 内置的代码检查器检查语法
  • make clean - 删除构建目录

使用 USES=phpunit

  • make phpunit.xml - 生成带有建议设置的 PHPUnit 配置文件
  • make phpunit - 使用 PHPUnit 运行测试

使用 USES=composer

  • make vendor - 使用 Composer 安装依赖项

使用 USES=phpcs

  • make style - 使用 PHP_CodeSniffer 检查编码风格

提示

默认情况下,有两种运行测试的方法,因此您可以通过运行 make 而不是 make phpunit 来运行测试

  1. 定义 .DEFAULT_GOAL

     .DEFAULT_GOAL := phpunit
    
  2. 声明依赖于 phpunitall 目标

     all: phpunit
    

配置

这些变量默认情况下应该对大多数 PHP 库都有效,如果不适用,请随意应用适用于您的更改。

  • USES - 可能的值包括
    • composer
    • phpunit
    • phpcs
  • BUILD_DIR - 构建目录,其中包含构建阶段期间生成的所有文件都放在这里。应在 VCS 忽略文件中列出。默认为 build
  • PHP_SRCDIR - 源目录,默认为 src
  • PHP_TESTDIR - 测试目录,默认为 tests

许可协议

MIT - 版权所有 © 2019 Gasol Wu