padsoft/static-review

自定义静态代码审查类

1.1.4 2017-08-09 08:08 UTC

This package is auto-updated.

Last update: 2024-09-05 05:15:59 UTC


README

自定义静态代码审查类

Latest Version on Packagist Software License Quality Score Total Downloads SensioLabsInsight

目录

先决条件

该软件包的先决条件为 "sjparkinson/static-review": "squizlabs/php_codesniffer": "phpunit/phpunit" "scrutinizer/ocular" "phpmd/phpmd",需要在 composer 中按需安装。

按需安装

创建一个新的 Hooks 目录,并将 pre-commit.php 从 src/config 文件夹复制到其中。

$ mkdir hooks
$ copy vendor/padosoft/static-review/src/config/pre-commit.php hooks/pre-commit.php

变更日志

有关最近更改的更多信息,请参阅 CHANGELOG

安装

您可以通过 composer 安装此软件包。

$ composer require padosoft/static-review

打开根目录中的 hooks/pre-commit.php 文件(如上节“先决条件”中创建),并添加自定义审查。例如,如果您想添加 VarDumpReview 和 DdReview。

$review->addReview(new LineEndingsReview())
        //.....
        //.....
        //.....
        //.....
       ->addReview(new VarDumpReview());
       ->addReview(new DdReview());

最后,通过运行以下命令创建 pre-commit 钩子

create in .git/hooks a file named pre-commit like this

****************************************************************
#!/bin/sh

php.exe "hooks/pre-commit.php"
****************************************************************

This for windows environment, for linux and mac you must use this
****************************************************************
#!/bin/sh

php "hooks/pre-commit.php"
****************************************************************

示例

截图示例

贡献

有关详细信息,请参阅 CONTRIBUTINGCONDUCT

安全

如果您发现任何安全相关的问题,请通过电子邮件而不是使用问题跟踪器。

致谢

关于 Padosoft

Padosoft 是一家位于意大利佛罗伦萨的软件公司。专注于电子商务和网站。

许可证

MIT 许可证 (MIT)。有关更多信息,请参阅 许可证文件