语义高亮指南

语义高亮是语法高亮的补充，如语法高亮指南中所述。Visual Studio Code 使用 TextMate 语法作为主要的令牌化引擎。TextMate 语法以单个文件作为输入，并根据正则表达式表示的词法规则将其分解。

语义令牌化允许语言服务器根据语言服务器关于如何在项目上下文中解析符号的知识，提供额外的令牌信息。主题可以选择使用语义令牌来改进和优化来自语法的语法高亮。编辑器将来自语义令牌的高亮应用于来自语法的高亮之上。

以下是语义高亮可以添加内容的一个示例

没有语义高亮

有语义高亮

请注意基于语言服务符号理解的颜色差异

• 第 10 行：languageModes 被着色为参数
• 第 11 行：Range 和 Position 被着色为类，而 document 被着色为参数。
• 第 13 行：getFoldingRanges 被着色为函数。

语义令牌提供程序

要实现语义高亮，语言扩展可以按文档语言和/或文件名注册 semantic token provider（语义令牌提供程序）。当需要语义令牌时，编辑器将向提供程序发出请求。

const tokenTypes = ['class', 'interface', 'enum', 'function', 'variable'];
const tokenModifiers = ['declaration', 'documentation'];
const legend = new vscode.SemanticTokensLegend(tokenTypes, tokenModifiers);

const provider: vscode.DocumentSemanticTokensProvider = {
  provideDocumentSemanticTokens(
    document: vscode.TextDocument
  ): vscode.ProviderResult<vscode.SemanticTokens> {
    // analyze the document and return semantic tokens

    const tokensBuilder = new vscode.SemanticTokensBuilder(legend);
    // on line 1, characters 1-5 are a class declaration
    tokensBuilder.push(
      new vscode.Range(new vscode.Position(1, 1), new vscode.Position(1, 5)),
      'class',
      ['declaration']
    );
    return tokensBuilder.build();
  }
};

const selector = { language: 'java', scheme: 'file' }; // register for all Java documents from the local file system

vscode.languages.registerDocumentSemanticTokensProvider(selector, provider, legend);

语义令牌提供程序 API 有两种风格，以适应语言服务器的功能

• DocumentSemanticTokensProvider - 始终将完整文档作为输入。

  • provideDocumentSemanticTokens - 提供文档的所有令牌。
  • provideDocumentSemanticTokensEdits- 以增量形式提供文档的所有令牌，相对于之前的响应。

• DocumentRangeSemanticTokensProvider - 仅在范围内工作。

  • provideDocumentRangeSemanticTokens - 提供文档范围内的所有令牌。

提供程序返回的每个令牌都带有一个分类，该分类由令牌类型、任意数量的令牌修饰符和令牌语言组成。

如上面的示例所示，提供程序在 SemanticTokensLegend 中命名它将要使用的类型和修饰符。这允许 provide API 将令牌类型和修饰符作为图例的索引返回。

语义令牌分类

语义令牌提供程序的输出由令牌组成。每个令牌都有一个范围和一个令牌分类，用于描述令牌表示的语法元素的种类。可选地，如果令牌是嵌入式语言的一部分，则分类还可以命名一种语言。

为了描述语法元素的种类，使用了语义令牌类型和修饰符。此信息类似于语法高亮指南中描述的 TextMate 作用域，但我们希望提出一个专用且更清晰的分类系统。

VS Code 附带了一组标准的语义令牌类型和修饰符，供所有语义令牌提供程序使用。尽管如此，语义令牌提供程序可以自由定义新的类型和修饰符，并创建标准类型的子类型。

标准令牌类型和修饰符

标准类型和修饰符涵盖了许多语言使用的通用概念。虽然每种语言对于某些类型和修饰符可能使用不同的术语，但通过遵守标准分类，主题作者可以定义跨语言工作的主题规则。

以下是 VS Code 预定义的标准语义令牌类型和语义令牌修饰符

标准令牌类型

标准令牌修饰符

除了标准类型和修饰符之外，VS Code 还定义了类型和修饰符到类似 TextMate 作用域的映射。这在语义令牌作用域映射部分中介绍。

自定义令牌类型和修饰符

如果需要，扩展可以通过其扩展的 package.json 中的 semanticTokenTypes 和 semanticTokenModifiers 贡献点声明新类型和修饰符，或创建现有类型的子类型

{
  "contributes": {
    "semanticTokenTypes": [
      {
        "id": "templateType",
        "superType": "type",
        "description": "A template type."
      }
    ],
    "semanticTokenModifiers": [
      {
        "id": "native",
        "description": "Annotates a symbol that is implemented natively"
      }
    ]
  }
}

在上面的示例中，扩展声明了一个新类型 templateType 和一个新的修饰符 native。通过将 type 命名为超类型，type 的主题样式规则也将应用于 templateType

