關(guān)于fileheader：
顧名思義就是標(biāo)注在文件最前面的備注信息（創(chuàng)建者籽御，文件名字，修改者）鸯隅，詳情請(qǐng)?jiān)L問該插件的官方marketplace地址（ vscode-fileheader - Visual Studio Marketplace）巨朦，如果看了介紹之后你就會(huì)發(fā)現(xiàn)這是為js定制的，就算把默認(rèn)格式改了赶撰，每一次保存的時(shí)候都不會(huì)觸發(fā)header的修改舌镶。這是因?yàn)榇a里面寫死了只能識(shí)別以/*開頭，*/結(jié)尾的格式豪娜，很顯然這是不能符合lua的開發(fā)需求的餐胀。
可修改分析：
1.修改默認(rèn)格式
我們先來看一下它的默認(rèn)格式表現(xiàn)
/*
* @Author: mikey.zhaopeng
* @Date:? 2016-07-29 15:57:29
* @Last Modified by: mikey.zhaopeng
* @Last Modified time: 2016-08-09 13:29:41
*/
下面這個(gè)就是在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!!!!!"
},
找到了默認(rèn)格式的配置地方，就可以直接在這里修改成自己想要輸出的格式了瘤载，因?yàn)槲沂莑ua環(huán)境否灾，所以就配置成lua的格式
"default": "--[[--ldoc desc\\n@Module {module}\\n@Author {author}\\n\\nDate: {createTime}\\nLast Modified by: {lastModifiedBy}\\nLast Modified time: {updateTime}\\n]]",
extension.js里面也要做相應(yīng)的改動(dòng)，關(guān)鍵代碼如下：
if (line.startsWith("--[[") && !line.endsWith("]]")) {//是否以 /* 開頭
? ? ? ? ? ? ? ? ? ? ? ? comment = true;//表示開始進(jìn)入注釋
? ? ? ? ? ? ? ? ? ? } else if (comment) {
? ? ? ? ? ? ? ? ? ? ? ? if (line.endsWith("]]")) {
? ? ? ? ? ? ? ? ? ? ? ? ? ? comment = false;//結(jié)束注釋
? ? ? ? ? ? ? ? ? ? ? ? }
這樣的話就可以以正確的lua注釋方式來顯示了惕虑。
這里如果需要顯示自己的用戶名的話是需要在設(shè)置里面配置author和lastModifiedBy坟冲。
2.自動(dòng)化用戶名磨镶，無需再手動(dòng)配置
因?yàn)橹皩戇^python的原因，知道python是有類庫直接獲取本機(jī)的相關(guān)信息的健提，包括用戶名琳猫。所以就會(huì)去想js里面是否也有這樣子的接口，通過查詢得知node.js的內(nèi)置os庫是可以做到的私痹。所以需要安裝node.js脐嫂。
關(guān)鍵代碼如下：
const userInfo = require('os').userInfo()
author: userInfo.username,
lastModifiedBy: userInfo.username,
3.加上模塊名字
通過查詢vscode的官方API文檔得知可以通過TextDocument對(duì)象獲得編輯文件的路徑，關(guān)鍵代碼如下：
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獲取到的是完整的路徑紊遵，需要通過正則表達(dá)式做篩選账千，不可以使用fsPath或者document.fileName來獲取，因?yàn)檫@兩者獲取到的路徑是windows的路徑格式暗膜，帶有反斜杠\匀奏，而一個(gè)反斜杠\在js里面解析的時(shí)候會(huì)被直接當(dāng)做轉(zhuǎn)義字符，沒有辦法解析出來的学搜。
4.修改觸發(fā)更新header的時(shí)間間隔
在extension.js代碼里可以看到有個(gè)20秒的修改間隔娃善，也就是說20秒以內(nèi)的修改保存都不會(huì)去更新上一次編輯信息的，這里如果需要做到每一次都更新的話直接把這個(gè)diff改成>1或者去掉就可以了瑞佩。
未來可能會(huì)繼續(xù)優(yōu)化的功能點(diǎn)：
通過配置識(shí)別不同類型的文件使用不同的header格式
為函數(shù)動(dòng)態(tài)添加注釋頭
解決不需要安裝node.js的問題
