VSCode怎么实现一个代码诊断插件

这篇文章主要讲解了“vscode怎么实现一个代码诊断插件”，文中的讲解内容简单清晰，易于学习与理解，下面请大家跟着小编的思路慢慢深入，一起来研究和学习“VSCode怎么实现一个代码诊断插件”吧！

基本原理

Visual Studio Code 的编程语言功能扩展是有 Language Server 来实现的，这很好理解，毕竟检查语言功能是耗费性能的，需要另起一个进程来作为语言服务，这就是 Language Server 语言服务器。

Language Server 是一种特殊的 Visual Studio Code 扩展，可为许多编程语言提供编辑体验。使用语言服务器，您可以实现自动完成、错误检查（诊断）、跳转到定义以及VS Code 支持的许多其他语言功能。

既然有了服务器提供的语法检查功能，就需要客户端去连接语言服务器，然后和服务器进行交互，比如用户在客户端进行代码编辑时，进行语言检查。

当打开 Vue 文件时会激活插件，此时就会启动 Language Server，当文档发生变化时，语言服务器就会重新诊断代码，并把诊断结果发送给客户端。

代码诊断的效果是出现波浪线，鼠标移上显示提示消息，如果有快速修复，会在弹出提示的窗口下出现快速修复的按钮

动手实现

了解了代码诊断的基本原理之后，开始动手实现，从上面的基本原理可知，我们需要实现两大部分的功能：

• 客户端与语言服务器交互

• 语言服务器的诊断和快速修复功能

客户端与语言服务器交互

官方文档 提供了一个示例 - 用于纯文本文件的简单语言服务器，我们可以在这个示例的基础上去修改。

> git clone https://GitHub.com/microsoft/vscode-extension-samples.git> cd vscode-extension-samples/lsp-sample> npm install> npm run compile> code .

首先在 client 建立服务器

// client/src/extension.tsexport function activate(context: ExtensionContext) {    ...    const clientOptions: LanguageClientOptions = {        documentSelector: [{ scheme: 'file', language: 'vue' }], // 打开 vue 文件时才激活        ...    };    client = new LanguageClient(...);    client.start();}

接着在 server/src/server.ts 中，编写于客户端的交互逻辑，比如在客户端文档发生变化的时候，校验代码：

// server/src/server.tsimport {    createConnection    TextDocuments,    ProposedFeatures,    ...} from 'vscode-languageserver/node';const connection = createConnection(ProposedFeatures.all);const documents: TextDocuments<TextDocument> = new TextDocuments(TextDocument);documents.onDidChangeContent(change => {    // 文档发生变化时，校验文档    validateTextDocument(change.document);});async function validateTextDocument(textDocument: TextDocument): Promise<void> {    ...    // 拿到诊断结果    const diagnostics = getDiagnostics(textDocument, settings);    // 发给客户端    connection.sendDiagnostics({ uri: textDocument.uri, diagnostics });}// 提供快速修复的操作connection.onCodeAction(provideCodeActions);async function provideCodeActions(params: CodeActionParams): Promise<CodeAction[]> {    ...    return quickfix(textDocument, params);}

在完成上面客户端与服务端交互之后，可以注意到这两个方法 getDiagnostics(textDocument, settings) 和 quickfix(textDocument, params)。 这两个方法分别是为文档提供诊断数据和快速修复的操作。

代码诊断

1. 将代码文档转成 AST 语法树

在处理客户端传递过来的 Vue 代码文本的，需要通过 vue/compiler-dom 解析成三部分 ast 格式的数据结构，分别是 template、js、CSS， 由于现在前端代码使用的都是 typescript，JS 部分没有解析成 AST，因此需要使用 babel/parser 去解析 TypeScript 代码生成最终的 JS 的 AST 数据结构。

const VueParser = require('@vue/compiler-dom');// 该函数返回诊断结果客户端function getDiagnostics(textDocument: TextDocument, settings: any): Diagnostic[] {const text = textDocument.getText();const res = VueParser.parse(text);const [template, script] = res.children;return [...analyzeTemplate(template), // 解析 template 得到诊断结果...analyzeScript(script, textDocument), // 解析 js 得到诊断结果];}// 分析 js 语法function analyzeScript(script: any, textDocument: TextDocument) {  const scriptAst = parser.parse(script.children[0]?.content, {    sourceType: 'module',    plugins: [      'typescript', // typescript      ['decorators', { decoratorsBeforeExport: true }], // 装饰器      'classProperties', // es6 class 写法      'classPrivateProperties',    ],  });

2. 遍历语法树对代码校验

在得到代码的语法树之后，我们需要对每一个代码节点进行检查，来判断是否符合 Code Review 的要求，因此需要遍历语法树来对每个节点处理。

使用深度优先搜索对 template 的 AST 进行遍历：

