vscode 自己实现补全提示插件

vscode 自己实现补全提示插件

月光魔力鸭

2020-11-04 02:58 阅读 772 喜欢 1 vs code 补全插件

最近做个nodejs的项目,使用了thinkjs 3.0 的框架,编辑器为vs code ,之前用的好好的,每次 . 后都有提示的,可是使用了多模块后发现.. model的提示没有了..

太惆怅了,用了一阵子后实在难受,想起了vs code 可以加插件,当然找了下也没有找到,于是准备做个简易的插件自用。

功能

实现一个vs code 的插件,用于thinkjs 多模块下的model的函数提示,类似以下。

文档

就大部分简易插件来说,看下官方文档+demo,基本就差不多了,如果还需要一些更加深入的实现,就需要详细看api了。

按照文档进行准备

需要安装一些脚手架或打包工具。

npm install -g yo generator-code

脚手架命令

yo code 
//然后生成后,直接 code ./demo ,按F5 调试。

打包工具

npm install vsce -g 

打包命令

vsce package
代码

文件总共有两个:package.json ,extension.js

package.json

{
    "name": "completions-sample",
    "displayName": "Completion Item Provider Sample",
    "version": "0.0.2",
    "publisher": "chrunlee",
    "engines": {
        "vscode": "^1.32.0"
    },
    "categories": [
        "Other"
    ],
    "activationEvents": [
        "*"
    ],
    "main": "extension.js"
}

extension.js

/**
 * 主要用于thinkjs开发的时候查找对应的函数
 * model的函数。
 */

const vscode = require('vscode');
const path = require('path');
const fs = require('fs');
const vm = require('vm');

module.exports.activate = function activate(context) {

    const provider2 = vscode.languages.registerCompletionItemProvider(
        'javascript',
        {
            provideCompletionItems(document, position) {

                // get all text until the `position` and check if it reads `console.`
                // and if so then complete if `log`, `warn`, and `error`
                const linePrefix = document.lineAt(position).text.substr(0, position.character);
                //当符合 this.model(.*). 的时候出发
                if(!/this\.model\([\s\S]*\)\.$/.test(linePrefix)){
                    return undefined;
                }

                //匹配出路径
                const fileName = document.fileName;
                //根据fileName 查找
                let rootPath = fileName.substr(0,fileName.indexOf('src'));
                if(!rootPath){
                    return undefined;
                }
                let srcPath = path.join(rootPath,'src');
                //扫描该路径下所有model文件夹,直到查找到目标位置。
                let rst = /model\((.*)\)/.exec(linePrefix)[1];
                let finalPath = '';
                if(rst.indexOf(',') >-1){//多级模块
                    let arr = rst.split(',');
                    let moduleName = arr[2].replace(/'/g,'').trim();
                    let modelName = arr[0].replace(/'/g,'').trim();
                    finalPath = path.join(srcPath,moduleName,'model',modelName+'.js');
                }else{
                    let modelName = rst.replace(/'/g,'').trim();
                    finalPath = path.join(srcPath,'model',modelName+'.js');
                }
                console.log(finalPath);
                //解析js文件 ,获取内部函数数据
                if(fs.existsSync(finalPath)){
                    let content = fs.readFileSync(finalPath).toString('utf8');
                    let list = content.split('\r\n');

                    return list.filter(t=>{
                        return t.indexOf('async') > -1;
                    }).map(function(t){
                        return t.replace('async','').replace('{','').trim();
                    }).map(t=>{
                        return vscode.CompletionItem(t,vscode.CompletionItemKind.Method);
                    })

                }else{
                    return undefined;
                }

            }
        },
        '.' // triggered whenever a '.' is being typed
    );

    context.subscriptions.push(provider2);
}

说明

本插件自用,所以做的校验很粗糙,基本上只符合自己的文档目录体系,其实本来想做的更加适配来着..实在太困,先自己用着再说。 至于获取函数.. 这个没有找到,应该是vm方面的知识,虽然经常用nodejs ,但是vm 实在没啥接触,也卡了壳了,直接用字符串去识别了。

打包后安装

在此处,选择打包后的vsix ,安装成功,然后试了试,感觉还是挺爽的 。。 O(∩_∩)O哈哈~

转载请注明出处: https://chrunlee.cn/article/vs-code-tip-model.html


感谢支持!

赞赏支持
提交评论
评论信息 (请文明评论)
暂无评论,快来快来写想法...
推荐
在我们web开发过程中经常会碰到针对table的一些dom操作,这里整理一下关于这方面的知识点。当然我们可以通过jquery这样的插件来处理,或许会更简单一些,不过现在简单说下原生JS是如何操作的
业务中有一段涉及到处理canvas的图片然后将内容进行上传,后测试发现在IE中不好使哎...
今天刷codewars的题目的时候碰到一个通过js来实现字符串转base64的题目,base64虽然在js或nodejs中经常用,但是我还真没有仔细去看过原理以及如何实现,这回绕不过去了,赶紧找了找资料看了下。
通过canvas可以进行画图实现一些动画效果等,今天练习下通过canvas来实现一个简易的电子画板,可以在白板上进行画画,然后指定不同的颜色、线条粗细,加载不同的背景以及擦除效果。
最近一直在想着抓一些网盘数据,进行资料归拢,可是当我真正开始的时候.. 还是遇到了反爬,当然我本身就有心理预期,这是肯定会碰到的,只是没想到会在代理IP上耗费这么久,之前的时候也处理过代理IP ,可是由于一知半解,导致很多配置都不理解,debug全靠猜...
web网站上总会有在文本域中提交代码的操作,那么如何处理呢?
需求如下:有一张大图,需要显示大图中的一小部分,目前能知道的时候小图的宽高和坐标,同时大图有一个旋转角度可以知道,目标就是把小图正确的显示出来。
在页面中不同的frame之间进行相互调用的话,我们可以通过frame获取对应的window然后进行调用,但是如果是浏览器不同的tab之间呢?