indentno/laravel-linter

为您的laravel项目进行代码风格检查

维护者

详情

github.com/indentno/laravel-linter

源代码

问题

安装: 735

依赖: 0

建议者: 0

安全性: 0

星星: 0

关注者: 2

分支: 0

开放问题: 6

0.6.6 2024-05-15 12:09 UTC

Requires

Requires (Dev)

MIT 282eaa33524c371f7104204efee6be79f2baa2a4

This package is auto-updated.

Last update: 2024-09-15 13:02:15 UTC

README

为您的laravel项目进行代码风格检查。

Build Status PRs Welcome psr-2

基于Tighten团队提供的tlint包的laravel代码风格检查工具。

安装

将包作为开发依赖安装

composer require indentno/laravel-linter --dev

在仓库根目录下创建一个配置文件（tlint.json），内容如下

{
  "preset": "Indent\\LaravelLinter\\Presets\\IndentPreset",
  "excluded": [
    "tests/",
    "database/"
  ]
}

使用方法

运行预设中的所有代码风格检查器

./vendor/bin/tlint

针对单个文件或目录运行代码风格检查器

./vendor/bin/tlint lint app/Http/Controllers/PageController.php
./vendor/bin/tlint lint app

使用单个代码风格检查器检查项目

./vendor/bin/tlint --only="NoCompact"

配置

tlint.json配置支持三个不同的配置键。

预设

"preset"定义了用于项目代码风格检查的预设。预设实际上是一组代码风格检查器或规则，项目应遵守这些规则。

排除

"excluded"是一个包含应从代码风格检查过程中排除的路径的数组。

禁用

"disabled"键可以用来禁用项目中的某些代码风格检查器。

{
  "preset": "Indent\\LaravelLinter\\Presets\\IndentPreset",
  "disabled": [
      "NoCompact",
      "UseConfigOverEnv"
  ],
  "excluded": [
    "tests/",
    "database/"
  ]
}

规则

需要进一步解释的规则概述。

ValidRouteStructure

路由应按照我们喜欢的结构来组织。

示例

Route::get('articles', [ArticleController::class, 'index'])->name('article.index');

Route::patch('page/{id}', [PageController::class, 'update'])
    ->name('admin.page.update')
    ->middleware(CanUpdatePage::class);

许可

MIT © Indent