{
  "name": "Red Theme",
  "semanticTokenColors": {
    "type": "#ff0011"
  }
}

上面显示的 semanticTokenColors 值 "#ff0011" 适用于 type 及其所有子类型，包括 templateType。

除了自定义令牌类型之外，扩展还可以定义这些类型如何映射到 TextMate 作用域。这在自定义映射部分中描述。请注意，自定义映射规则不会自动从超类型继承。相反，子类型需要重新定义映射，最好是更具体的作用域。

启用语义高亮

是否计算和高亮语义令牌由设置 editor.semanticHighlighting.enabled 决定。它可以具有值 true、false 和 configuredByTheme。

• true 和 false 为所有主题打开或关闭语义高亮。
• configuredByTheme 是默认值，并让每个主题控制是否启用语义高亮。VS Code 附带的所有主题（例如，“Dark+”默认主题）默认都启用了语义高亮。

依赖于语义令牌的语言扩展可以在其 package.json 中覆盖其语言的默认值

{
  "configurationDefaults": {
    "[languageId]": {
      "editor.semanticHighlighting.enabled": true
    }
  }
}

主题

主题化是关于为令牌分配颜色和样式。主题化规则在颜色主题文件（JSON 格式）中指定。用户还可以在用户设置中自定义主题化规则。

颜色主题中的语义着色

为了支持基于语义令牌的高亮，已向颜色主题文件格式添加了两个新属性。

属性 semanticHighlighting 定义主题是否已准备好使用语义令牌进行高亮。默认情况下为 false，但我们鼓励所有主题都启用它。当设置 editor.semanticHighlighting.enabled 设置为 configuredByTheme 时，将使用此属性。

属性 semanticTokenColors 允许主题定义新的着色规则，这些规则与语义令牌提供程序发出的语义令牌类型和修饰符匹配。

{
  "name": "Red Theme",
  "tokenColors": [
    {
      "scope": "comment",
      "settings": {
        "foreground": "#dd0000",
        "fontStyle": "italic"
      }
    }
  ],
  "semanticHighlighting": true,
  "semanticTokenColors": {
    "variable.readonly:java": "#ff0011"
  }
}

variable.readonly:java 称为选择器，其形式为 (*|tokenType)(.tokenModifier)*(:tokenLanguage)?。

该值描述了规则匹配时的样式。它可以是一个字符串（表示前景色），也可以是一个对象，形式为 { foreground: string, bold: boolean, italic: boolean, underline: boolean } 或 { foreground: string, fontStyle: string }，这与 tokenColors 中的 TextMate 主题规则所用形式相同。

前景色需要遵循颜色格式中描述的颜色格式。不支持透明度。

以下是选择器和样式的其他示例

• "*.declaration": { "bold": true } // 所有声明都为粗体
• "class:java": { "foreground": "#0f0", "italic": true } // java 中的类

如果没有任何规则匹配，或者主题没有 semanticTokenColors 部分（但启用了 semanticHighlighting），则 VS Code 使用语义令牌作用域映射来评估给定语义令牌的 TextMate 作用域。该作用域与主题的 tokenColors 中的 TextMate 主题规则匹配。

语义令牌作用域映射

为了使语义高亮适用于尚未定义任何特定语义规则的主题，并作为自定义令牌类型和修饰符的后备，VS Code 维护从语义令牌选择器到 TextMate 作用域的映射。

如果主题启用了语义高亮，但不包含给定语义令牌的规则，则会使用这些 TextMate 作用域来查找 TextMate 主题规则。

预定义的 TextMate 作用域映射

下表列出了当前预定义的映射。

自定义 TextMate 作用域映射

此映射可以通过扩展在其 package.json 中的 semanticTokenScopes 贡献点进行扩展。

扩展执行此操作有两个用例

• 定义自定义令牌类型和令牌修饰符的扩展在主题未为添加的语义令牌类型或修饰符定义主题规则时，提供 TextMate 作用域作为后备

  {
    "contributes": {
      "semanticTokenScopes": [
        {
          "scopes": {
            "templateType": ["entity.name.type.template"]
          }
        }
      ]
    }
  }
  

• TextMate 语法的提供程序可以描述特定于语言的作用域。这有助于包含特定于语言的主题规则的主题。

  {
    "contributes": {
      "semanticTokenScopes": [
        {
          "language": "typescript",
          "scopes": {
            "property.readonly": ["variable.other.constant.property.ts"]
          }
        }
      ]
    }
  }
  

尝试一下

我们有一个 语义令牌示例，说明如何创建语义令牌提供程序。

作用域检查器工具允许您探索源代码文件中存在的语义令牌以及它们匹配的主题规则。要查看语义令牌，请在 TypeScript 文件上使用内置主题（例如，Dark+）。