T-DOC
  • Laravel-11
  • Laravel-10
  • Laravel-6X
  • Laravel-5.5
Dcat-Admin
  • Yii2
  • 重构2
  • Laravel-11
  • Laravel-10
  • Laravel-6X
  • Laravel-5.5
Dcat-Admin
  • Yii2
  • 重构2
  • 前言

    • 发行说明
    • 升级指南
    • 贡献导引
  • 入门指南

    • 安装
    • 配置信息
    • 目录结构
    • 前端
    • 起步套件
    • 部署
  • 核心架构

    • 请求周期
    • 服务容器
    • 服务提供者
    • Facades
  • 基础功能

    • 路由
    • 中间件
    • CSRF 保护
    • 控制器
    • 请求
    • 响应
    • 视图
    • Blade 模板
    • Vite 编译 Assets
    • 生成 URL
    • 会话
    • 表单验证
    • 错误处理
    • 日志
  • 继续深入

    • Artisan 命令行
    • 广播系统
    • 缓存系统
    • 集合
    • Contracts
    • 事件系统
    • 文件存储
    • 辅助函数
    • HTTP 客户端
    • 本地化
    • 发送邮件
    • 消息通知
    • 扩展包开发
    • 进程管理
    • 队列
    • 请求限流
    • 任务调度
  • 安全相关

    • 用户认证
    • 用户授权
    • Email 认证
    • 加密解密
    • 哈希
    • 重置密码
  • 数据库

    • 快速入门
    • 查询构造器
    • 分页
    • 数据库迁移
    • 数据填充
    • Redis
  • Eloquent ORM

    • 快速入门
    • 模型关联
    • Eloquent 集合
    • 属性修改器
    • API 资源
    • 序列化
    • Eloquent 数据工厂
  • 测试相关

    • 快速入门
    • HTTP 测试
    • 命令行测试
    • Dusk
    • 数据库测试
    • 测试模拟器 Mocking
  • 官方扩展包

    • 交易工具包 (Stripe)
    • 交易工具包 (Paddle)
    • Envoy 部署工具
    • Fortify 授权生成器
    • Homestead 虚拟机
    • Horizon 队列管理工具
    • Jetstream
    • Mix
    • Octane(加速引擎)
    • Passport OAuth 认证
    • Pennant
    • Pint
    • Sail 开发环境
    • Sanctum API 授权
    • Scout 全文搜索
    • Socialite 社会化登录
    • Telescope 调试工具
    • Valet Mac 集成环境

Laravel Pint

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

介绍

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

Presets(预设)

Presets 定义了一组规则,可以用来修复代码风格问题。默认情况下,Pint 使用 laravel preset,通过遵循 Laravel 的固定编码风格来修复问题。但是,你可以通过向 Pint 提供 --preset 选项来指定一个不同的 preset 值:

pint --preset psr12

如果你愿意,还可以在项目的 pint.json 文件中设置 preset :

{
  "preset": "psr12"
}

Pint 目前支持的 presets 有:laravel、psr12 和 symfony。

规则

规则是 Pint 用于修复代码风格问题的风格指南。如上所述,presets 是预定义的规则组,适用于大多数 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将检查项目中除 vendor 目录以外的所有 .php 文件。如果您希望排除更多文件夹,可以使用 exclude 配置选项:

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

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

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

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

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

本译文仅用于学习和交流目的,转载请务必注明文章译者、出处、和本文链接
我们的翻译工作遵照 CC 协议,如果我们的工作有侵犯到您的权益,请及时联系我们。


原文地址:https://learnku.com/docs/laravel/10.x/pi...

译文地址:https://learnku.com/docs/laravel/10.x/pi...

Last Updated:
Contributors: Hans
Prev
Pennant
Next
Sail 开发环境