daniel-werner/php-quality-tools

一个有偏见的包,用于轻松安装PHP质量工具,并提供合理的默认设置

2.1.0 2021-10-31 15:54 UTC

This package is auto-updated.

Last update: 2024-09-14 16:03:21 UTC


README

Latest Version on Packagist Build Status Build Status Quality Score Total Downloads

此包安装了最常用的PHP质量工具: PHP Code SnifferPHP Mess DetectorPHP静态分析工具PHP编码标准修复工具。它包含一些合理的预定义配置,并使用PSR-2编码风格。此包可以与Laravel应用程序或任何PHP项目一起使用,它不是一个特定的Laravel包。

此包的目的是允许PHP开发者快速安装和配置他们项目所需的所有质量工具。

安装

您可以通过composer安装此包

composer require --dev daniel-werner/php-quality-tools

使用composer安装后,从您项目的 root 目录运行以下命令

vendor/bin/phpqt-install

这将复制工具的默认xml设置,并在 composer.json 中设置脚本。

安装脚本将尝试猜测您的项目中的源代码目录,如果是Laravel应用程序,它将使用 app 目录;如果是包,它将使用 src 目录;否则为当前目录。

您可以将源代码目录作为安装脚本的第一个参数传递,如下所示

vendor/bin/phpqt-install my-app-src

安装完成后,xml配置可以在您的项目根目录中找到。您可以通过更改xml文件中的设置来自定义phpcs和phpmd配置。

用法

该包在 composer.json 中定义了以下脚本

  • composer inspect:此命令运行PHP Code Sniffer (phpcs) 和PHP静态分析工具 (phpstan)。它将分析您的代码风格并运行phpstan,默认最小级别为0
  • composer inspect-fix:此命令将尝试通过运行PHP编码标准修复工具 (php-cs-fixer) 和PHP代码美化修复工具 (phpcbf) 来修复检查中发现的问题。
  • composer insights:运行PHP Mess Detector以查找您的代码中的任何潜在问题。

测试

composer test

变更日志

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

贡献

有关详细信息,请参阅 CONTRIBUTING

安全性

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

致谢

许可

MIT许可(MIT)。请参阅 许可文件 了解更多信息。

PHP包模板

此包是使用 PHP包模板 生成的。