关于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注释方式来显示了。
这里如果需要显示自己的用户名的话是需要在设置里面配置author和lastModifiedBy。
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的问题