如何为自定义语言扩展适配VSCode Sticky Scroll功能？

要让自定义语言扩展适配VSCode的Sticky Scroll功能，核心是实现文档符号解析相关的接口，具体如下：

• 必须实现DocumentSymbolProvider接口
  Sticky Scroll完全依赖这个接口返回的文档符号层级结构（比如类、函数、代码块的嵌套关系）生成滚动时固定的标题。你需要在实现中：

  • 解析当前文档，生成包含name（固定时显示的标题文本）、range（符号覆盖的代码范围）、selectionRange（符号定义所在行，通常是标题行）、children（子符号，体现嵌套层级）的DocumentSymbol数组。
  • 保证符号的嵌套关系准确，比如类包含方法、方法包含内部代码块，这样Sticky Scroll才能正确展示多级固定标题。
    示例实现（TypeScript）：

  import { DocumentSymbolProvider, TextDocument, DocumentSymbol, CancellationToken } from 'vscode';
  
  export class CustomLangSymbolProvider implements DocumentSymbolProvider {
      provideDocumentSymbols(document: TextDocument, token: CancellationToken): DocumentSymbol[] {
          // 编写你的文档符号解析逻辑
          // 返回结构化的符号数组，确保层级和范围准确
          return [];
      }
  }
  

• 推荐实现FoldingRangeProvider接口
  虽非强制要求，但这个接口返回的折叠范围能辅助Sticky Scroll更精准识别代码块边界，尤其当文档符号无法覆盖所有需要固定的区块时，可提升功能兼容性。
  示例实现：

  import { FoldingRangeProvider, TextDocument, FoldingRange, CancellationToken } from 'vscode';
  
  export class CustomLangFoldingProvider implements FoldingRangeProvider {
      provideFoldingRanges(document: TextDocument, token: CancellationToken): FoldingRange[] {
          // 编写你的折叠范围解析逻辑
          return [];
      }
  }
  

• 注册提供者到扩展
  在扩展的激活函数中，将上述提供者绑定到你的自定义语言：

  import { languages, ExtensionContext } from 'vscode';
  import { CustomLangSymbolProvider, CustomLangFoldingProvider } from './providers';
  
  export function activate(context: ExtensionContext) {
      context.subscriptions.push(
          languages.registerDocumentSymbolProvider('your-custom-lang-id', new CustomLangSymbolProvider()),
          languages.registerFoldingRangeProvider('your-custom-lang-id', new CustomLangFoldingProvider())
      );
  }
  

注意事项 #

• 确保selectionRange指向符号定义行（比如类名、函数名所在行），这样固定的标题文本才会正确显示。
• 符号层级要清晰，避免嵌套混乱，否则Sticky Scroll的多级固定逻辑会出错。
• 测试时可打开VSCode「开发人员工具」查看日志，排查符号解析失败等问题。

内容的提问来源于stack exchange，提问作者MaddawgX9