malukenho/docheader

一个用于检查头部文档的小型库

1.1.0 2024-02-05 12:05 UTC

README

Build Status Code Coverage Scrutinizer Code Quality Latest Stable Version Total Downloads Latest Unstable Version License

我们在项目中更改版权年份浪费了多长时间?我们有多少次忘记更新它,然后在新的一年里使用去年的版权日期?这真糟糕!!

将文档头部检查放入您的构建中,让它远离您的麻烦!

安装

 composer require --dev --sort-packages malukenho/docheader

设置

在运行检查器/修复器的目录中创建一个名为 .docheader 的文件,并将头部文档放入其中。该文件必须只包含您想要的文档块,如下面的示例所示

/**
 * Zend Framework (http://framework.zend.com/)
 *
 * @link      http://github.com/zendframework/zf2 for the canonical source repository
 * @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
 * @license   http://framework.zend.com/license/new-bsd New BSD License
 */

然后运行检查器

./vendor/bin/docheader check src/

所以,您会得到错误消息或者表示一切正常的信息!

Docheader 文件

默认情况下,docheader 在执行命令的当前目录中搜索名为 .docheader 的文件。但您可以使用选项 --docheader [文件或路径] 指定一个文件夹或文件作为占位符。

当前年份占位符

您也可以在 .docheader 文件中放置 %year% 来引用当前年份,如下所示

/**
 * @copyright Copyright (c) 2005-%year% Zend Technologies USA Inc. (http://www.zend.com)
 */

正则表达式断言

如果您使用的是 >=0.1.5 版本,您可以使用 %regexp:% 占位符来匹配某些内容。

示例

/**
 * @copyright Copyright (c) 20%regexp:\d{2}%-2016 Zend Technologies USA Inc. (http://www.zend.com)
 */

在这种情况下,%regexp:\d{2}% 断言应该是一个在 20- 之间的两位数字。