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的問題

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。