通過點擊dom元素自動定位vscode中代碼位置

簡介:

通過點擊頁面的dom元素,來自動定位到源代碼位置。這樣可以快速讓一個剛接觸的項目熟悉代碼。在開發(fā)環(huán)境中也不會影響生產(chǎn)環(huán)境昭娩,具有輕量級影響小的特點泥兰。

效果預覽

預覽圖.gif

垃圾簡書,動圖動不了题禀!

設計分析:

簡單來說客戶端就是我們的瀏覽器要監(jiān)聽點擊事件鞋诗,并向服務端發(fā)送請求打開vscode 源碼位置。服務端來接受瀏覽器發(fā)送的請求來打開對應的位置迈嘹。

1. 客戶端:

首先我們要獲取元素在代碼中的位置削彬,我們知道在webpack編譯的過程中可以使用loader來獲取源碼。我們只需要編寫一個匹配.vue組件的loader就可以獲取templeate的元素

//loader.js
module.exports = function myloader(content,map,meta){
  
  let  conetlist = content.split('\n');
  let res = []
  const { resourcePath } = this 
  conetlist.forEach((item,index) => {
    res.push(addLineAttr(item, index + 1, resourcePath))
  });

  return res.join('\n')
}

在webpack最新版本中可以直接在this中獲取相對應的文件位置秀仲。通過換行符切割融痛,索引位置可獲取對應的代碼行數(shù)。這樣我們就可以把每一行的元素對應的位置獲取到神僵。最后通過拼接給每個dom元素添加一個自定義的屬性來標識位置雁刷,如圖下所示。


image.png
function addLineAttr(line,index,resourcePath){

  let path = process.cwd()
  console.log('cwd',path,'__dirname',__dirname);
  resourcePath = resourcePath.substring(path.length)

  let reg = /<[\w-]+/g
  let leftTagList = line.match(reg)
  if (leftTagList) {
    leftTagList = Array.from(new Set(leftTagList))
    leftTagList.forEach(item => {
      if (item && item.indexOf('template') == -1) {
        let regx = new RegExp(`${item}`, 'g')
        let location = `${item} code-location="${resourcePath}:${index}"`
        line = line.replace(regx, location)
      }
    })
  }
  return line
}

最后在全局綁定一個事件來監(jiān)聽保礼,比如快捷鍵+點擊事件沛励。以免與原生click事件沖突,并向服務端發(fā)送請求

window.document.addEventListener('click',e=>{
  let path = e.target.getAttribute('code-location'); //獲取路徑
  fetch(`${localhost}:${port}/${api}?path=${path}`,{
    method: 'get'
  })
})

2.服務端:

服務端就比較簡單了,我們需要在項目中設置一個監(jiān)聽get請求的接口來處理炮障。我們知道在webpack的項目中會啟動一個webpack-dev-server的服務目派,我們可以在這個服務上添加一個我們需要的。這里我們可以直接掛載在它before的hooks上胁赢,

devServer:{
      onBeforeSetupMiddleware:(devserver)=>{
        if (!devserver) {
          throw new Error('webpack-dev-server is not defined');
        }
  
        devserver.app.get('/api/path', function (req, res) {
          res.json({ custom: 'response' });
          let data = req.query.path
          openedit(data)
        });
      }
    },

但是這個在最新版本中已經(jīng)找不到了企蹭。通過查看官網(wǎng)文檔發(fā)現(xiàn)現(xiàn)在用的是onBeforeSetupMiddleware

3.通過命令打開文件

在vscode中我們可以通過命令來進行一些相關的操作,比如code -g可以打開文檔相對應的路徑智末,具體命令可以查看網(wǎng)上資料.

const child_process = require('child_process')

module.exports = function (path) {
  const res = process.cwd()+path
  child_process.exec(`code -r -g ${res}`)
}

4.引入

