刀片格式化器（Blade Formatter）：提升Laravel模板的可读性

刀片格式化器（Blade Formatter）：提升Laravel模板的可读性

blade-formatter An opinionated blade template formatter for Laravel that respects readability 项目地址: https://gitcode.com/gh_mirrors/bl/blade-formatter

---

项目介绍

刀片格式化器 是一个专为 Laravel 开发的刀片（Blade）模板意见化的格式化工具，旨在提高模板代码的可读性和一致性。在 Laravel 生态中，它弥补了官方未提供模板格式化功能的空白。支持 PHP 8 及其新特性如空安全操作符和命名参数，并且遵循 PSR-2 格式要求，在 Blade 指令内自动缩进和调整空间。此外，该工具具备自动排序 Tailwind CSS 类的能力，以增强前端代码的维护性。

项目快速启动

要迅速启用并开始使用 Blade Formatter，您需按以下步骤操作：

安装

您可以使用 npm 或 yarn 全局安装此工具：

npm install -g blade-formatter
# 或
yarn global add blade-formatter

格式化文件

一旦安装完成，即可立即对您的 Blade 模板进行格式化。例如，格式化 resources/views/**/*.blade.php 中的所有文件：

blade-formatter resources/**/*.blade.php --blade php

若想查看文件是否已格式化而不做修改，可以使用 --check-formatted 或 -c 选项：

blade-formatter resources/**/*.blade.php -c -d --blade php

对于即时更改文件内容，加上 --write 选项：

blade-formatter --write resources/**/*.blade.php --blade php

应用案例和最佳实践

在日常开发中，将 Blade Formatter 集成到持续集成流程或开发环境的脚本中，确保每次提交前代码都保持一致的风格。例如，在 Git 的 pre-commit hook 中调用它可以保证代码库的整洁。此外，结合 IDE 插件如 VSCode 的 vscode-blade-formatter 或 Neovim 的 coc-blade，可以在保存文件时自动格式化，提升编码效率。

示例配置

创建 .bladeformatterrc.json 文件以自定义配置：

{
    "indentSize": 2,
    "wrapAttributes": "auto",
    "endWithNewLine": true
}

典型生态项目

• VSCode 扩展: vscode-blade-formatter 提供了在 Visual Studio Code 中直接格式化 Blade 模板的支持。
• Coc.nvim 扩展: coc-blade, 由 @yaegassy 开发，为 Neovim 用户提供了同样便捷的格式化体验。
• Prettier 插件: prettier-plugin-blade 让流行的代码美化工具 Prettier 支持 Blade 模板。
• null-ls.nvim: 通过 @jose-elias-alvarez 提供的插件，让 Neovim 使用外部 LSP 如 Blade Formatter 进行代码格式化。

通过这些生态系统项目，开发者可以选择最适合自己的开发环境集成方式，确保代码风格的一致性和开发效率的提升。

---

以上就是关于 Blade Formatter 的简明教程，它不仅简化了 Laravel 项目的代码风格统一过程，同时也促进了团队之间代码审查的流畅性。

blade-formatter An opinionated blade template formatter for Laravel that respects readability 项目地址: https://gitcode.com/gh_mirrors/bl/blade-formatter