fix chokidar interval param

wclr · wclr · commit 06b9759c8231 · 2020-06-13T19:43:23.000+05:00
diff --git a/README.md b/README.md
@@ -47,8 +47,9 @@ tsnd --respawn server.ts
 - `--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)
+- `--watch` - Explicitly add arbitrary files or folders to watch and restart on change (list separated by commas, [chokidar](https://github.com/paulmillr/chokidar) patterns)
 - `--exit-child` - Adds 'SIGTERM' exit handler in a child process.
+- `--rs` - Allow to restart with "rs" line entered in stdio, enabled by default, may turn it off `--rs false`
 
 **Caveats and points of notice:**
 
diff --git a/bin/ts-node-dev b/bin/ts-node-dev
@@ -66,7 +66,7 @@ var opts = minimist(devArgs, {
     project: 'P',
     'restart-terminated': 'rt'
   },
-  default: { deps: true, notify: true, rs: true },
+  default: { deps: true, notify: true, rs: true, 'type-check': true },
   unknown: function(arg) {
     unknown.push(arg)
     return true
diff --git a/lib/compiler.js b/lib/compiler.js
@@ -201,10 +201,7 @@ var compiler = {
       files: options['files'] || true,
     }
     try {
-      // if (compiler.service && compiler.service.enable) {
-      //   compiler.service.enable(false)
-      // }
-      compiler.service = register(tsNodeOptions)
+      compiler.service = register(tsNodeOptions)      
     } catch (e) {
       console.log(e)
       return
@@ -260,8 +257,9 @@ var compiler = {
       )
     } catch (e) {
       console.log('Compilation error in', fileName)
-      code = 'throw ' + 'new Error(' + JSON.stringify(e.message) + ')' + ';'
-      writeCompiled(code)
+      const errorCode =
+        'throw ' + 'new Error(' + JSON.stringify(e.message) + ')' + ';'
+      writeCompiled(errorCode)
       compiler.registerTsNode()
     }
   },
diff --git a/lib/index.js b/lib/index.js
@@ -48,7 +48,8 @@ module.exports = function(script, scriptArgs, nodeArgs, opts) {
   function initWatcher () {
     var watcher = chokidar.watch([], {
       usePolling: opts.poll,
-      interval: parseInt(opts.interval)      
+      interval: parseInt(opts.interval) || undefined,
+          
     })
     watcher.on('change', restart)
 
@@ -105,10 +106,10 @@ module.exports = function(script, scriptArgs, nodeArgs, opts) {
     //var compileReqWatcher = filewatcher({ forcePolling: opts.poll })
     if (compileReqWatcher) {
       compileReqWatcher.close()
-    }
+    }    
     compileReqWatcher = chokidar.watch([], {
       usePolling: opts.poll,
-      interval: parseInt(opts.interval)      
+      interval: parseInt(opts.interval) || undefined
     })
     var currentCompilePath
     fs.writeFileSync(compiler.getCompileReqFilePath(), '')
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "ts-node-dev",
-  "version": "1.0.0-pre.45",
+  "version": "1.0.0-pre.47",
   "description": "Compiles your TS app and restarts when files are modified.",
   "keywords": [
     "restart",
@@ -39,9 +39,9 @@
   "scripts": {
     "tsnd": "node ./bin/ts-node-dev",
     "ts-node-dev": "node ./bin/ts-node-dev",
-    "test": "ts-node test/index.ts",
-    "ci": "yarn test",    
-    "manual": "node ./bin/ts-node-dev --rt 5 --exit-child --tree-kill --clear -r tsconfig-paths/register -r ./test/ts/add-require -r ./test/ts/add-require-2 -r esm -O \"{\\\"module\\\": \\\"es6\\\"}\" --preserve-symlinks --respawn --ignore-watch 'lib' --ignore-watch bin --prefer-ts --debug --poll --interval 1000 --cache-directory .ts-node --inspect -- test/manual/test-script test-arg --fd"    
+    "test": "ts-node --transpile-only test/index.ts",
+    "ci": "yarn test",
+    "manual": "node ./bin/ts-node-dev --rt 5 --exit-child --tree-kill --clear -r tsconfig-paths/register -r ./test/manual/add-require -r ./test/manual/add-require-2 -r esm -O \"{\\\"module\\\": \\\"es6\\\"}\" --preserve-symlinks --respawn --ignore-watch 'lib' --ignore-watch bin --prefer-ts --debug --poll --interval 1000 --cache-directory .ts-node --inspect -- test/manual/test-script test-arg --fd"
   },
   "dependencies": {
     "chokidar": "^3.4.0",
@@ -54,13 +54,14 @@
     "rimraf": "^2.6.1",
     "source-map-support": "^0.5.12",
     "tree-kill": "^1.2.2",
-    "ts-node": "*",
+    "ts-node": "^8.10.2",
     "tsconfig": "^7.0.0"
   },
   "devDependencies": {
     "@types/fs-extra": "^9.0.1",
     "@types/node": "^8.0.4",
     "@types/tape": "^4.13.0",
+    "@types/touch": "^3.1.1",
     "coffee-script": "^1.8.0",
     "eslint": "^2.0.0",
     "eslint-config-airbnb-base": "^3.0.1",
@@ -71,6 +72,6 @@
     "tape": "^5.0.1",
     "touch": "^1.0.0",
     "tsconfig-paths": "^3.3.1",
-    "typescript": "^3.7.4"
+    "typescript": "^3.9.5"
   }
 }
diff --git a/test/fixture/dep-ts-error.ts b/test/fixture/dep-ts-error.ts
@@ -0,0 +1,4 @@
+export const fn = (x: number) => {  
+  return 'v1'
+}
+
diff --git a/test/fixture/folder/some-file b/test/fixture/folder/some-file
diff --git a/test/fixture/folder2/nest/other-file b/test/fixture/folder2/nest/other-file
diff --git a/test/fixture/simple.ts b/test/fixture/simple.ts
@@ -1,9 +1,3 @@
 import { fn } from './dep'
-//import { A } from './dep-interface'
-// const str: string = process.argv[2]
-// const obj: A = {
-//   a: '1',
-//   b: 2
-// }
 
 console.log(fn(1))
diff --git a/test/fixture/with-error.ts b/test/fixture/with-error.ts
@@ -0,0 +1,4 @@
+import { fn } from './dep-ts-error'
+
+// @ts-expect-erro
+console.log(fn('1'))
diff --git a/test/index.ts b/test/index.ts
@@ -1,24 +1,29 @@
 import * as test from 'tape'
 import { spawnTsNodeDev } from './spawn'
 import * as fs from 'fs-extra'
-import path = require('path')
+import { join } from 'path'
+import touch = require('touch')
 
-const tempDir = path.join(__dirname, '../.temp')
-export const scriptsDir = path.join(tempDir, 'fixture')
+const tempDir = join(__dirname, '../.temp')
+export const scriptsDir = join(tempDir, 'fixture')
 
-const replaceText = (
+const replaceText = async (
   script: string,
   pattern: string | RegExp,
   replace: string
 ) => {
-  const textFile = path.join(scriptsDir, script)
-  const text = fs.readFileSync(textFile, 'utf-8')
-  fs.writeFileSync(textFile, text.replace(pattern, replace))
+  const textFile = join(scriptsDir, script)
+  const text = await fs.readFile(textFile, 'utf-8')
+  return fs.writeFile(textFile, text.replace(pattern, replace))
+}
+
+const waitFor = (timeout: number) => {
+  return new Promise((resolve) => setTimeout(resolve, timeout))
 }
 
 fs.ensureDir(tempDir)
-fs.removeSync(path.join(tempDir, 'fixture'))
-fs.copySync(path.join(__dirname, 'fixture'), scriptsDir)
+fs.removeSync(join(tempDir, 'fixture'))
+fs.copySync(join(__dirname, 'fixture'), scriptsDir)
 
 /* 
  node ./bin/ts-node-dev --rt 5 
@@ -41,20 +46,38 @@ fs.copySync(path.join(__dirname, 'fixture'), scriptsDir)
  -- test/manual/test-script test-arg --fd
  */
 
-test('It should restart on file change', (t) => {
-  const ps = spawnTsNodeDev('--respawn simple.ts', (res) => {
-    if (/v1/.test(res)) {
-      setTimeout(() => {
-        replaceText('dep.ts', 'v1', 'v2')
-      }, 500)
-
-      return (res) => {
-        if (/v2/.test(res)) {
-          t.ok(/Restarting/.test(res), 'Restarting message ok')
-          t.ok(true, 'Changed code version applied.')
-          return { exit: () => t.end() }
-        }
-      }
-    }
-  })
+test('It should restart on file change', async (t) => {
+  const ps = spawnTsNodeDev('--respawn --poll simple.ts', {stdout: true})
+  await ps.waitForLine(/v1/)
+  setTimeout(() => replaceText('dep.ts', 'v1', 'v2'), 250)
+  await ps.waitForLine(/v2/)
+  t.pass('Changed code version applied.')
+  await ps.exit()
+})
+
+test('It allow watch arbitrary folder/file', async (t) => {
+  const ps = spawnTsNodeDev('--respawn --watch folder,folder2 simple.ts')
+  await ps.waitForLine(/Using/)
+  setTimeout(() => touch(join(scriptsDir, 'folder/some-file')), 250)
+  await ps.waitForLine(/Restarting.*some-file/)
+  t.pass('works')
+  await ps.exit()
+})
+
+test('It should report an error on start', async (t) => {
+  const ps = spawnTsNodeDev('--respawn with-error.ts')
+  await ps.waitForLine(/[ERROR]/)
+  const out = ps.getStdout()
+  t.ok(/Compilation error in/.test(out), 'Report error file')
+  t.ok(/[ERROR].*Unable to compile TypeScript/.test(out), 'Report TS error')
+  t.ok(/Argument of type/.test(out), 'Report TS error diagnostics')
+
+  setTimeout(() => replaceText('with-error.ts', `'1'`, '1'), 250)
+
+  // PROBLEM: if we try to fix not required/compiled dep it does not work.
+  // setTimeout(() => replaceText('dep-ts-error.ts', 'number', 'string'), 250)
+
+  await ps.waitForLine(/v1/)
+  t.pass('Restarted successfully after error fixed.')
+  await ps.exit()
 })
diff --git a/test/spawn.ts b/test/spawn.ts
@@ -1,46 +1,65 @@
 import child = require('child_process')
 import path = require('path')
+import { resolve } from 'url'
+import { resolveSoa } from 'dns'
 const bin = path.join(__dirname, '/../bin/ts-node-dev')
 const scriptsDir = path.join(__dirname, '/../.temp/fixture')
 
 export const spawnTsNodeDev = (
   cmd: string,
-  cb: (res: string, code: number, signal: string) => any
+  opts: { stdout?: boolean; stderr?: boolean } = {}
 ) => {
   const nodeArg = [bin].concat(cmd.split(' '))
   const ps = child.spawn('node', nodeArg, { cwd: scriptsDir })
   var out = ''
   var err = ''
 
-  if (cb) {
-    // capture stderr
-    ps.stderr.on('data', function (data) {
-      err += data.toString()
-    })
+  ps.stderr.on('data', function (data) {
+    if (opts.stderr) {
+      console.log('STDERR:', data.toString())
+    }
+    err += data.toString()
+  })
+  ps.stdout.on('data', function (data) {
+    if (opts.stdout) {
+      console.log('STDOUT:', data.toString())
+    }
+    out += data.toString()
+  })
 
-    // invoke callback
-    ps.on('exit', function (code, signal) {
-      if (err) cb(err, code, signal)
-    })
+  const testPattern = (pattern: string | RegExp, str: string) => {
+    return typeof pattern === 'string'
+      ? str.indexOf(pattern) >= 0
+      : pattern.test(str)
+  }
 
-    ps.stdout.on('data', function (data) {
-      out += data.toString()
-      var ret = cb.call(ps, out)
-      if (typeof ret == 'function') {
-        // use the returned function as new callback
-        cb = ret
-      } else if (ret && ret.exit) {
-        // kill the process and invoke the given function
+  return {
+    ps,
+    getStdout: () => out,
+    getStderr: () => err,
+    waitForLine: (pattern: string | RegExp) => {
+      return new Promise((resolve) => {
+        const listener = (data: string) => {
+          const line = data.toString()
+          console.log('line', line)
+          if (testPattern(pattern, line)) {
+            ps.stdout.removeListener('data', listener)
+            resolve(line)
+          }
+        }
+        ps.stdout.on('data', listener)
+      })
+    },
+    exit: () => {
+      return new Promise((resolve) => {
         ps.stdout.removeAllListeners('data')
         ps.stderr.removeAllListeners('data')
         ps.removeAllListeners('exit')
-        ps.on('exit', function () {
-          setTimeout(ret.exit, 1000)
+        ps.on('exit', function (code) {
+          resolve(code)
         })
         ps.kill()
-      }
-    })
+      })
+    },
   }
-
-  return ps
 }
diff --git a/tsconfig.json b/tsconfig.json
@@ -1,5 +1,29 @@
-{  
+{
   "compilerOptions": {
-    "allowJs": false
-  }
-}
+    "target": "es5",
+    "lib": ["es2015"],
+    "module": "commonjs",
+    "declaration": true,
+    "sourceMap": true,
+    "strictNullChecks": true,
+    "noImplicitAny": true,
+    "noImplicitThis": true,
+    "noImplicitReturns": true,
+    "noFallthroughCasesInSwitch": true,
+    "experimentalDecorators": true,
+    "emitDecoratorMetadata": true,
+    "allowJs": false,
+    "newLine": "LF",
+    "plugins": [
+      {
+        "name": "typescript-tslint-plugin",
+        "alwaysShowRuleFailuresAsWarnings": true
+      }
+    ]
+  },
+  "formatCodeOptions": {
+    "indentSize": 2,
+    "tabSize": 2
+  },
+  "exclude": ["**/node_modules/*"]
+}
diff --git a/yarn.lock b/yarn.lock

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +export const fn = (x: number) => {
 +  return 'v1'
 +}
++