– 代理会话日,2月19日

语言配置指南

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.blockCommentcomments.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.autoClosingQuoteseditor.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 中的 startend 正则表达式。找到匹配的行时,将在配对内创建一个折叠范围。折叠标记必须非空,通常看起来像 //#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();

除了 increaseIndentPatterndecreaseIndentPattern 之外,还有另外两个缩进规则

  • 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。与光标上方的一行文本匹配的正则表达式。

如果所有指定的属性都匹配,则认为该规则匹配,并且不会评估进一步的 onEnterRulesonEnterRule 可以指定以下操作

  • indent(必需)。none, indent, outdent, indentOutdent 中的一个。
    • none 表示新行将继承当前行的缩进。
    • indent 表示新行将相对于当前行缩进。
    • outdent 表示新行将相对于当前行取消缩进。
    • indentOutdent 表示将插入两行新行,一行缩进,另一行取消缩进。
  • appendText。将附加在新行和缩进之后的一个字符串。
  • removeText。要从新行缩进中删除的字符数。
© . This site is unofficial and not affiliated with Microsoft.