VSCode插件开发全攻略之跳转到定义、自动补全、悬停提示功能

VSCode插件开发全攻略之跳转到定义、自动补全、悬停提示功能插件开发全攻略之跳转到定义、自动补全、悬停提示功能

主要介绍了VSCode插件开发全攻略之跳转到定义、自动补全、悬停提示,需要的朋友可以参考下

跳转到定义跳转到定义

跳转到定义其实很简单，通过vscode.languages.registerDefinitionProvider注册一个provider，这个provider如果返回了new vscode.Location()就表示当前光标所在单词支

持跳转，并且跳转到对应location。

为了示例更加有意义，我在这里写了一个支持package.json中dependencies、devDependencies跳转到对应依赖包的例子jump-to-definition.js（当然我们这里只是很

简单的实现，没有考虑特殊情况，直接从node_modules文件夹下面去找）：

代码如下：

const util = require('./util');

/**

* 查找文件定义的provider，匹配到了就return一个location，否则不做处理

* 最终效果是，当按住Ctrl键时，如果return了一个location，字符串就会变成一个可以点击的链接，否则无任何效果

* @param {*} document

* @param {*} position

* @param {*} token

*/

function provideDefinition(document, position, token) {

const fileName = document.fileName;

console.log('workDir: ' + workDir); // 当前文件所在目录

console.log('word: ' + word); // 当前光标所在单词

console.log('line: ' + line.text); // 当前光标所在行

console.log('projectPath: ' + projectPath); // 当前工程目录

// 只处理package.json文件

if (/\/package\.json$/.test(fileName)) {

console.log(word, line.text);

const json = document.getText();

if (new RegExp(`"(dependencies|devDependencies)":\s*?\{[\s\S]*?${word.replace(/\//g, '\/')}[\s\S]*?\\}`, 'gm').test(json)) {

let destPath = `${workDir}/node_modules/${word.replace(/"/g, '')}/package.json`;

}

module.exports = function(context) {

// 注册如何实现跳转到定义，第一个参数表示仅对json文件生效

context.subscriptions.push(vscode.languages.registerDefinitionProvider(['json'], {

provideDefinition

}));

};

注意不要忘了修改activationEvents：

"activationEvents": [

"onLanguage:json"