typescript-run
v0.1.1
Published
Run TypeScript files with ease and at a lightning speed of esbuild!
Downloads
56
Maintainers
Readme
typescript-run
ts-node but extremely fast ⚡️
Uses esbuild to compile TypeScript to JavaScript.
Install
Install globally
npm i -g typescript-run
ts-run ./src/index.ts
or
Execute with npx
npx typescript-run ./src/index.ts
Usage
ts-run
is an alias to typescript-run
. You can use either of them.
typescript-run <file-path> # or `ts-run <file-path>`
Options
Watch Mode
Pass --watch
or -w
flag to enable watch mode. This will listen to your file changes and re-run the script.
ts-run src/index.ts --watch
By default, watch flag will watch over the files that are going to part of your bundle (.ts
.js
files imported in entry file). You can also override this behavior by passing path to --watch
flag with-
ts-run src/index.ts --watch src
This will watch over all the changes in src
folder.
You can also pass multiple directories with --watch src examples
. This will watch over src
and examples
both
When to use?
Use tsc
for builds and typescript-run
for dev-mode.
Warning:
- Not ready for serious projects
- Make sure you check out ESBuild TypeScript Caveats first.
Why esbuild?
- Esbuild does not do type-checking which makes the TypeScript to JavaScript compilation super fast!
- Type-checking is not a blocker for running scripts in dev-mode. IDEs can handle it as well as you can individually run
tsc
in emit mode.
Thanks! Have fun 🌻