在 VS Code 中尝试！

语言配置指南

contributes.languages 贡献点允许你定义一个语言配置，该配置控制以下声明性语言特性

  • 注释切换
  • 括号定义
  • 自动闭合
  • 自动环绕
  • 折叠
  • 单词模式
  • 缩进规则

这是一个语言配置示例，它配置了 JavaScript 文件的编辑体验。本指南解释了 language-configuration.json 的内容

注意：如果你的语言配置文件名是或以 language-configuration.json 结尾，你将在 VS Code 中获得自动补全和验证。

{
  "comments": {
    "lineComment": "//",
    "blockComment": ["/*", "*/"]
  },
  "brackets": [
    ["{", "}"],
    ["[", "]"],
    ["(", ")"]
  ],
  "autoClosingPairs": [
    { "open": "{", "close": "}" },
    { "open": "[", "close": "]" },
    { "open": "(", "close": ")" },
    { "open": "'", "close": "'", "notIn": ["string", "comment"] },
    { "open": "\"", "close": "\"", "notIn": ["string"] },
    { "open": "`", "close": "`", "notIn": ["string", "comment"] },
    { "open": "/**", "close": " */", "notIn": ["string"] }
  ],
  "autoCloseBefore": ";:.,=}])>` \n\t",
  "surroundingPairs": [
    ["{", "}"],
    ["[", "]"],
    ["(", ")"],
    ["'", "'"],
    ["\"", "\""],
    ["`", "`"]
  ],
  "folding": {
    "markers": {
      "start": "^\\s*//\\s*#?region\\b",
      "end": "^\\s*//\\s*#?endregion\\b"
    }
  },
  "wordPattern": "(-?\\d*\\.\\d\\w*)|([^\\`\\~\\!\\@\\#\\%\\^\\&\\*\\(\\)\\-\\=\\+\\[\\{\\]\\}\\\\\\|\\;\\:\\'\\\"\\,\\.\\<\\>\\/\\?\\s]+)",
  "indentationRules": {
    "increaseIndentPattern": "^((?!\\/\\/).)*(\\{[^}\"'`]*|\\([^)\"'`]*|\\[[^\\]\"'`]*)$",
    "decreaseIndentPattern": "^((?!.*?\\/\\*).*\\*/)?\\s*[\\)\\}\\]].*$"
  }
}

注释切换

VS Code 提供了两个用于注释切换的命令。切换行注释和切换块注释。你可以指定 comments.blockComment 和 comments.lineComment 来控制 VS Code 应如何注释掉行/块。

{
  "comments": {
    "lineComment": "//",
    "blockComment": ["/*", "*/"]
  }
}

括号定义

当你将光标移至此处定义的括号时，VS Code 将高亮显示该括号及其匹配的另一半。

{
  "brackets": [
    ["{", "}"],
    ["[", "]"],
    ["(", ")"]
  ]
}

此外，当你运行转到括号或选中到括号时，VS Code 将使用上述定义来查找最近的括号及其匹配的另一半。

自动闭合

当你键入 ' 时，VS Code 会创建一对单引号并将光标放在中间：'|'。本节定义了此类配对。

{
  "autoClosingPairs": [
    { "open": "{", "close": "}" },
    { "open": "[", "close": "]" },
    { "open": "(", "close": ")" },
    { "open": "'", "close": "'", "notIn": ["string", "comment"] },
    { "open": "\"", "close": "\"", "notIn": ["string"] },
    { "open": "`", "close": "`", "notIn": ["string", "comment"] },
    { "open": "/**", "close": " */", "notIn": ["string"] }
  ]
}

notIn 键在某些代码范围内禁用此功能。例如，当你编写以下代码时

// ES6's Template String
`ES6's Template String`;

单引号将不会自动闭合。

不需要 notIn 属性的配对也可以使用更简单的语法

{
  "autoClosingPairs": [
    ["{", "}"],
    ["[", "]"]
  ]
}

用户可以通过 editor.autoClosingQuotes 和 editor.autoClosingBrackets 设置微调自动闭合行为。

之前自动闭合

