| 1 | # ts-node-dev
|
| 2 |
|
| 3 | > Tweaked version of [node-dev](https://github.com/fgnass/node-dev) that uses [ts-node](https://github.com/TypeStrong/ts-node) under the hood.
|
| 4 |
|
| 5 | It restarts target node process when any of required files changes (as standard `node-dev`) but shares [Typescript](https://github.com/Microsoft/TypeScript/) compilation process between restarts. This significantly increases speed of restarting comparing to `node-dev -r ts-node/register ...`, `nodemon -x ts-node ...` variations because there is no need to instantiate `ts-node` compilation each time.
|
| 6 |
|
| 7 | ## Install
|
| 8 |
|
| 9 | ```
|
| 10 | yarn add ts-node-dev --dev
|
| 11 | ```
|
| 12 |
|
| 13 | ```
|
| 14 | npm i ts-node-dev --save-dev
|
| 15 | ```
|
| 16 |
|
| 17 | `ts-node` dependency version is not fixed, so it will install the latest version by default.
|
| 18 |
|
| 19 | ## Usage
|
| 20 |
|
| 21 | ```
|
| 22 | ts-node-dev [node-dev|ts-node flags] [ts-node-dev flags] [node cli flags] [--] [script] [script arguments]
|
| 23 | ```
|
| 24 |
|
| 25 | So you just combine [node-dev](https://github.com/fgnass/node-dev) and [ts-node](https://github.com/TypeStrong/ts-node) options (see docs of those packages):
|
| 26 |
|
| 27 | ```
|
| 28 | ts-node-dev --respawn --transpileOnly server.ts
|
| 29 | ```
|
| 30 |
|
| 31 | There is also short alias `tsnd` for running `ts-node-dev`:
|
| 32 |
|
| 33 | ```
|
| 34 | tsnd --respawn server.ts
|
| 35 | ```
|
| 36 |
|
| 37 | **Also there are additional options specific to `ts-node-dev`:**
|
| 38 |
|
| 39 | - `--prefer-ts` (default: false) - for each `.js` file (that is not in `node_modules`) will try to check if corresponding `.ts` version exists and require it.
|
| 40 | - `--ignore-watch` (default: []) - files/folders to be [ignored by `node-dev`](https://github.com/fgnass/node-dev#ignore-paths). **But also this behaviour enhanced:** it will also make up `new RegExp` of passed ignore string and check absolute paths of required files for match.
|
| 41 | So, to ignore everything in `node_modules`, just pass `--ignore-watch node_modules`.
|
| 42 |
|
| 43 | - `--debug` - Some additional debug output.
|
| 44 | - `--interval` - Polling interval (ms)
|
| 45 | - `--debounce` - Debounce file change events (ms, non-polling mode)
|
| 46 | - `--clear` (`--cls`) Will clear screen on restart
|
| 47 | - `--watch` - Explicitly add files or folders to watch and restart on change (list separated by commas)
|
| 48 |
|
| 49 | **Caveats and points of notice:**
|
| 50 |
|
| 51 | - Especially for large code bases always consider running with `--transpile-only` flag which is normal for dev workflow and will speed up things greatly. Note, that `ts-node-dev` will not put watch handlers on TS files that contain only types/interfaces (used only for type checking) - this is current limitation by design.
|
| 52 |
|
| 53 | - `--ignore-watch` will NOT affect files ignored by TS compilation. Use `--ignore` option (or `TS_NODE_IGNORE` env variable) to pass **RegExp strings** for filtering files that should not be compiled, by default `/node_modules/` are ignored.
|
| 54 |
|
| 55 | - Unknown flags (`node` cli flags are considered to be so) are treated like string value flags by default. The right solution to avoid ambiguity is to separate script name from option flags with `--`, for example:
|
| 56 |
|
| 57 | ```
|
| 58 | ts-node-dev --inspect -- my-script.ts
|
| 59 | ```
|
| 60 |
|
| 61 | - The good thing is that `ts-node-dev` watches used `tsconfig.json` file, and will reinitialize compilation on its change, but you have to restart the process manually when you update used version of `typescript` or make any other changes that may effect compilation results.
|
| 62 |
|
| 63 | ## License
|
| 64 |
|
| 65 | WTF.
|
| 66 | |
| \ | No newline at end of file |