语言配置指南

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 控制，不受自动缩进影响。

Enter 键规则

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。要从新行的缩进中删除的字符数。