function deepLoopData(  data: AstTemplateInterface[],  handler: Function,  diagnostics: Diagnostic[],) {  function dfs(data: AstTemplateInterface[]) {    for (let i = 0; i < data.length; i++) {      handler(data[i], diagnostics); // 在这一步对代码进行处理      if (data[i]?.children?.length) {        dfs(data[i].children);      } else {        continue;      }    }  }  dfs(data);}function analyzeTemplate(template: any) {  const diagnostics: Diagnostic[] = [];  deepLoopData(template.children, templateHandler, diagnostics);  return diagnostics;}function templateHandler(currData: AstTemplateInterface, diagnostics: Diagnostic[]){   // ...对代码节点检查}

而对于 JS AST 遍历，可以使用 babel/traverse 遍历：

 traverse(scriptAst, {    enter(path: any) {      ...    } }

3. 发现不合规代码，生成诊断

根据 ast 语法节点去判断语法是否合规，如果不符合要求，需要在代码处生成诊断，一个基础的诊断对象（diagnostics）包括下面几个属性：

• range:  诊断有问题的范围，也就是画波浪线的地方

• severity: 严重性，分别有四个等级，不同等级标记的颜色不同，分别是：

• Error： 1

• Warning： 2

• InfORMation：3

• Hint：4

• message: 诊断的提示信息

• source: 来源，比如说来源是 Eslint

• data：携带数据，可以将修复好的数据放在这里，用于后面的快速修复功能

比如实现一个提示函数过长的诊断：

function isLongFunction(node: Record<string, any>) {  return (    // 如果结束位置的行 - 开始位置的行 > 80 的话，我们认为这个函数写得太长了    node.type === 'ClaSSMethod' && node.loc.end.line - node.loc.start.line > 80  );}

在遍历 AST 时如果遇到某个节点是出现函数过长的时候，就往诊断数据中添加此诊断

traverse(scriptAst, {    enter(path: any) {        const { node } = path;        if (isLongFunction(node)) {            const diagnostic: Diagnostic ={                severity: DiagnosticSeverity.Warning,                range: getPositionRange(node, scriptStart),                message: '尽可能保持一个函数的单一职责原则，单个函数不宜超过 80 行',                source: 'Code Review 指南',            }            diagnostics.push(diagnostic);        }        ...       }});

文档中所有的诊断结果会保存在 diagnostics 数组中，最后通过交互返回给客户端。

4. 提供快速修复

上面那个函数过长的诊断没办法快速修复，如果能快速修复的话，可以将修正后的结果放在 diagnostics.data 。换个例子写一个快速修复, 比如 Vue template 属性排序不正确，我们需要把代码自动修复

// attributeOrderValidator 得到判断结果 和 修复后的代码const {isGoodSort, newText} = attributeOrderValidator(props, currData.loc.source);    if (!isGoodSort) {      const range = {        start: {          line: props[0].loc.start.line - 1,          character: props[0].loc.start.column - 1,        },        end: {          line: props[props.length - 1].loc.end.line - 1,          character: props[props.length - 1].loc.end.column - 1,        },      }      let diagnostic: Diagnostic = genDiagnostics(        'vue template 上的属性顺序',        range      );      if (newText) { // 如果有修复后的代码        // 将快速修复数据保存在 diagnostic.data        diagnostic.data = {          title: '按照 Code Review 指南的顺序修复',          newText,        }      }      diagnostics.push(diagnostic);    }

quickfix(textDocument, params)

export function quickfix(  textDocument: TextDocument,  params: CodeActionParams): CodeAction[] {  const diagnostics = params.context.diagnostics;  if (isNullOrUndefined(diagnostics) || diagnostics.length === 0) {    return [];  }  const codeActions: CodeAction[] = [];  diagnostics.forEach((diag) => {    if (diag.severity === DiagnosticSeverity.Warning) {      if (diag.data) { // 如果有快速修复数据        // 添加快速修复        codeActions.push({          title: (diag.data as any)?.title,          kind: CodeActionKind.QuickFix, // 快速修复          diagnostics: [diag], // 属于哪个诊断的操作          edit: {            changes: {                [params.textDocument.uri]: [                  {                    range: diag.range,                    newText: (diag.data as any)?.newText, // 修复后的内容                  },                ],              },           },        });    }   }});

有快速修复的诊断会保存在 codeActions 中，并且返回给客户端, 重新回看交互的代码，在 documents.onDidChangeContent 事件中，通过 connection.sendDiagnostics({ uri: textDocument.uri, diagnostics }) 把诊断发送给客户端。quickfix 结果通过 connection.onCodeAction 发给客户端。

import {    createConnection    TextDocuments,    ProposedFeatures,    ...} from 'vscode-languageserver/node';const connection = createConnection(ProposedFeatures.all);const documents: TextDocuments<TextDocument> = new TextDocuments(TextDocument);documents.onDidChangeContent(change => {    ...    // 拿到诊断结果    const diagnostics = getDiagnostics(textDocument, settings);    // 发给客户端    connection.sendDiagnostics({ uri: textDocument.uri, diagnostics });});// 提供快速修复的操作connection.onCodeAction(provideCodeActions);async function provideCodeActions(params: CodeActionParams): Promise<CodeAction[]> {    ...    return quickfix(textDocument, params);}

感谢各位的阅读，以上就是“VSCode怎么实现一个代码诊断插件”的内容了，经过本文的学习后，相信大家对VSCode怎么实现一个代码诊断插件这一问题有了更深刻的体会，具体使用情况还需要大家实践验证。这里是编程网，小编将为大家推送更多相关知识点的文章，欢迎关注！