Node.js 的 TypeScript 导入加载器
这是一个使用微软官方 TypeScript 实现来运行用 TypeScript 编写的 Node.js 程序的导入器。
它旨在提供完整的类型检查支持,并在重复使用时(例如,在生成多个 TS 进程的测试套件中)具有可接受的性能。
市面上有很多 TypeScript 加载器和编译器!你应该选择哪一个,为什么我需要创建这个呢?
tsimp 的不同之处:
tsimp
的目标是与"官方" tsc
程序严格一致,而直接使用它是最简单的方法。--import
和 Module.register()
行为,只在不可用时才退回到带有警告的实验性 API。tsc --noEmit
步骤,使用持久的 sock daemon 和大量缓存来提高性能。使用 npm 安装 tsimp
:
npm install tsimp
在 node v20.6 及更高版本中这样运行 TypeScript 程 序:
node --import=tsimp/import my-typescript-program.ts
或在 v20.6 之前的 Node 版本中这样运行:
node --loader=tsimp/loader my-typescript-program.ts
你也可以使用 tsimp
作为可执行文件来运行你的程序(但 import/loader 方式快约 100ms,因为它不会产生额外的 spawn
调用):
tsimp my-typescript-program.ts
注意,虽然不带参数运行 tsimp
将启动 Node repl,并且在该上下文中它能够导入/require TypeScript 模块,但它并不包含可以直接运行 TypeScript 的 repl。这只是一个导入加载器。
在 Node v20.6 及更高版本中,你还可以在程序中加载 tsimp
,之后 TypeScript 模块就可以直接使用了。
注意,import
声明在代码执行之前并行发生,所以你需要像这样拆分:
import 'tsimp' // 必须作为异步 import() 完成,以便在 tsimp 导入完成后进行。 // 但 TypeScript 程序中的任何导入都可以是"正常"的顶级导入。 const { SomeThing } = await import('./some-thing.ts')
相比之下,这样是不行的,因为导入是并行发生的:
import 'tsimp'
import { SomeThing } from './some-thing.ts'
CommonJS 的 require()
也被修补了。要在 CommonJS 程序中使用 tsimp
,你可以按上述方式运行它,或在程序中 require()
它。
//commonjs require('tsimp') // 现在可以加载 TypeScript require('./blah.ts')
在 Node 20.6 及更高版本中,这也会附加 ESM 导入支持所需的加载器。在早期 Node 版本中,你必须使用 --loader=tsimp/loader
来支持 ESM。
大多数配置是通过查找模块入口点所在或其上级文件夹树中最近的 tsconfig.json
文件来完成的。
你可以通过在环境中设置 TSIMP_PROJECT=<filename>
来使用不同的文件名。
如果 tsconfig json 文件中有 tsimp
字段,那么它将覆盖文件中的其他任何内容。例如:
{ "compilerOptions": { "rootDir": "./src", "declaration": true, "esModuleInterop": true, "forceConsistentCasingInFileNames": true, "inlineSources": true, "jsx": "react", "module": "nodenext", "moduleResolution": "nodenext", "noUncheckedIndexedAccess": true, "resolveJsonModule": true, "skipLibCheck": false, "sourceMap": false, "strict": true, "target": "es2022" } "tsimp": { "compilerOptions": { "skipLibCheck": true, "strict": false } } }
使用 tsimp
时始终启用源映射,以便错误引用 TypeScript 代码中的适当调用位置。
extends
选项如果 tsimp 使用的 tsconfig.json
文件发生更改,它将自动使其内存和磁盘缓存过期,因为新选项可能会导致非常不同的结果。
然而,虽然完全支持 extends
(如果 tsc
可以加载它,tsimp 也可以,因为这就是它加载配置的方式),但任何扩展的配置文件都不会被跟踪变化或导致缓存过期。
如有疑问,tsimp --restart
将根据需要重新加载所有内容。
"module"
、"moduleResolution"
和其他必需项tsimp 的最终模块样式必须是 Node 可理解的,无需任何额外的打包或转译。
为此,无论 tsconfig.json
中的设置如何,module
和 moduleResolution
设置都在 tsimp 中硬编码为 NodeNext
。
此外,tsimp 总是硬编码以下字段:
outDir
因为 tsimp 不是构建工 具,而是模块导入器,它实际上不会将生成的 JavaScript 写入磁盘。(好吧,从技术上讲它确实写入了,但只是作为缓存。)所以,outDir
被硬编码为 .tsimp-compiled
,但这从未被使用。sourceMap
总是设置为 undefined
,因为:inlineSourceMap
总是设置为 true
。将源映射内联到生成的 JavaScript 输出中要简单和快速得多。inlineSources
总是设置为 false
。当输入肯定存在于磁盘上时,没有必要增加输出的大小。declarationMap
和 declaration
总是设置为 false
,因为类型声明是无关紧要的。noEmit
总是设置为 false
,因为整个目的是获取 Node 运行的 JavaScript 代码。话虽如此,"emit" 是完全虚拟的,不会向磁盘写入任何内容(除非为了避免多次编译相同的代码)。使用tsimp
时,文件扩展名、模块解析和其他方面的规则与使用tsc
时相同。
这意味着:如果你在ESM模式下运行,即使磁盘上的实际文件是.ts
,你也需要将导入语句的文件名以.js
结尾,因为当module
设置为"NodeNext"
且目标方言是ESM时,TypeScript就是这样处理的。
设置TSIMP_DIAG
环境变量来控制编译诊断出现时的行为。
TSIMP_DIAG=warn
(默认)将诊断信息打印到stderr
,但如果可能的话仍会转译代码。TSIMP_DIAG=error
将诊断信息打印到stderr
,如果有任何诊断信息就会失败。TSIMP_DIAG=ignore
仅转译代码,忽略所有诊断信息。(类似于ts-node的TS_NODE_TRANSPILE_ONLY=1
选项。)如果守护进程正在运行,即使启用了类型检查,它也非常快。如果守护进程正在运行,并且之前已经编译过你正在运行的文件,它会快得惊人,快到你会觉得它是不是坏了,甚至超过了用Rust和Go编写的TypeScript编译器,因为它实际上只需要检查一些文件状态,然后将缓存的结果传给Node。(事实上,由于它在内存和磁盘上都进行缓存,在许多情况下可能甚至比运行普通的JavaScript还要快,特别是如果程序很大的话。)
而且,这是在进行完整的类型检查的情况下,这也是使用TypeScript的意义所在。无论你的编译器有多快,如果你随后还要运行tsc --noEmit
来检查类型,那实际上并没有获得多少好处。
如果守护进程没有运行,而且是一次冷启动且没有缓存,那它会相当慢,特别是在启用类型检查的情况下,速度与ts-node相当。
下面是一个非常不科学的对比示例:
<pre style="color:#eeeeee;background:#222222;position:relative" title="tapjs/tsimp main - tapjs/tsimp"> $ time node --loader @swc-node/register/esm hello.ts (node:89220) ExperimentalWarning: `--experimental-loader`可能在未来被移除;请改用`register()`: --import 'data:text/javascript,import { register } from "node:module"; import { pathToFileURL } from "node:url"; register("%40swc-node/register/esm", pathToFileURL("./"));' (使用`node --trace-warnings ...`来显示警告的创建位置) hello, world real 0m0.268s user 0m0.255s sys 0m0.033s $ time node --import=tsx hello.ts hello, world real 0m0.135s user 0m0.126s sys 0m0.020s $ time node --import=./dist/esm/hooks/import.mjs hello.ts <span style="color:#00ffff">hello.ts</span>:<span style="color:#ffff00">2</span>:<span style="color:#ffff00">18</span> - <span style="color:#ff3030">错误</span><span style="color:#404040"> TS2322: </span>类型"string"不能赋给类型"boolean"。 <span style="color:#222222;background:#eeeeee">2</span> const f: Foo = { bar: 'hello' } <span style="color:#222222;background:#eeeeee"> </span> <span style="color:#ff3030"> ~~~ </span> <span style="color:#00ffff">hello.ts</span>:<span style="color:#ffff00">1</span>:<span style="color:#ffff00">14 </span> <span style="color:#222222;background:#eeeeee">1</span> type Foo = { bar: boolean } <span style="color:#222222;background:#eeeeee"> </span> <span style="color:#00ffff"> ~~~ </span> 预期的类型来自此处声明的"Foo"类型的"bar"属性 hello, world real 0m0.126s user 0m0.110s sys 0m0.022s </pre>基本的缓存和工作跳过。
AI小说写作助手,一站式润色、改写、扩写
蛙蛙写作—国内先进的AI写作平台,涵盖小说、学术、社交媒体等多场景。提供续写、 改写、润色等功能,助力创作者高效优化写作流程。界面简洁,功能全面,适合各类写作者提升内容品质和工作效率。
字节跳动发布的AI编程神器IDE
Trae是一种自适应的集成开发环境(IDE),通过自动化和多元协作改变开发流程。利用Trae,团队能够更快速、精确地编写和部署代码,从而提高编程效率和项目交付速度。Trae具备上下文感知和代码自动完成功能,是提升开发效率的理想工具。
全能AI智能助手,随时解答生活与工作的多样问题
问小白,由元石科技研发的AI智能助手,快速准确地解答各种生活和工作问题,包括但不限于搜索、规划和社交互动,帮助用户在日常生活中提高效率,轻松管理个人事务。
实时语音翻译/同声传译工具
Transly是一个多场景的AI大语言模型驱动的同声传译、专业翻译助手,它拥有超精准的音频识别翻译能力,几乎零延迟的使用体验和支持多国语言可以让你带它走遍全球,无论你是留学生、商务人士、韩剧美剧爱好者,还是出国游玩、多国会议、跨国追星等等,都可以满足你所有需要同传的场景需求,线上线下通用,扫除语言障碍,让全世界的语言交流不再有国界。
一键生成PPT和Word,让学习生活更轻松
讯飞智文是一个利用 AI 技术的项目,能够帮助用户生成 PPT 以及各类文档。无论是商业领域的市场分析报告、年度目标制定,还是学生群体的职业生涯规划、实习避坑 指南,亦或是活动策划、旅游攻略等内容,它都能提供支持,帮助用户精准表达,轻松呈现各种信息。
深度推理能力全新升级,全面对标OpenAI o1
科大讯飞的星火大模型,支持语言理解、知识问答和文本创作等多功能,适用于多种文件和业务场景,提升办公和日常生活的效率。讯飞星火是一个提供丰富智能服务的平台,涵盖科技资讯、图像创作、写作辅助、编程解答、科研文献解读等功能,能为不同需求的用户提供便捷高效的帮助,助力用户轻松获取信息、解决问题,满足多样化使用场景。
一种基于大语言模型的高效单流解耦语音令牌文本到语音合成模型
Spark-TTS 是一个基于 PyTorch 的开源文本到语音合成项目,由多个知名机构联合参与。该项目提供了高效的 LLM(大语言模型)驱动的语音合成方案,支持语音克隆和语音创建功能,可通过命令行界面(CLI)和 Web UI 两种方式使用。用户可以根据需求调整语音的性别、音高、速度等参数,生成高质量的语音。该项目适用于多种场景,如有声读物制作、智能语音助手开发等。
AI助力,做PPT更简单!
咔片是一款轻量化在线演示设计工具,借助 AI 技术,实现从内容生成到智能设计的一站式 PPT 制作服务。支持多种文档格式导入生成 PPT,提供海量模板、智能美化、素材替换等功能,适用于销售、教师、学生等各类人群,能高效制作出高品质 PPT,满足不同场景演示需求。
选题、配图、成文,一站式创作,让内容运营更高效
讯飞绘文,一个AI集成平台,支持写作、选题、配图、排版和发布。高效生成适用于各类媒体的定制内容,加速品牌传播,提升内容营销效果。
专业的AI公文写作平台,公文写作神器
AI 材料星,专业的 AI 公文写作辅助平台,为体制内工作人员提供高效的公文写作解决方案。拥有海量公文文库、9 大核心 AI 功能,支持 30 + 文稿类型生成,助力快速完成领导讲话、工作总结、述职报告等材料,提升办公效率,是体制打工人的得力写作神器。
最新AI工具、AI资讯
独家AI资源、AI项目落地
微信扫一扫关注公众号