ts-node-dev

Compiles your TS app and restarts when files are modified.

  • 所有者: wclr/ts-node-dev
  • 平台:
  • 许可证: MIT License
  • 分类:
  • 主题:
  • 喜欢:
    0
      比较:

Github星跟踪图

ts-node-dev

Tweaked version of node-dev that uses ts-node under the hood.

It restarts target node process when any of required files changes (as standard node-dev) but shares 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.

Install

yarn add ts-node-dev --dev
npm i ts-node-dev --save-dev

ts-node dependency version is not fixed, so it will install the latest version by default.

Usage

ts-node-dev [node-dev, ts-node flags] [ts-node-dev flags] [node cli flags] [--] [script] [script arguments]

So you just combine node-dev and ts-node options (see docs of those packages):

ts-node-dev --respawn --transpileOnly server.ts

There is also short alias tsnd for running ts-node-dev:

tsnd --respawn server.ts

Also there are additional options specific to ts-node-dev:

  • --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.

  • --ignore-watch (default: []) - files/folders to be ignored by node-dev. 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.
    So, to ignore everything in node_modules, just pass --ignore-watch node_modules.

  • --debug - Some additional debug output.

  • --interval - Polling interval (ms)

  • --debounce - Debounce file change events (ms, non-polling mode)

  • --clear (--cls) Will clear screen on restart

  • --watch - Explicitly add files or folders to watch and restart on change (list separated by commas)

  • --exit-child - Adds 'SIGTERM' exit handler in a child process.

Caveats and points of notice:

  • 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.

  • --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.

  • 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:

    ts-node-dev --inspect -- my-script.ts
    
  • 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.

License

WTF.

主要指标

概览
名称与所有者wclr/ts-node-dev
主编程语言TypeScript
编程语言JavaScript (语言数: 2)
平台
许可证MIT License
所有者活动
创建于2017-06-18 16:36:43
推送于2024-06-14 23:39:53
最后一次提交2022-05-26 22:37:33
发布数26
最新版本名称v2.0.0 (发布于 2022-05-26 22:37:33)
第一版名称v2.0.2 (发布于 2013-07-23 14:40:08)
用户参与
星数3.5k
关注者数14
派生数118
提交数543
已启用问题?
问题数273
打开的问题数110
拉请求数25
打开的拉请求数17
关闭的拉请求数35
项目设置
已启用Wiki?
已存档?
是复刻?
已锁定?
是镜像?
是私有?