Laravel Pint

• 介绍
• 安装
• 运行 Pint
• 配置 Pint
  • 预设
  • 规则
  • 排除文件/文件夹

介绍

Laravel Pint 是一个为极简主义者设计的有主见的 PHP 代码风格修复工具。Pint 构建于 PHP-CS-Fixer 之上，使得确保代码风格保持干净和一致变得简单。

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

安装

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

composer require laravel/pint --dev

运行 Pint

您可以通过调用项目 vendor/bin 目录中的 pint 二进制文件来指示 Pint 修复代码风格问题：

./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 不需要任何配置。然而，如果您希望自定义预设、规则或检查的文件夹，可以通过在项目的根目录中创建一个 pint.json 文件来实现：

{
    "preset": "laravel"
}

此外，如果您希望使用特定目录中的 pint.json，可以在调用 Pint 时提供 --config 选项：

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

预设

预设定义了一组用于修复代码风格问题的规则。默认情况下，Pint 使用 laravel 预设，该预设通过遵循 Laravel 的有主见的编码风格来修复问题。然而，您可以通过向 Pint 提供 --preset 选项来指定不同的预设：

pint --preset psr12

如果您愿意，也可以在项目的 pint.json 文件中设置预设：

{
    "preset": "psr12"
}

Pint 当前支持的预设有：laravel、psr12 和 symfony。

规则

规则是 Pint 用于修复代码风格问题的风格指南。如上所述，预设是预定义的规则组，适用于大多数 PHP 项目，因此通常不需要担心它们包含的个别规则。

然而，如果您愿意，可以在 pint.json 文件中启用或禁用特定规则：

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

Pint 构建于 PHP-CS-Fixer 之上。因此，您可以使用其任何规则来修复项目中的代码风格问题：PHP-CS-Fixer Configurator。

排除文件/文件夹

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

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

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

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

如果您希望通过提供文件的确切路径来排除文件，可以使用 notPath 配置选项：

{
    "notPath": [
        "path/to/excluded-file.php"
    ]
}