Skip to content

Commit fed5f38

Browse files
committed
add versioning notice in readme
1 parent 141c033 commit fed5f38

File tree

4 files changed

+15
-8
lines changed

4 files changed

+15
-8
lines changed

CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
### Yalc changelog
22

3+
## 1.0.0-pre.60
4+
5+
- full migration to typescript src
6+
- fixes of require.extensions behavior in compiler
7+
38
## 1.0.0-pre.59 (2020-08-20)
49

510
- fix handing require extensions (#185, #196)

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Look up flags and options can be used [in ts-node's docs](https://github.com/Typ
4545
* `--deps` - Also watch `node_modules`; by default watching is turned off
4646

4747
* `--debug` - Some additional debug output
48-
* `--interval` - Polling interval (ms)
48+
* `--interval` - Polling interval (ms) - DOESN'T WORK CURRENTLY
4949
* `--debounce` - Debounce file change events (ms, non-polling mode)
5050
* `--clear` (`--cls`) - Will clear screen on restart
5151
* `--watch` - Explicitly add arbitrary files or folders to watch and restart on change (list separated by commas, [chokidar](https://github.com/paulmillr/chokidar) patterns)
@@ -55,11 +55,10 @@ Look up flags and options can be used [in ts-node's docs](https://github.com/Typ
5555

5656
If you need to detect that you are running with `ts-node-dev`, check if `process.env.TS_NODE_DEV` is set.
5757

58-
**Desktop Notifications**
5958

60-
If you want desktop-notifications you should install `node-notifier` package.
59+
**Points of notice:**
6160

62-
**Caveats and points of notice:**
61+
- If you want desktop-notifications you should install `node-notifier` package and use `--notify` flag.
6362

6463
- 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.
6564

@@ -73,6 +72,11 @@ If you want desktop-notifications you should install `node-notifier` package.
7372

7473
- 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.
7574

75+
76+
## Versioning
77+
78+
Currently versioning is not stable and the package is still treated as pre-release. You might expect some options API changes, if you want to avoid unexpected problems it is recommended to fixate the installed version.
79+
7680
## License
7781

78-
WTF.
82+
MIT.

package.json

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

src/compiler.ts

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,6 @@ import { resolveSync } from 'tsconfig'
99
import { Options } from './bin'
1010
import { getCompiledPath } from './get-compiled-path'
1111

12-
const tmpDir = '.ts-node'
13-
1412
const fixPath = (p: string) => p.replace(/\\/g, '/').replace(/\$/g, '$$$$')
1513

1614
const sourceMapSupportPath = require.resolve('source-map-support')

0 commit comments

Comments
 (0)