至此所有的邏輯就完了谅摄,其實很簡單,主要的就是在loader中根據(jù)規(guī)則給dom元素添加上對應位置的屬性系馆,然后通過code命令來打開文件位置
我們只需要在vue.config.js中配置我們寫好的loader就可以送漠。

module:{
      rules:[
        {
          test:/\.vue$/,
          use:[
           { 
            loader:path.join(__dirname,'@open-vs-link/myloader.js'),
            options:{            }
            }
          ],
        }
      ]
    }

最后補充,vite項目也是同樣的道理它呀,只是區(qū)分不同的掛載時期和引入方式螺男。react項目也是同理棒厘。最后有時間可以封裝好給團隊的小伙伴使用o.O

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯(lián)系作者
  • 序言:七十年代末纵穿,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子奢人,更是在濱河造成了極大的恐慌谓媒,老刑警劉巖,帶你破解...
    沈念sama閱讀 217,542評論 6 504
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件何乎,死亡現(xiàn)場離奇詭異句惯,居然都是意外死亡土辩,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,822評論 3 394
  • 文/潘曉璐 我一進店門抢野,熙熙樓的掌柜王于貴愁眉苦臉地迎上來拷淘,“玉大人,你說我怎么就攤上這事指孤∑粞模” “怎么了?”我有些...
    開封第一講書人閱讀 163,912評論 0 354
  • 文/不壞的土叔 我叫張陵恃轩,是天一觀的道長结洼。 經(jīng)常有香客問我,道長叉跛,這世上最難降的妖魔是什么松忍? 我笑而不...
    開封第一講書人閱讀 58,449評論 1 293
  • 正文 為了忘掉前任,我火速辦了婚禮筷厘,結果婚禮上鸣峭,老公的妹妹穿的比我還像新娘。我一直安慰自己酥艳,他們只是感情好叽掘,可當我...
    茶點故事閱讀 67,500評論 6 392
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著玖雁,像睡著了一般俯在。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上妨退,一...
    開封第一講書人閱讀 51,370評論 1 302
  • 那天目木,我揣著相機與錄音,去河邊找鬼劲厌。 笑死膛薛,一個胖子當著我的面吹牛,可吹牛的內容都是我干的补鼻。 我是一名探鬼主播哄啄,決...
    沈念sama閱讀 40,193評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼风范!你這毒婦竟也來了咨跌?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 39,074評論 0 276
  • 序言:老撾萬榮一對情侶失蹤硼婿,失蹤者是張志新(化名)和其女友劉穎锌半,沒想到半個月后,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體寇漫,經(jīng)...
    沈念sama閱讀 45,505評論 1 314
  • 正文 獨居荒郊野嶺守林人離奇死亡刊殉,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 37,722評論 3 335
  • 正文 我和宋清朗相戀三年殉摔,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片记焊。...
    茶點故事閱讀 39,841評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡逸月,死狀恐怖,靈堂內的尸體忽然破棺而出遍膜,到底是詐尸還是另有隱情彻采,我是刑警寧澤,帶...
    沈念sama閱讀 35,569評論 5 345
  • 正文 年R本政府宣布捌归,位于F島的核電站肛响,受9級特大地震影響,放射性物質發(fā)生泄漏惜索。R本人自食惡果不足惜特笋,卻給世界環(huán)境...
    茶點故事閱讀 41,168評論 3 328
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望巾兆。 院中可真熱鬧猎物,春花似錦、人聲如沸角塑。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,783評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽圃伶。三九已至堤如,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間窒朋,已是汗流浹背搀罢。 一陣腳步聲響...
    開封第一講書人閱讀 32,918評論 1 269
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留侥猩,地道東北人榔至。 一個月前我還...
    沈念sama閱讀 47,962評論 2 370
  • 正文 我出身青樓,卻偏偏與公主長得像欺劳,于是被迫代替她去往敵國和親唧取。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 44,781評論 2 354

推薦閱讀更多精彩內容