nguyendotrung/laravel-lint

这是一个用于检查Laravel项目一致性和编码规范的工具。如果在使用过程中有任何问题,请与我联系。

2.0.0 2021-06-21 12:15 UTC

This package is auto-updated.

Last update: 2024-09-23 11:42:56 UTC


README

检查Laravel项目的编码规范和编码一致性。

安装

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

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

用法

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

对于检查每个功能,请提供第三个参数,包括 envlangphpjs
amv lint env
amv lint lang
amv lint php
amv lint js

默认情况下,检查执行将在第一个错误发生时停止。有时,你可能需要检查执行直到结束。所以,只需为执行命令提供 -g 标志。注意:如果你提供了检查单个功能的参数,请将 -g 标志放在检查功能的名称之前。
amv lint -g
amv lint -g env
amv lint -g lang
amv lint -g php
amv lint -g js

配置

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

DEBUG_MODE

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

CHECKING_STANDARDS

这是检查执行的PHP标准列表。标准由逗号 , 分隔,你可以提供以下标准:psr1psr2psr12pear

IS_STAGED_CHECKING

如果设置为 true,检查执行将对暂存文件(你添加用于提交的文件)执行检查。否则,如果你将此变量设置为 false,以下文件夹将被检查

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

这些变量的值是字符串,由一个或多个文件夹组成,用逗号 , 分隔。