vscode-blade-formatter

英文原文正文为项目原始 README（英文），本站后续会翻译为中文，当前仅剔除图片与无关章节并统一排版。

vscode 刀片格式化器

一个针对 VSCode 的有固定格式偏好的 Blade 文件格式化工具。Marketplace 页面在 这里。

你也可以使用此扩展依赖的 blade-formatter 通过相同语法以编程方式进行格式化。

功能

• 自动缩进指令内部的标记
• 自动为 Blade 模板标记添加空格
• 支持 PHP 8（空安全运算符、命名参数）🐘
• 支持 PSR-2（指令内部格式化）
• 根据 tailwind.config.js 自动排序 Tailwind CSS 类

屏幕录制

扩展设置

配置文件：.bladeformatterrc.json 或 .bladeformatterrc

要为每个项目配置设置，将 .bladeformatterrc.json 或 .bladeformatterrc 放到项目根目录，vscode-blade-formatter 会将其视为设置文件。

配置文件如下所示：

{
    "indentSize": 4,
    "wrapAttributes": "auto",
    "wrapAttributesMinAttrs": 2,
    "wrapLineLength": 120,
    "endWithNewLine": true,
    "noMultipleEmptyLines": false,
    "useTabs": false,
    "sortTailwindcssClasses": true,
    "sortHtmlAttributes": "none",
    "noPhpSyntaxCheck": false,
    "noSingleQuote": false,
    "noTrailingCommaPhp": false,
    "componentPrefix": ["x-", "livewire:"],
    "phpVersion": "8.4"
}

忽略文件：.bladeignore

要从格式化中排除文件，请在项目根目录中创建一个 .bladeignore 文件。.bladeignore 使用 gitignore 语法

# Ignore email templates
resources/views/email/**

在文件中禁用格式化

要在文件中禁用格式，您可以使用如下格式的 Blade 注释：

{{-- blade-formatter-disable --}}
    {{ $foo }}
    {{ $bar }}
{{-- blade-formatter-enable --}}

要在特定行禁用格式，可以使用以下格式的注释：

{{-- blade-formatter-disable-next-line --}}
    {{ $foo }}

要禁用整个文件的格式化，请在文件开头添加 {{-- blade-formatter-disable --}} 注释：

{{-- blade-formatter-disable --}}

{{ $foo }}

待办事项

• 为 HTML 格式规则添加更多选项
• 为 PHP 格式规则添加选项
• 自动化包发布流程
• 集成测试

版本说明

请参阅 CHANGELOG.md

相关项目

• blade-formatter - CLI Blade 格式化工具，该扩展依赖于此工具
• prettier-plugin-blade - Blade 的 Prettier 插件
• coc-blade - 由 @yaegassy 开发的 coc.nvim 扩展

贡献

1. 分叉它
2. 创建你的功能分支（git checkout -b my-new-feature）
3. 提交你的更改（git commit -am 'Add some feature'）
4. 推送到分支（git push origin my-new-feature）
5. 创建新的拉取请求

开发

$ npm install
$ cp .env.example .env # set your app insight key
$ npm run watch # watch changes

测试

$ npm install
$ cp .env.example .env # set your app insight key
$ npm run compile
$ npm run test
$ npm run test:e2e

许可证

麻省理工学院

数据和遥测

此扩展会收集使用数据并将其发送到 Azure Application Insight 以改进扩展。此扩展会遵守 telemetry.enableTelemetry 设置。

要选择退出，请将 telemetry.enableTelemetry 设置为 false。更多信息请参见 常见问题。