tsx README

The project's README from github.com/privatenumber/tsx. As one markdown file: README.md.


tsx

TypeScript Execute (tsx): The easiest way to run TypeScript in Node.js

Documentation    |    Getting started →


Already a sponsor? Join the discussion in the Development repo!

Sponsors

tsx (privatenumber/tsx)

Searching Database…

12.2K ·GitHub
这是什么?tsx(TypeScript Execute)是一个命令行工具,可以直接在 Node.js 中运行 TypeScript 以及 JSX/TSX 文件,借助 esbuild 实时转译,无需单独的编译步骤。
我需要先编译 TypeScript 吗,还是 tsx 可以直接运行?tsx 可以直接运行 .ts/.tsx(以及 .js/.jsx)文件,用它代替 `node` 命令即可。它会在执行前通过 esbuild 在内存中转译源代码,因此无需管理构建步骤。
我该怎么用它运行 TypeScript 文件?可以临时使用 `npx tsx file.ts`,也可以通过 `npm install --save-dev tsx` 将它添加为 devDependency,然后在平时输入 `node` 的地方改用 `tsx`。
它底层需要什么支持?它要求 Node.js 18 或更高版本,并且只把 esbuild 作为唯一的运行时依赖打包在内,因此上手时无需额外配置 tsconfig。
tsx 会检查我的 TypeScript 类型吗?不会。由于 tsx 依赖 esbuild 进行快速转译,而不是完整的 TypeScript 编译器,它不做类型检查,因此类型错误不会阻止代码运行。
tsx 和 ts-node 有什么区别?tsx 基于 esbuild 构建,而 ts-node 使用的是官方 TypeScript 编译器。tsx 的启动和执行速度快得多,代价是跳过了类型检查。
开发时可以用它实现自动重启吗?可以。`tsx watch file.ts` 会在任何依赖项发生变化时自动重新运行脚本,功能类似 nodemon,但内置了 TypeScript/JSX 支持。
不改变运行命令也能用吗?可以。tsx 还可以作为 Node.js 的加载器钩子使用(例如 `node --import tsx script.ts`),为现有的 Node 进程添加 TypeScript 支持,而无需替换 `node` 命令本身。
What are similar projects?chokidar, nodemon, scriptc, ava, rspack, bun, esbuild, svgr
Size
3 MB
Stars
12.2K
Age
4y
Commits · 90 Days