dodger451/laravelcodechecker

基于phpmd、phpcs和lint的配置性PHP基本设置,支持Artisan

1.0 2019-01-17 22:40 UTC

This package is auto-updated.

Last update: 2024-09-19 02:28:55 UTC


README

[StyleCI]

通过php -lphpmdphpcs命令行创建Laravel artisan命令,用于验证应用程序的源代码。

将预定义的样式规则集发布到config/目录,以便进行自定义。

安装

通过Composer安装

$ composer require --dev dodger451/laravelcodechecker

然后运行以下命令将默认配置文件复制到/config目录:

php artisan vendor:publish --tag=laravelcodechecker

这将在/config目录中创建一些phpmd和phpcs的规则集

config/
    laravelcodechecker.php
    phpcs/
        ruleset.xml
    phpmd/
        rulesets/
            cleancode.xml
            codesize.xml
            controversial.xml
            design.xml
            naming.xml
            unusedcode.xml

根据您的偏好,在phpcs/ruleset.xmlphpmd/rulesets/*.xml中采用规则,cc:命令将默认使用它们。要更改默认的规则文件,请修改config/laravelcodechecker.php

使用方法

要验证应用程序的所有检查,请运行:

php artisan cc:all

这将运行php -lphpmdphpcstests/routes/config/app/中的所有.php文件。

或者,分别运行每个命令

php artisan cc:phplint
php artisan cc:phpcs
php artisan cc:phpmd

默认情况下,每个命令将针对tests routes config app。您可以为每个cc:命令提供目录和/或文件作为参数,如果您不想使用config/laravelcodechecker.php中的默认目标。

例如,要将phpmd限制在tests/app/目录中运行,请执行以下操作:

php artisan cc:phpmd tests app

要更改每个命令的默认目标,请修改laravelcodechecker.php

Travis

travis-ci.org的示例.travis.yml

language: php
php:
  - '7.1'
  - '7.2'
  - nightly

install:
  - composer install

script:
  - php artisan cc:all

变更日志

有关最近更改的更多信息,请参阅变更日志

贡献

请参阅contributing.md以获取详细信息和一个待办事项列表。

安全

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

鸣谢

许可

许可。有关更多信息,请参阅许可文件

[link-styleci]: https://styleci.io/repos/154905196)] [link-author]: https://github.com/dodger451