Skip to content

Commit c5179e6

Browse files
committed
add changelog, docs
1 parent 5540ac3 commit c5179e6

File tree

3 files changed

+15
-14
lines changed

3 files changed

+15
-14
lines changed

CHANGELOG.md

+3
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
11
### Yalc changelog
22

3+
34
## 1.0.0-pre.57
45

56
- fix `--deps` flag
67
- add `--deps-level` flag
8+
- remove setting default NODE_ENV
9+
- add process.env.TS_NODE_DEV = 'true'
710

811
## 1.0.0-pre.56 (2020-07-24)
912

README.md

+11-13
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@ It restarts target node process when any of required files changes (as standard
88

99
![npm (scoped)](https://img.shields.io/npm/v/ts-node-dev.svg?maxAge=86400) [![Build Status](https://travis-ci.org/whitecolor/ts-node-dev.svg?branch=master)](https://travis-ci.org/whitecolor/ts-node-dev)
1010

11-
1211
```
1312
yarn add ts-node-dev --dev
1413
```
@@ -37,25 +36,24 @@ There is also short alias `tsnd` for running `ts-node-dev`:
3736
tsnd --respawn server.ts
3837
```
3938

40-
4139
Look up flags and options can be used [in ts-node's docs](https://github.com/TypeStrong/ts-node#cli-and-programmatic-options).
4240

43-
4441
**Also there are additional options specific to `ts-node-dev`:**
4542

4643
- `--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.
4744

4845
- use `--deps` to watch `node_modules`, by default watching it turned off.
49-
50-
51-
- `--debug` - Some additional debug output.
52-
- `--interval` - Polling interval (ms)
53-
- `--debounce` - Debounce file change events (ms, non-polling mode)
54-
- `--clear` (`--cls`) Will clear screen on restart
55-
- `--watch` - Explicitly add arbitrary files or folders to watch and restart on change (list separated by commas, [chokidar](https://github.com/paulmillr/chokidar) patterns)
56-
- `--exit-child` - Adds 'SIGTERM' exit handler in a child process.
57-
- `--rs` - Allow to restart with "rs" line entered in stdio, disabled by default.
58-
- `--no-notify` - Do not display desktop-notifications (Notifications are only displayed if `node-notifier` is installed).
46+
47+
* `--debug` - Some additional debug output.
48+
* `--interval` - Polling interval (ms)
49+
* `--debounce` - Debounce file change events (ms, non-polling mode)
50+
* `--clear` (`--cls`) Will clear screen on restart
51+
* `--watch` - Explicitly add arbitrary files or folders to watch and restart on change (list separated by commas, [chokidar](https://github.com/paulmillr/chokidar) patterns)
52+
* `--exit-child` - Adds 'SIGTERM' exit handler in a child process.
53+
* `--rs` - Allow to restart with "rs" line entered in stdio, disabled by default.
54+
* `--no-notify` - Do not display desktop-notifications (Notifications are only displayed if `node-notifier` is installed).
55+
56+
If you need to detect that you are running with `ts-node-dev`, check if `process.env.TS_NODE_DEV` is set.
5957

6058
**Desktop Notifications**
6159

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "ts-node-dev",
3-
"version": "1.0.0-pre.56",
3+
"version": "1.0.0-pre.57",
44
"description": "Compiles your TS app and restarts when files are modified.",
55
"keywords": [
66
"restart",

0 commit comments

Comments
 (0)