vscode插件vscode-fileheader定制lua版本与优化

关于fileheader:

顾名思义就是标注在文件最前面的备注信息(创建者,文件名字,修改者),详情请访问该插件的官方marketplace地址( vscode-fileheader - Visual Studio Marketplace),如果看了介绍之后你就会发现这是为js定制的,就算把默认格式改了,每一次保存的时候都不会触发header的修改。这是因为代码里面写死了只能识别以/*开头,*/结尾的格式,很显然这是不能符合lua的开发需求的。

可修改分析:

1.修改默认格式

我们先来看一下它的默认格式表现

/*

* @Author: mikey.zhaopeng

* @Date:  2016-07-29 15:57:29

* @Last Modified by: mikey.zhaopeng

* @Last Modified time: 2016-08-09 13:29:41

*/

下面这个就是在package.json里面配置的

"fileheader.tpl": {

"type": "string",

"default": "/*\r\n * @Author: {author} \r\n * @Date: {createTime} \r\n * @Last Modified by:  {lastModifiedBy} \r\n * @Last Modified time: {updateTime} \r\n */\r\n",

"description": "By default, common template. Do not modify it!!!!!"

},

找到了默认格式的配置地方,就可以直接在这里修改成自己想要输出的格式了,因为我是lua环境,所以就配置成lua的格式

"default": "--[[--ldoc desc\\n@Module {module}\\n@Author {author}\\n\\nDate: {createTime}\\nLast Modified by: {lastModifiedBy}\\nLast Modified time: {updateTime}\\n]]",

extension.js里面也要做相应的改动,关键代码如下:

if (line.startsWith("--[[") && !line.endsWith("]]")) {//是否以 /* 开头

                        comment = true;//表示开始进入注释

                    } else if (comment) {

                        if (line.endsWith("]]")) {

                            comment = false;//结束注释

                        }

这样的话就可以以正确的lua注释方式来显示了。

这里如果需要显示自己的用户名的话是需要在设置里面配置authorlastModifiedBy。

2.自动化用户名,无需再手动配置

因为之前写过python的原因,知道python是有类库直接获取本机的相关信息的,包括用户名。所以就会去想js里面是否也有这样子的接口,通过查询得知node.js的内置os库是可以做到的。所以需要安装node.js。

关键代码如下:

const userInfo = require('os').userInfo()

author: userInfo.username,

lastModifiedBy: userInfo.username,

3.加上模块名字

通过查询vscode的官方API文档得知可以通过TextDocument对象获得编辑文件的路径,关键代码如下:

var disposable = vscode.commands.registerCommand('extension.fileheader', function () {

        var editor = vscode.editor || vscode.window.activeTextEditor;

        editor.edit(function (editBuilder) {

            var time = new Date().format("yyyy-MM-dd hh:mm:ss");

            var moduleName = editor.document.uri.path.match(RegExp(/\w*\.\w*/))

注意:这里的path获取到的是完整的路径,需要通过正则表达式做筛选,不可以使用fsPath或者document.fileName来获取,因为这两者获取到的路径是windows的路径格式,带有反斜杠\,而一个反斜杠\在js里面解析的时候会被直接当做转义字符,没有办法解析出来的。

4.修改触发更新header的时间间隔

在extension.js代码里可以看到有个20秒的修改间隔,也就是说20秒以内的修改保存都不会去更新上一次编辑信息的,这里如果需要做到每一次都更新的话直接把这个diff改成>1或者去掉就可以了。

未来可能会继续优化的功能点:

通过配置识别不同类型的文件使用不同的header格式

为函数动态添加注释头

解决不需要安装node.js的问题

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,793评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,567评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,342评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,825评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,814评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,680评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,033评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,687评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 42,175评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,668评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,775评论 1 332
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,419评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,020评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,978评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,206评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,092评论 2 351
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,510评论 2 343