又一個基于 Esbuild 的神器！
Node.js 并不支持直接執行 TS 文件，如果要執行 TS 文件的話，我們就可以借助 ts-node 這個庫。相信有些小伙伴在工作中也用過這個庫，關于 ts-node 這個庫的相關內容我就不展開介紹了，因為本文的主角是由 antfu 大佬開源的 esno 項目，接下來我將帶大家一起來揭開這個項目背后的秘密。
閱讀完本文后，你將了解 esno 項目是如何執行 TS 文件。此外，你還會了解如何劫持 Node.js 的 require 函數、如何為 ES Module 的 import 語句添加鉤子及如何自定義 https 加載器，以支持 import React from "https://esm.sh/react" 導入方式。
esno 是什么
esno 是基于 esbuild 的 TS/ESNext node 運行時。該庫會針對不同的模塊化標準，采用不同的方案：
- esno - Node in CJS mode - by esbuild-register
- esmo - Node in ESM mode - by esbuild-node-loader
使用 esno 的方式很簡單，你可以以全局或局部的方式來安裝它：
全局安裝
$ npm i -g esno
在安裝成功后，你就可以通過以下方式來直接執行 TS 文件：
$ esno index.ts
$ esmo index.ts
局部安裝
$ npm i esno
而對于局部安裝的方式來說，一般情況下，我們會以 npm scripts 的方式來使用它：
{
"scripts": {
"start": "esno index.ts"
},
"dependencies": {
"esno": "0.14.0"
}
}
esno 是如何工作的
在開始分析 esno 的工作原理之前，我們先來熟悉一下該項目：
├── LICENSE
├── README.md
├── esmo.mjs
├── esno.js
├── package.json
├── pnpm-lock.yaml
├── publish.ts
└── tsconfig.json
觀察以上的項目結構可知，該項目并不會復雜。在項目根目錄下的 package.json 文件中，我們看到了前面介紹的 esno 和 esmo 命令。
{
"bin": {
"esno": "esno.js",
"esmo": "esmo.mjs"
},
}
此外，在 package.json 的 scripts 字段中，我們發現了 release 命令。顧名思義，該命令用來發布版本。
{
"scripts": {
"release": "npx bumpp --tag --commit --push && node esmo.mjs publish.ts"
},
}
需要注意的是，在 publish.ts 文件中，使用到了 2021 年度 Github 上最耀眼的項目 zx，利用該項目我們可以輕松地編寫命令行腳本。寫作本文時，它的 Star 數已經高達 27.5K，強烈推薦感興趣的小伙伴關注一下該項目。
簡單介紹了 esno 項目之后，接下來我們來分析 esno.js 文件：
#!/usr/bin/env node
const spawn = require('cross-spawn')
const spawnSync = spawn.sync
const register = require.resolve('esbuild-register')
const argv = process.argv.slice(2)
process.exit(spawnSync('node', ['-r', register, ...argv],
{ stdio: 'inherit' }).status)
由以上代碼可知，當執行 esno index.ts 命令后，會通過 spawnSync 來啟動 Node.js 程序執行腳本。需要注意的是，在執行時使用了 -r 選項，該選項的作用是預加載模塊：
-r, --require = ... module to preload (option can be repeated)
這里預加載的模塊是 esbuild-register，該模塊就是 esno 命令執行 TS 文件的幕后英雄。
esbuild-register 是什么
esbuild-register 是一個基于 esbuild 來轉換 JSX、TS 和 esnext 特性的工具。你可以通過以下多種方式來安裝它：
$ npm i esbuild esbuild-register -D
# Or Yarn
$ yarn add esbuild esbuild-register --dev
# Or pnpm
$ pnpm add esbuild esbuild-register -D
在成功安裝該模塊之后，就可以在命令行中，直接通過 node 應用程序來執行 ts 文件：
$ node -r esbuild-register file.ts
-r, --require = ... module to preload (option can be repeated)
-r 用于指定預加載的文件，即在執行 file.ts 文件前，提前加載 esbuild-register 模塊
它將會使用 tsconfig.json 中的 jsxFactory,jsxFragmentFactory 和 target 配置項來執行轉換操作。
esbuild-register 不僅可以在命令行中使用，而且還可以通過 API 的方式進行使用：
const { register } = require('esbuild-register/dist/node')
const { unregister } = register({
// ...options
})
// Unregister the require hook if you don't need it anymore
unregister()
了解完 esbuild-register 的基本使用之后，接下來我們來分析它內部是如何工作的。
esbuild-register 是如何工作的
esbuild-register 內部利用了 pirates 這個庫來劫持 Node.js 的 require 函數，從而讓你可以在命令行中，直接執行 ts 文件。下面我們來看一下 esbuild-register 模塊中定義的 register 函數：
// esbuild-register/src/node.ts
import { transformSync, TransformOptions } from 'esbuild'
import { addHook } from 'pirates'
export function register(esbuildOptions: RegisterOptions = {}) {
const {
extensions = DEFAULT_EXTENSIONS,
hookIgnoreNodeModules = true,
hookMatcher,
...overrides
} = esbuildOptions
// 利用 transformSync
const compile: COMPILE = function compile(code, filename, format) {
const dir = dirname(filename)
const options = getOptions(dir)
format = format ?? inferPackageFormat(dir, filename)
const {
code: js,
warnings,
map: jsSourceMap,
} = transformSync(code, {
sourcefile: filename,
sourcemap: 'both',
loader: getLoader(filename),
target: options.target,
jsxFactory: options.jsxFactory,
jsxFragment: options.jsxFragment,
format,
...overrides,
})
// 省略部分代碼
}
const revert = addHook(compile, {
exts: extensions,
ignoreNodeModules: hookIgnoreNodeModules,
matcher: hookMatcher,
})
return {
unregister() {
revert()
},
}
}
觀察以上的代碼可知，在 register 函數內部是利用 esbuild 模塊提供的 transformSync API 來實現 ts -> js 代碼的轉換。其實最關鍵的環節，還是通過調用 pirates 這個庫提供的 addHook 函數來注冊編譯 ts 文件的鉤子。那么 addHook 函數內部到底做了哪些處理呢?下面我們來看一下它的實現：
// pirates-4.0.5/src/index.js
export function addHook(hook, opts = {}) {
let reverted = false;
const loaders = []; // 存放新的loader
const oldLoaders = []; // 存放舊的loader
let exts;
const originalJSLoader = Module._extensions['.js']; // 原始的JS Loader
// 省略部分代碼
exts.forEach((ext) => {
// 獲取已注冊的loader，若未找到，則默認使用JS Loader
const oldLoader = Module._extensions[ext] || originalJSLoader;
oldLoaders[ext] = Module._extensions[ext];
loaders[ext] = Module._extensions[ext] = function newLoader(
mod, filename) {
let compile;
if (!reverted) {
if (shouldCompile(filename, exts, matcher, ignoreNodeModules)) {
compile = mod._compile;
mod._compile = function _compile(code) {
// 這里需要恢復成原來的_compile函數，否則會出現死循環
mod._compile = compile;
// 在編譯前先執行用戶自定義的hook函數
const newCode = hook(code, filename);
if (typeof newCode !== 'string') {
throw new Error(HOOK_RETURNED_NOTHING_ERROR_MESSAGE);
}
return mod._compile(newCode, filename);
};
}
}
oldLoader(mod, filename);
};
});
}
其實 addHook 函數的實現并不會復雜，該函數內部就是通過替換 mod._compile 方法來實現鉤子的功能。即在調用原始的 mod._compile 方法進行編譯前，會先調用 hook(code, filename)函數來執行用戶自定義的 hook 函數，從而對代碼進行預處理。
而對于 esbuild-register 庫中的 register 函數來說，當 hook 函數執行時，就會調用該函數內部定義的 compile 函數來編譯 ts 代碼，然后再調用mod._compile 方法編譯生成的 js 代碼。
關于 esbuild-register 和 pirates 這兩個庫的內容就先介紹到這里，如果你想詳細了解 pirates 這個庫是如何工作的，可以閱讀 如何為 Node.js 的 require 函數添加鉤子? 這篇文章。
現在我們已經分析完 esno.js 文件，接下來我們來分析 esmo.mjs 文件。
esmo 是如何工作的
esmo 命令對應的是 esmo.mjs 文件：
#!/usr/bin/env node
import spawn from 'cross-spawn'
import { resolve } from 'import-meta-resolve'
const spawnSync = spawn.sync
const argv = process.argv.slice(2)
resolve('esbuild-node-loader', import.meta.url).then((path) => {
process.exit(spawnSync('node', ['--loader', path, ...argv],
{ stdio: 'inherit' }).status)
})
由以上代碼可知，當使用 node 應用程序執行 ES Module 文件時，會通過 --loader 選項來指定自定義的 ES Module 加載器。
--loader, --experimental-loader = ... use the specified module as a custom loader
需要注意的是，通過 --loader 選項指定的自定義加載器只適用于 ES Module 的 import 調用，并不適用于 CommonJS 的 require 調用。
那么自定義加載器有什么作用呢?在當前最新的 Node.js v17.4.0 版本中，還不支持以 https://開頭的說明符。我們可以在自定義加載器中，利用 Node.js 提供的鉤子機制，讓 Node.js 可以使用import 導入以 https:// 協議開頭的 ES 模塊。
在分析如何自定義 https 資源加載器前，我們需要先介紹一下 import 說明符的概念。
import 說明符
import 語句的說明符是 from 關鍵字之后的字符串，例如 import { sep } from 'path' 中的 'path'。說明符也用于 export from 語句，并作為import() 表達式的參數。