默认情况下，VS Code 仅在光标正后方有空白时自动闭合配对。因此，当你在以下 JSX 代码中键入 { 时，你将不会获得自动闭合

const Component = () =>
  <div className={>
                  ^ Does not get autoclosed by default
  </div>

但是，此定义会覆盖该行为

{
  "autoCloseBefore": ";:.,=}])>` \n\t"
}

现在，当你在 > 前键入 { 时，VS Code 会自动闭合为 }。

自动环绕

当你在 VS Code 中选择一个范围并输入一个左括号时，VS Code 会用一对括号环绕选定的内容。此功能称为自动环绕，你可以在此处定义特定语言的自动环绕配对

{
  "surroundingPairs": [
    ["{", "}"],
    ["[", "]"],
    ["(", ")"],
    ["'", "'"],
    ["\"", "\""],
    ["`", "`"]
  ]
}

用户可以通过 editor.autoSurround 设置微调自动环绕行为。

折叠

在 VS Code 中，折叠可以是基于缩进定义，也可以由贡献的折叠范围提供程序定义

  • 基于缩进的标记折叠：如果给定语言没有可用的折叠范围提供程序，或者用户已将 editor.foldingStrategy 设置为 indentation，则使用基于缩进的折叠。当一行比后面一行或多行缩进少时，折叠区域开始；当遇到缩进相同或更少的行时，折叠区域结束。空行会被忽略。此外，语言配置可以定义开始和结束标记。这些标记在 folding.markers 中定义为 start 和 end 正则表达式。当找到匹配的行时，会在该对标记内创建一个折叠范围。折叠标记必须非空，通常看起来像 //#region 和 //#endregion。

以下 JSON 为 //#region 和 //#endregion 创建了折叠标记。

{
  "folding": {
    "markers": {
      "start": "^\\s*//\\s*#?region\\b",
      "end": "^\\s*//\\s*#?endregion\\b"
    }
  }
}
  • 语言服务器折叠：语言服务器通过textDocument/foldingRange 请求响应折叠范围列表，VS Code 会将这些范围渲染为折叠标记。在编程语言特性主题中了解更多关于语言服务器协议中的折叠支持。

单词模式

wordPattern 定义了在编程语言中什么是单词。如果设置了 wordPattern，代码建议特性将使用此设置来确定单词边界。请注意，此设置不会影响与单词相关的编辑器命令，这些命令由编辑器设置 editor.wordSeparators 控制。

{
  "wordPattern": "(-?\\d*\\.\\d\\w*)|([^\\`\\~\\!\\@\\#\\%\\^\\&\\*\\(\\)\\-\\=\\+\\[\\{\\]\\}\\\\\\|\\;\\:\\'\\\"\\,\\.\\<\\>\\/\\?\\s]+)"
}

缩进规则

indentationRules 定义了当您输入、粘贴和移动行时，编辑器应如何调整当前行或下一行的缩进。

{
  "indentationRules": {
    "increaseIndentPattern": "^((?!\\/\\/).)*(\\{[^}\"'`]*|\\([^)\"'`]*|\\[[^\\]\"'`]*)$",
    "decreaseIndentPattern": "^((?!.*?\\/\\*).*\\*/)?\\s*[\\)\\}\\]].*$"
  }
}

例如，if (true) { 匹配 increaseIndentPattern，然后如果你在左括号 { 后按 Enter，编辑器会自动缩进一次，你的代码将变为

if (true) {
  console.log();

除了 increaseIndentPattern 和 decreaseIndentPattern，还有另外两个缩进规则

  • indentNextLinePattern - 如果某行匹配此模式，则仅其下一行应缩进一次。
  • unIndentedLinePattern - 如果某行匹配此模式，则其缩进不应改变，并且不应根据其他规则进行评估。

如果编程语言没有设置缩进规则，当行以左括号结尾时编辑器会缩进，当您键入右括号时会反缩进。这里的括号由 brackets 定义。

请注意，editor.formatOnPaste 设置由DocumentRangeFormattingEditProvider 控制，不受自动缩进的影响。

回车规则

onEnterRules 定义了一个规则列表，这些规则将在编辑器中按下 Enter 时进行评估。

{
  "onEnterRules": [
    {
      "beforeText": "^\\s*(?:def|class|for|if|elif|else|while|try|with|finally|except|async).*?:\\s*$",
      "action": { "indent": "indent" }
    }
  ]
}

按下 Enter 时，将根据以下属性检查光标之前、之后或上方一行文本

  • beforeText（强制）。匹配光标前文本的正则表达式（仅限于当前行）。
  • afterText。匹配光标后文本的正则表达式（仅限于当前行）。
  • previousLineText。匹配光标上方一行文本的正则表达式。

如果所有指定的属性都匹配，则规则被视为匹配，并且不会评估进一步的 onEnterRules。一个 onEnterRule 可以指定以下操作

  • indent（强制）。以下之一：none, indent, outdent, indentOutdent。
    • none 表示新行将继承当前行的缩进。
    • indent 表示新行将相对于当前行缩进。
    • outdent 表示新行将相对于当前行反缩进。
    • indentOutdent 表示将插入两个新行，一个缩进，第二个反缩进。
  • appendText。将在新行和缩进后附加的字符串。
  • removeText。从新行缩进中删除的字符数。
05/08/2025