Rome VS Code扩展：统一开发工具，提升效率

Rome VS Code扩展通过将多个工具的功能整合到一个平台，统一您的开发工具。它使用单一配置文件，性能优异，适用于任何开发栈。本扩展将Rome引入您的编辑器，帮助您：

• 在保存文件时或执行“格式化文档”命令时自动格式化文件
• 在输入时查看lint提示并应用代码修复
• 执行代码重构

安装

您可以通过以下两种方式安装Rome VS Code扩展：

• 打开扩展选项卡（视图 → 扩展），搜索Rome。
• 打开快速打开覆盖层（Ctrl/⌘ P或转到 → 转到文件），输入ext install rome.rome，然后按回车。

入门指南

默认格式化程序

将Rome配置为支持文件的默认格式化程序，以确保VS Code优先使用Rome而不是其他已安装的格式化程序。您可以通过打开JavaScript或TypeScript文件，然后：

• 打开命令面板（Ctrl/⌘ ⇧ P或视图 → 命令面板）
• 选择使用…格式化文档
• 选择配置默认格式化程序…
• 选择Rome

您还可以仅为特定语言启用Rome：

• 打开settings.json：打开命令面板（Ctrl/⌘ ⇧ P），选择首选项：打开用户设置（JSON）
• 并将editor.defaultFormatter设置为rome.rome，适用于所需的语言

{
    "editor.defaultFormatter": "<其他格式化程序>",
    "[javascript]": {
        "editor.defaultFormatter": "rome.rome"
    }
}

此配置将Rome设置为JavaScript文件的默认格式化程序。所有其他文件将使用<其他格式化程序>进行格式化。

配置解析

扩展会自动从工作区根目录加载rome.json文件。

Rome解析

扩展尝试使用项目中的本地依赖（node_modules/rome）中的Rome。我们建议将Rome添加为项目依赖，以确保NPM脚本和扩展使用相同的Rome版本。

您还可以通过在编辑器选项中配置rome.lspBin设置，明确指定扩展应使用的rome二进制文件。

如果项目没有依赖Rome且未配置明确路径，扩展将使用其捆绑包中的Rome版本。

使用

格式化文档

要格式化整个文档，打开命令面板（Ctrl/⌘ ⇧ P），选择格式化文档。

要格式化文本范围，选择要格式化的文本，打开命令面板（Ctrl/⌘ ⇧ P），选择格式化选择。

保存时格式化

Rome遵循VS Code的保存时格式化设置。要启用保存时格式化，打开设置（文件 → 首选项 → 设置），搜索editor.formatOnSave，并启用该选项。

保存时修复

Rome遵循VS Code的保存时代码操作设置。要启用保存时修复，在vscode settings.json中添加"editor.codeActionsOnSave": { "quickfix.rome": true }。

导入排序【实验性】

Rome VS Code扩展通过“组织导入”代码操作实验性支持导入排序。默认情况下，此操作可以通过⇧ Alt O键盘快捷键运行，或者通过命令面板（Ctrl/⌘ ⇧ P）选择组织导入来访问。

如果您希望此操作在保存时自动运行而不是手动调用，可以在编辑器配置中添加以下内容：

{
    "editor.codeActionsOnSave":{
        "source.organizeImports.rome": true
    }
}

扩展设置

rome.lspBin

rome.lspBin选项覆盖扩展使用的Rome二进制文件。如果路径是相对的，则使用工作区文件夹作为基本路径。

rome.rename

启用Rome处理工作区中的重命名（实验性）。

rome.requireConfiguration

对于没有rome.json文件的项目，禁用格式化、linting和语法错误。需要Rome 12或更高版本。默认启用。

版本控制

我们遵循官方文档建议的规范：

奇数次版本用于预发布，例如.5.。偶数次版本用于正式发布，例如.6.。