--debug, --exec-check

Author: wclr

README.md

@@ -7,37 +7,51 @@ It restarts target node process when any of required files changes (as standard
 ## Install
 
 ```
-yarn add ts-node-dev
+yarn add ts-node-dev --dev
 ```
 
 ```
-npm i ts-node-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] [script] [script arguments]
+ts-node-dev [node-dev|ts-node flags] [ts-node-dev flags] [node cli flags] [--] [script] [script arguments]
 ```
 
 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):
 ```
 ts-node-dev --respawn --transpileOnly server.ts
 ```
 
-Also there are additional options specific to `ts-node-dev`:
+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`](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. 
-So, to ignore everthing in `node_modules`, just pass `--ignore-watch node_modules`
+So, to ignore everthing in `node_modules`, just pass `--ignore-watch node_modules`.
+
+- `--debug` - some additional debug output.
+
+**And some points to notice:**
+
+- `--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.
 
-NB! `--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:
 
-## Caveats
+  ```
+  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.
+- 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
 

bin/ts-node-dev

@@ -15,7 +15,9 @@ var opts = minimist(devArgs, {
     'cache', 'type-check',
     'prefer-ts',
     'transpileOnly',
-    'files'
+    'files',
+    'exec-check',
+    'debug'
   ],
   string: [
     'compiler', 'project', 'ignore',

lib/cfg.js

@@ -31,8 +31,7 @@ module.exports = function (main, opts) {
 
   var ignoreWatch = ([]).concat(opts && opts['ignore-watch'] || []);  
   ignoreWatch.length && console.log('Ignore watch:', ignoreWatch)
-  var ignore = ignoreWatch.concat(ignoreWatch.map(resolvePath));
-  
+  var ignore = ignoreWatch.concat(ignoreWatch.map(resolvePath));  
   return {
     vm: c.vm !== false,
     fork: c.fork !== false,
@@ -43,6 +42,7 @@ module.exports = function (main, opts) {
     dedupe: !!c.dedupe,
     ignore: ignore,
     respawn: c.respawn || false,
+    debug: opts.debug,
     extensions: c.extensions || {
       coffee: 'coffee-script/register',
       ls: 'LiveScript'

lib/child-require-hook.js

@@ -4,15 +4,34 @@ var sep = require('path').sep
 var join = require('path').join
 var execSync = require('child_process').execSync
 var compilationId
-var timeThreshold = 10000
+var timeThreshold = 0
 var allowJs = false
 var compiledDir
 var preferTs = false
 var ignore = [/node_modules/]
 var readyFile
+var execCheck = false
 
 var checkFileScript = join(__dirname, 'check-file-exists.js')
 
+var waitForFile = function (fileName) {
+  var start = new Date().getTime()
+  while (true) {
+    const exists = execCheck
+      ? execSync(['node', checkFileScript, '"' + fileName + '"'].join(' '), { stdio: 'inherit' }) 
+      : fs.existsSync(fileName)
+    if (exists) {
+      return
+    }
+    var passed = (new Date().getTime() - start)
+    if (timeThreshold && passed > timeThreshold) {
+      throw new Error(
+        'Could not require ' + fileName
+      )
+    }
+  }
+}
+
 var compile = (code, fileName) => {
   var compiledPath = getCompiledPath(code, fileName, compiledDir)
   process.send({
@@ -21,7 +40,7 @@ var compile = (code, fileName) => {
   })
   var compileRequestFile = [compiledDir, compilationId + '.req'].join(sep)
   fs.writeFileSync(compileRequestFile, [fileName, compiledPath].join('\n'))
-  execSync(['node', checkFileScript, '"' + compiledPath + '.done' + '"'].join(' '), { stdio: 'inherit' })
+  waitForFile(compiledPath + '.done')
   var compiled = fs.readFileSync(compiledPath, 'utf-8')
   return compiled
 }

lib/compiler.js

@@ -52,6 +52,9 @@ var compiler = {
     if (options['prefer-ts']) {
       fileData = fileData.replace('preferTs = false', 'preferTs = true')
     }
+    if (options['exec-check']) {
+      fileData = fileData.replace('execCheck = false', 'execCheck = true')
+    }
     if (options['ignore'] !== undefined) {
       var ignore = options['ignore']
       var ignoreVal = !ignore || ignore === 'false'

lib/index.js

@@ -5,7 +5,7 @@ var resolveMain = require('./resolveMain');
 var compiler = require('./compiler');
 var fs = require('fs');
 
-module.exports = function (script, scriptArgs, nodeArgs, opts) {  
+module.exports = function (script, scriptArgs, nodeArgs, opts) {
   compiler.init(opts)
   if (typeof script !== 'string' || script.length === 0) {
     throw new TypeError('`script` must be a string');
@@ -26,9 +26,9 @@ module.exports = function (script, scriptArgs, nodeArgs, opts) {
   var main = resolveMain(script);
   var cfg = require('./cfg')(main, opts);
   var log = require('./log')(cfg);
-  var notify = require('./notify')(cfg, log);  
+  var notify = require('./notify')(cfg, log);
   compiler.notify = notify
-  compiler.stop = stop  
+  compiler.stop = stop
   // Run ./dedupe.js as preload script
   if (cfg.dedupe) process.env.NODE_DEV_PRELOAD = __dirname + '/dedupe';
 
@@ -38,20 +38,20 @@ module.exports = function (script, scriptArgs, nodeArgs, opts) {
     if (file === compiler.tsConfigPath) {
       notify('Reinitializing TS compilation');
       compiler.init(opts);
-    }    
+    }
     /* eslint-disable no-octal-escape */
     if (cfg.clear) process.stdout.write('\033[2J\033[H');
     notify('Restarting', file + ' has been modified');
-    compiler.compileChanged(file)    
+    compiler.compileChanged(file)
     if (starting) return
     watcher.removeAll();
     starting = true
     if (child) {
-      // Child is still running, restart upon exit      
+      log.debug('Child is still running, restart upon exit')
       child.on('exit', start);
       stop();
     } else {
-      // Child is already stopped, probably due to a previous error
+      log.debug('Child is already stopped, probably due to a previous error')
       start();
     }
   });
@@ -66,10 +66,11 @@ module.exports = function (script, scriptArgs, nodeArgs, opts) {
   /**
    * Run the wrapped script.
    */
-  function start() { 
-    var cmd = nodeArgs.concat(wrapper, script, scriptArgs);    
+  function start() {
+    var cmd = nodeArgs.concat(wrapper, script, scriptArgs);
     var childHookPath = compiler.getChildHookPath();
     cmd = ['-r', childHookPath].concat(cmd);
+    log.debug('Starting child process %s', cmd.join(' '))
     child = fork(cmd[0], cmd.slice(1), {
       cwd: process.cwd(),
       env: process.env
@@ -79,10 +80,10 @@ module.exports = function (script, scriptArgs, nodeArgs, opts) {
     var currentCompilePath
     fs.writeFileSync(compiler.getCompileReqFilePath(), '');
     compileReqWatcher.add(compiler.getCompileReqFilePath());
-    compileReqWatcher.on('change', function (file) {      
+    compileReqWatcher.on('change', function (file) {
       fs.readFile(file, 'utf-8', function (err, data) {
         if (err) {
-          console.log('Error reading compile request file', err)
+          log.error('Error reading compile request file', err)
           return
         }
         var split = data.split('\n')
@@ -104,8 +105,9 @@ module.exports = function (script, scriptArgs, nodeArgs, opts) {
       currentCompilePath = message.compiledPath
       compiler.compile(message)
     });
-    
+
     child.on('exit', function (code) {
+      log.debug('Child exited with code %s', code)
       if (!child) return
       if (!child.respawn) process.exit(code);
       child = undefined;
@@ -115,10 +117,11 @@ module.exports = function (script, scriptArgs, nodeArgs, opts) {
       child.respawn = true;
     }
 
-    if (!compiler.tsConfigPath) {
-      throw new Error('Check existance of tsconfig.json file.')
+
+    if (compiler.tsConfigPath) {
+      watcher.add(compiler.tsConfigPath);
     }
-    watcher.add(compiler.tsConfigPath);
+
 
     // Listen for `required` messages and watch the required file.        
     ipc.on(child, 'required', function (m) {
@@ -142,11 +145,15 @@ module.exports = function (script, scriptArgs, nodeArgs, opts) {
       return
     };
     child.stopping = true
-    child.respawn = true;    
+    child.respawn = true;
     if (child.connected === undefined || child.connected === true) {
+      log.debug('Disconnecting from child')
       child.disconnect();
-      if (!willTerminate) child.kill('SIGTERM');
-    }        
+      if (!willTerminate) {
+        log.debug('Sending SIGTERM kill to child')
+        child.kill('SIGTERM');
+      }
+    }
   }
 
   // Relay SIGTERM

lib/log.js

@@ -4,7 +4,8 @@ var fmt = require('dateformat');
 var colors = {
   info: '36',
   error: '31;1',
-  warn: '33'
+  warn: '33',
+  debug: '90'
 };
 
 /**
@@ -26,6 +27,11 @@ module.exports = function (cfg) {
     return s;
   }
 
+  log.debug = function () {
+    if (!cfg.debug) return
+    log(util.format.apply(util, arguments), 'debug');
+  };
+
   log.info = function () {
     log(util.format.apply(util, arguments), 'info');
   };

lib/wrap.js

@@ -12,7 +12,7 @@ process.argv.splice(1, 1);
 // Resolve the location of the main script relative to cwd
 var main = resolveMain(process.argv[1]);
 
-var cfg = require('./cfg')(main);
+var cfg = require('./cfg')(main, {});
 
 // Set NODE_ENV to 'development' unless already set
 if (!process.env.NODE_ENV) process.env.NODE_ENV = 'development';

package.json

@@ -19,7 +19,8 @@
   },
   "license": "MIT",
   "bin": {
-    "ts-node-dev": "./bin/ts-node-dev"
+    "ts-node-dev": "./bin/ts-node-dev",
+    "tsnd": "./bin/ts-node-dev"
   },
   "main": "./lib",
   "files": [
@@ -34,7 +35,7 @@
   "scripts": {
     "ts-node-dev": "node ./bin/ts-node-dev",
     "test-node-dev": "tap test/*.js",
-    "test": "node ./bin/ts-node-dev -r tsconfig-paths/register -r ./test/ts/add-require.js -r ./test/ts/add-require-2.js -O \"{\\\"module\\\": \\\"commonjs\\\"}\" --respawn --ignore-watch 'lib' --ignore-watch bin --prefer-ts --cache-directory .ts-node test/ts/test-script test-arg --fd",
+    "test": "node ./bin/ts-node-dev -r tsconfig-paths/register -r ./test/ts/add-require.js -r ./test/ts/add-require-2.js -O \"{\\\"module\\\": \\\"commonjs\\\"}\" --respawn --ignore-watch 'lib' --ignore-watch bin --prefer-ts --debug --cache-directory .ts-node --inspect -- test/ts/test-script test-arg --fd",
     "test-docker": "docker run --rm -v ${PWD}:/app mhart/alpine-node:8.7.0 sh -c 'cd app && node ./bin/ts-node-dev --cache-directory .ts-node test/ts/big'"
   },
   "dependencies": {

test/ts/test-script.ts

@@ -1,6 +1,6 @@
 import {fn} from './dep'
 
 const str: string = process.argv[2]
-console.log('test3', str)
-//
-fn()
+console.log('test', str)
+
+//fn()