Laravel 品脱

Introduction

Laravel 品脱 是极简主义者的自以为是的 PHP 代码样式修复程序。 Pint 建立在 PHP-CS-Fixer 之上,可以轻松确保您的代码风格保持整洁和一致。

Pint 会自动安装所有新的 Laravel 应用程序,因此您可以立即开始使用它。默认情况下,Pint 不需要任何配置,并且会按照 Laravel 固执己见的编码风格来修复代码中的代码风格问题。

Installation

Pint 包含在 Laravel 框架的最新版本中,因此通常不需要安装。但是,对于较旧的应用程序,您可以通过 Composer 安装 Laravel Pint:

composer require laravel/pint --dev

运行品脱

您可以通过调用pint 项目中可用的二进制文件vendor/bin 目录:

./vendor/bin/pint

您还可以在特定文件或目录上运行 Pint:

./vendor/bin/pint app/Models

./vendor/bin/pint app/Models/User.php

Pint 将显示它更新的所有文件的完整列表。您可以通过提供以下命令查看有关 Pint 更改的更多详细信息-v 调用 Pint 时的选项:

./vendor/bin/pint -v

如果您希望 Pint 简单地检查您的代码是否存在样式错误而不实际更改文件,您可以使用--test 选项:

./vendor/bin/pint --test

如果您希望 Pint 仅根据 Git 修改具有未提交更改的文件,您可以使用--dirty 选项:

./vendor/bin/pint --dirty

配置品脱

如前所述,Pint 不需要任何配置。但是,如果您希望自定义预设、规则或检查的文件夹,您可以通过创建一个pint.json 项目根目录下的文件:

{
    "preset": "laravel"
}

此外,如果您想使用pint.json 从特定目录,您可以提供--config 调用 Pint 时的选项:

pint --config vendor/my-company/coding-style/pint.json

Presets

预设定义了一组规则,可用于修复代码中的代码样式问题。默认情况下,Pint 使用laravel 预设,它通过遵循 Laravel 固执己见的编码风格来修复问题。但是,您可以通过提供--preset 品脱选项:

pint --preset psr12

如果您愿意,您也可以在项目的pint.json 文件:

{
    "preset": "psr12"
}

Pint 当前支持的预设有:laravel,psr12, 和symfony.

Rules

规则是 Pint 将用来修复代码中的代码样式问题的样式指南。如上所述,预设是预定义的规则组,对于大多数 PHP 项目来说应该是完美的,因此您通常不需要担心它们包含的单个规则。

但是,如果您愿意,您可以启用或禁用您的特定规则pint.json 文件:

{
    "preset": "laravel",
    "rules": {
        "simplified_null_return": true,
        "braces": false,
        "new_with_braces": {
            "anonymous_class": false,
            "named_class": false
        }
    }
}

品脱建立在PHP-CS-Fixer.因此,您可以使用它的任何规则来修复项目中的代码样式问题:PHP-CS-Fixer 配置器.

排除文件/文件夹

默认情况下,Pint 将检查所有.php 项目中的文件,除了那些在vendor 目录。如果您希望排除更多文件夹,您可以使用exclude 配置选项:

{
    "exclude": [
        "my-specific/folder"
    ]
}

如果您希望排除所有包含给定名称模式的文件,您可以使用notName 配置选项:

{
    "notName": [
        "*-my-file.php"
    ]
}

如果您想通过提供文件的确切路径来排除文件,您可以使用notPath 配置选项:

{
    "notPath": [
        "path/to/excluded-file.php"
    ]
}
豫ICP备18041297号-2