typescript在node.js下使用別名(paths)無效的問題詳解
背景
純nodejs環(huán)境,直接使用tsc編譯nodejs。源碼目錄是src,編譯輸出目錄為bin。代碼結(jié)構(gòu)如下:
- src
- utils
- a.ts
- b.ts
- config
- …
- utils
- bin
- tsconfig.json
在其他深層次目錄引用utils或者config下的文件時,總是要寫一長串的'../../../../',還需要數(shù)數(shù)。這顯然是不能接受的。用過webpack開發(fā)的小伙伴們,想想別名功能,typescript這種成熟框架不可能沒有。于是百度一波,得到如下配置:
{
"baseUrl": "./",
"paths": {
"@utils/*": [
"src/utils/*"
],
"@config/*": [
"src/config/*"
],
}
}
配置完之后,使用如下方式引用a.ts模塊:
import A from '@utils/a';
發(fā)現(xiàn)我的vscode編輯器已經(jīng)能識別這個路徑了,當(dāng)我按下ctrl點(diǎn)擊路徑的時候,也自動跳轉(zhuǎn)到了a.ts文件。在贊嘆自己純熟的技術(shù)之余,把所有的深層次路徑都換成了如上寫法,自信回頭運(yùn)行npm run start:

一臉懵逼。查看bin目錄編譯后的js文件,發(fā)現(xiàn)typescript根本沒有按照我的配置,在編譯過程中把這個路徑給優(yōu)化掉。還是require('@utils/a'):

typescript不會對別名進(jìn)行處理
在搗鼓了很久確定我的tsconfig配置沒有問題后,我無奈又進(jìn)行了百度,發(fā)現(xiàn)typescript根本不會對別名進(jìn)行處理,只能借助第三方編譯工具,例如babel,webpack。

但是我一個簡單的nodejs項(xiàng)目,一種編譯器足矣,我為什么需要再去使用上述編譯器?于是另一個解決方案(chao ji da ken)誕生了:
https://github.com/dividab/tsconfig-paths
另一個坑
對,就是tsconfig-paths,這個工具,我進(jìn)入其github首頁,發(fā)現(xiàn)有1k左右的星星??戳艘幌虏寮榻B,發(fā)現(xiàn)正是為了解決這個問題。使用說明也很簡單,引用官方文檔,就一句話:

哇,只要通過-r指令添加一個預(yù)處理,再運(yùn)行編譯后的模塊就可以解決我的問題?興沖沖的我立即npm i --save 操作一波, 發(fā)現(xiàn)還是出現(xiàn)如下問題:

這次確定是是走了他的預(yù)處理了。為什么還是不生效???翻看其文檔,也找不到任何有用的信息。到這里,大多數(shù)小伙伴估計(jì)都放棄了,但是今晚耗上了,一個別名問題居然拖了我這么長時間,于是我開始了源碼調(diào)試,找一下到底是什么原因。
調(diào)試tsconfig-paths
配置vscode調(diào)試器,添加運(yùn)行參數(shù):
{
"type": "pwa-node",
"request": "launch",
"name": "Launch Program",
"skipFiles": [
"<node_internals>/**"
],
"runtimeArgs": [
"-r",
"${workspaceFolder}/node_modules/tsconfig-paths/register"
],
"program": "${workspaceFolder}\\bin\\index.js"
}
調(diào)試源碼,發(fā)現(xiàn)其核心功能就是讀取tsconfig文件,獲取paths(別名)映射,覆寫path._resolveFilename,匹配映射,解析獲取真正的模塊。嗯,倒是不復(fù)雜

我在這里加了個條件斷點(diǎn),找到了我的utils/common的模塊請求,發(fā)現(xiàn)found為空…問題就出在這里了。于是進(jìn)一步查找。發(fā)現(xiàn)其匹配規(guī)則沒問題,只是匹配到之后,尋找模塊時使用的路徑居然是原始tsconfig中配置的src…

我的運(yùn)行目錄明明在bin目錄!
這也太不智能了,你好歹讀一下tsconfig里的outDir屬性吧!

現(xiàn)在沒辦法了,為了適配他的代碼,只能修改tsconfig的paths配置如下:
{
"baseUrl": "./",
"paths": {
"@utils/*": [
"src/utils/*",
"bin/utils/*"
],
"@config/*": [
"src/config/*",
"bin/config/*"
],
}
}
這樣他拼接的時候就能找到我的模塊了,問題終于解決!
總結(jié)
到此這篇關(guān)于typescript在node.js下使用別名(paths)無效問題詳解的文章就介紹到這了,更多相關(guān)typescript在node.js使用別名無效內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
- 在Node.js中使用TypeScript的方法示例
- 使用nodejs?+?koa?+?typescript?集成和自動重啟的問題
- nodemon實(shí)現(xiàn)Typescript項(xiàng)目熱更新的示例代碼
- 淺談TypeScript 用 Webpack/ts-node 運(yùn)行的配置記錄
- 手把手教你使用TypeScript開發(fā)Node.js應(yīng)用
- TypeScript開發(fā)Node.js程序的方法
- 詳解使用Typescript開發(fā)node.js項(xiàng)目(簡單的環(huán)境配置)
- Node.js和Express中設(shè)置TypeScript的實(shí)現(xiàn)步驟
相關(guān)文章
微信jssdk踩坑之簽名錯誤invalid signature
這篇文章主要介紹了微信jssdk踩坑之簽名錯誤invalid signature,文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2020-05-05
js實(shí)現(xiàn)股票實(shí)時刷新數(shù)據(jù)案例
下面小編就為大家?guī)硪黄猨s實(shí)現(xiàn)股票實(shí)時刷新數(shù)據(jù)案例。小編覺得挺不錯的,現(xiàn)在就分享給大家,也給大家做個參考。一起跟隨小編過來看看吧2017-05-05
前端用echarts繪制含有多個分層的波形圖關(guān)鍵代碼
每次實(shí)現(xiàn)各種圖表時,總會用到echarts,不得不說確實(shí)是一個非常好用的開源庫,這篇文章主要給大家介紹了關(guān)于前端用echarts繪制含有多個分層的波形圖的相關(guān)資料,需要的朋友可以參考下2024-03-03
微信小程序?qū)崿F(xiàn)點(diǎn)擊導(dǎo)航標(biāo)簽滾動定位到對應(yīng)位置
這篇文章主要為大家詳細(xì)介紹了微信小程序?qū)崿F(xiàn)點(diǎn)擊導(dǎo)航標(biāo)簽滾動定位到對應(yīng)位置,文中示例代碼介紹的非常詳細(xì),具有一定的參考價值,感興趣的小伙伴們可以參考一下2020-11-11
JS正則匹配URL網(wǎng)址的方法(可匹配www,http開頭的一切網(wǎng)址)
這篇文章主要介紹了JS正則匹配URL網(wǎng)址的方法,可實(shí)現(xiàn)匹配www,http開頭的一切網(wǎng)址的功能,涉及JS正則匹配字符串、數(shù)字及特殊字符構(gòu)建URL的操作技巧,需要的朋友可以參考下2017-01-01
全面解讀TypeScript和JavaScript的區(qū)別
TypeScript和JavaScript是目前項(xiàng)目開發(fā)中較為流行的兩種腳本語言, TypeScript是JavaScript的一個超集,JavaScript是一種輕量級的解釋性腳本語言,本文主要介紹了兩者區(qū)別,感興趣的可以了解一下2023-09-09

