README

检查laravel项目的编码约定和编码一致性。

安装

在laravel项目的根目录中运行以下命令
composer require amv-hub/amv-lint --dev

安装包后，运行以下命令初始化包配置
./vendor/amv-hub/amv-lint/init.sh

用法

检查

安装包后，要检查包含环境变量检查、语言翻译文件检查、JavaScript和PHP的编码一致性和编码约定，请运行以下命令
amv lint

单独功能检查

对于单独检查每个功能，请提供一个第三个参数，包括env、lang、php、js
amv lint env
amv lint lang
amv lint php
amv lint js

强制进入DEBUG模式

默认情况下，检查执行将在首次出现错误时停止。有时，您可能需要检查执行直到结束。因此，只需为执行命令提供-g标志。注意：如果您提供了单独的功能进行检查，请将-g标志放置在检查功能的名称之前。
amv lint -g
amv lint -g env
amv lint -g lang
amv lint -g php
amv lint -g js

修复常见问题

AMV Lint使用PHP_CodeSniffer检查PHP文件的编码约定，并使用ESLint检查JavaScript文件。因此，您可以使用它们的所有功能进行检查。其中两个还提供了修复一些常见问题的工具。您可以通过以下命令执行修复功能
amv lint --fix

或通过以下方式修复单个功能
amv lint php --fix

配置

通用配置文件是.amv_lint.env，它位于您的项目根目录中。它包含各种环境变量。以下功能是最重要的，您应该了解。

DEBUG_MODE

当您将此变量设置为true时，它将以与在检查命令中设置-g标志相同的方式工作。但是，当您提供-g标志时，此变量将被忽略。例如，如果您将DEBUG_MODE设置为false，

CHECKING_STANDARDS

这是检查执行的PHP标准列表。标准由逗号,分隔，您可以提供以下标准：psr1、psr2、psr12、pear。

IS_STAGED_CHECKING

如果设置为true，检查执行将执行带有暂存文件（您添加用于提交的文件）的检查。否则，如果将此变量设置为false，以下文件夹将被检查

环境变量检查：代表在ENV_USING_CHECKING_DIRS变量中的文件夹。
对于PHP文件检查：代表在PHP_CONVENTION_CHECKING_DIRS变量中的文件夹。
对于JavaScript检查：代表在JS_CONVENTION_CHECKING_DIRS变量中的文件夹。

这些变量的值是一串一个或多个文件夹，由逗号,分隔。

amv-hub / amv-lint

维护者

详细信息