mlocati/concrete5-since-tagger

比较concrete5版本间的数据,并管理@since PHPDoc标签

dev-master 2019-09-30 15:27 UTC

This package is auto-updated.

Last update: 2024-08-29 04:49:10 UTC


README

在为多个concrete5版本开发时,开发者需要知道类/接口/方法/常量/...是在哪个版本中引入的。

使用@since phpdoc标签是记录这一信息的标准方式。

实现过程需要以下步骤

  1. 分析所有concrete5版本(从5.7.0开始),提取定义的类/接口/方法/常量/...。这可以通过使用./bin/concrete5-since-tagger update CLI命令(分析所有concrete5版本)和/或使用./bin/concrete5-since-tagger parse <version> CLI命令(分析/重新分析特定concrete5版本)来完成
  2. 修补当前的开发版本,与之前解析的版本进行比较。这可以通过使用./bin/concrete5-since-tagger patch <path> CLI命令来完成

要求

  1. MySQL实例
  2. PHP 7.2+ 以及PHP 5.x(PHP 5.x是分析过程所必需的)
  3. 需要unzip CLI命令

设置

  1. .env.dist复制到.env并个性化配置
  2. 运行composer install
  3. 运行./bin/concrete5-since-tagger orm:schema-tool:create以初始化数据库

典型用法

# Parse all the concrete5 versions
./bin/concrete5-since-tagger update

# Patch the development version
./bin/concrete5-since-tagger patch /path/to/concrete5

可用的数据

update命令是一个非常耗时的过程:它需要下载和解析所有concrete5版本。如果您不想这样做,可以预先用这个SQL转储填充数据库。