add notice about --transpileOnly

Author: wclr

.gitignore

@@ -1,5 +1,5 @@
 .DS_Store
 .vagrant
 node_modules
-npm-debug.log
+*.log
 .ts-node

README.md

@@ -1,6 +1,6 @@
-# ts-node-dev 
+# ts-node-dev
 
-> Tweaked version of [node-dev](https://github.com/fgnass/node-dev) that uses [ts-node](https://github.com/TypeStrong/ts-node) under the hood. 
+> Tweaked version of [node-dev](https://github.com/fgnass/node-dev) that uses [ts-node](https://github.com/TypeStrong/ts-node) under the hood.
 
 It restarts target node process when any of required files changes (as standard `node-dev`) but shares [Typescript](https://github.com/Microsoft/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.
 
@@ -23,6 +23,7 @@ ts-node-dev [node-dev|ts-node flags] [ts-node-dev flags] [node cli flags] [--] [
 ```
 
 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
 ```
@@ -36,12 +37,14 @@ 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`.
+- `--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`.
 
 - `--debug` - some additional debug output.
 
-**And some points to notice:**
+**Caveats and points of notice:**
+
+- Especially for large code bases always consider running with `--transpileOnly` 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.
 

lib/child-require-hook.js

@@ -14,20 +14,21 @@ var execCheck = false
 
 var checkFileScript = join(__dirname, 'check-file-exists.js')
 
-var waitForFile = function (fileName) {
+var waitForFile = function(fileName) {
   var start = new Date().getTime()
   while (true) {
     const exists = execCheck
-      ? execSync(['node', checkFileScript, '"' + fileName + '"'].join(' '), { stdio: 'inherit' }) 
+      ? execSync(['node', checkFileScript, '"' + fileName + '"'].join(' '), {
+          stdio: 'inherit'
+        }) || true
       : fs.existsSync(fileName)
+
     if (exists) {
       return
     }
-    var passed = (new Date().getTime() - start)
+    var passed = new Date().getTime() - start
     if (timeThreshold && passed > timeThreshold) {
-      throw new Error(
-        'Could not require ' + fileName
-      )
+      throw new Error('Could not require ' + fileName)
     }
   }
 }
@@ -46,11 +47,11 @@ var compile = (code, fileName) => {
 }
 
 function registerExtensions(extensions) {
-  extensions.forEach(function (ext) {
+  extensions.forEach(function(ext) {
     var old = require.extensions[ext] || require.extensions['.js']
-    require.extensions[ext] = function (m, fileName) {
+    require.extensions[ext] = function(m, fileName) {
       var _compile = m._compile
-      m._compile = function (code, fileName) {
+      m._compile = function(code, fileName) {
         return _compile.call(this, compile(code, fileName), fileName)
       }
       return old(m, fileName)
@@ -65,7 +66,7 @@ function isFileInNodeModules(fileName) {
 function registerJsExtension() {
   var old = require.extensions['.js']
   if (allowJs || preferTs) {
-    require.extensions['.js'] = function (m, fileName) {
+    require.extensions['.js'] = function(m, fileName) {
       var tsCode
       var tsFileName
       if (preferTs && !isFileInNodeModules(fileName)) {
@@ -75,11 +76,13 @@ function registerJsExtension() {
         }
       }
       var _compile = m._compile
-      var isIgnored = ignore && ignore.reduce(function (res, ignore) {
-        return res || ignore.test(fileName)
-      }, false)
+      var isIgnored =
+        ignore &&
+        ignore.reduce(function(res, ignore) {
+          return res || ignore.test(fileName)
+        }, false)
       if (tsCode !== undefined || (allowJs && !isIgnored)) {
-        m._compile = function (code, fileName) {
+        m._compile = function(code, fileName) {
           if (tsCode !== undefined) {
             code = tsCode
             fileName = tsFileName
@@ -104,4 +107,4 @@ if (readyFile) {
   }
 }
 
-module.exports.registerExtensions = registerExtensions
+module.exports.registerExtensions = registerExtensions

lib/compiler.js

@@ -13,36 +13,46 @@ var getCompiledPath = require('./get-compiled-path')
 var tmpDir = '.ts-node'
 
 var extensions = ['.ts', '.tsx']
-var empty = function () { }
+var empty = function() {}
 var cwd = process.cwd()
-var comilationInstanceStampt = Math.random().toString().slice(2)
+var comilationInstanceStampt = Math.random()
+  .toString()
+  .slice(2)
 
 var compiler = {
   allowJs: false,
   tsConfigPath: '',
-  getCompilationId: function () {
+  getCompilationId: function() {
     return comilationInstanceStampt
   },
-  getCompiledDir: function () {
+  getCompiledDir: function() {
     return path.join(tmpDir, 'compiled').replace(/\\/g, '/')
   },
-  getCompileReqFilePath: function () {
-    return path.join(compiler.getCompiledDir(), compiler.getCompilationId() + '.req')
+  getCompileReqFilePath: function() {
+    return path.join(
+      compiler.getCompiledDir(),
+      compiler.getCompilationId() + '.req'
+    )
   },
-  getCompilerReadyFilePath: function () {
-    return path.join(os.tmpdir(), 'ts-node-dev-ready-' + comilationInstanceStampt)
+  getCompilerReadyFilePath: function() {
+    return path
+      .join(os.tmpdir(), 'ts-node-dev-ready-' + comilationInstanceStampt)
       .replace(/\\/g, '/')
   },
-  getChildHookPath: function () {
-    return path.join(os.tmpdir(), 'ts-node-dev-hook-' + comilationInstanceStampt + '.js')
+  getChildHookPath: function() {
+    return path
+      .join(os.tmpdir(), 'ts-node-dev-hook-' + comilationInstanceStampt + '.js')
       .replace(/\\/g, '/')
   },
-  writeReadyFile: function () {
+  writeReadyFile: function() {
     var fileData = fs.writeFileSync(compiler.getCompilerReadyFilePath(), '')
   },
-  writeChildHookFile: function (options) {
-    var fileData = fs.readFileSync(path.join(__dirname, 'child-require-hook.js'), 'utf-8')
-    var compileTimeout = parseInt(options['compile-timeout'])    
+  writeChildHookFile: function(options) {
+    var fileData = fs.readFileSync(
+      path.join(__dirname, 'child-require-hook.js'),
+      'utf-8'
+    )
+    var compileTimeout = parseInt(options['compile-timeout'])
     if (compileTimeout) {
       fileData = fileData.replace('10000', compileTimeout.toString())
     }
@@ -57,23 +67,46 @@ var compiler = {
     }
     if (options['ignore'] !== undefined) {
       var ignore = options['ignore']
-      var ignoreVal = !ignore || ignore === 'false'
-        ? 'false'
-        : '[' + (Array.isArray(ignore) ? ignore : ignore.split(/, /))
-          .map(ignore => 'new RegExp("' + ignore + '")').join(', ') + ']'
-      fileData = fileData.replace('var ignore = [/node_modules/]', 'var ignore = ' + ignoreVal)
+      var ignoreVal =
+        !ignore || ignore === 'false'
+          ? 'false'
+          : '[' +
+            (Array.isArray(ignore) ? ignore : ignore.split(/, /))
+              .map(ignore => 'new RegExp("' + ignore + '")')
+              .join(', ') +
+            ']'
+      fileData = fileData.replace(
+        'var ignore = [/node_modules/]',
+        'var ignore = ' + ignoreVal
+      )
     }
-    fileData = fileData.replace('var compilationId', 'var compilationId = "' + compiler.getCompilationId() + '"')
-    fileData = fileData.replace('var compiledDir', 'var compiledDir = "' + compiler.getCompiledDir() + '"')
-    fileData = fileData.replace('./get-compiled-path', path.join(__dirname, 'get-compiled-path').replace(/\\/g, '/'))
-    fileData = fileData.replace('var readyFile',
-      'var readyFile = "' + compiler.getCompilerReadyFilePath() + '"')
-    fileData = fileData.replace(/__dirname/, '"' + __dirname.replace(/\\/g, '/') + '"')
+    fileData = fileData.replace(
+      'var compilationId',
+      'var compilationId = "' + compiler.getCompilationId() + '"'
+    )
+    fileData = fileData.replace(
+      'var compiledDir',
+      'var compiledDir = "' + compiler.getCompiledDir() + '"'
+    )
+    fileData = fileData.replace(
+      './get-compiled-path',
+      path.join(__dirname, 'get-compiled-path').replace(/\\/g, '/')
+    )
+    fileData = fileData.replace(
+      'var readyFile',
+      'var readyFile = "' + compiler.getCompilerReadyFilePath() + '"'
+    )
+    fileData = fileData.replace(
+      /__dirname/,
+      '"' + __dirname.replace(/\\/g, '/') + '"'
+    )
     fs.writeFileSync(compiler.getChildHookPath(), fileData)
   },
-  init: function (options) {
+  init: function(options) {
     var project = options['project']
-    compiler.tsConfigPath = resolveSync(cwd, typeof project === 'string' ? project : undefined) || ''
+    compiler.log = options.log
+    compiler.tsConfigPath =
+      resolveSync(cwd, typeof project === 'string' ? project : undefined) || ''
 
     var originalJsHandler = require.extensions['.js']
     require.extensions['.ts'] = empty
@@ -86,7 +119,10 @@ var compiler = {
       try {
         compilerOptions = JSON.parse(options['compilerOptions'])
       } catch (e) {
-        console.log('Could not parse compilerOptions', options['compilerOptions'])
+        console.log(
+          'Could not parse compilerOptions',
+          options['compilerOptions']
+        )
         console.log(e)
       }
     }
@@ -129,7 +165,7 @@ var compiler = {
     tsHandler = require.extensions['.ts']
     compiler.writeChildHookFile(options)
   },
-  compileChanged: function (fileName) {
+  compileChanged: function(fileName) {
     var ext = path.extname(fileName)
     if (extensions.indexOf(ext) < 0) return
     try {
@@ -143,7 +179,7 @@ var compiler = {
       console.error(e)
     }
   },
-  compile: function (params) {
+  compile: function(params) {
     var fileName = params.compile
     var code = fs.readFileSync(fileName, 'utf-8')
     var compiledPath = params.compiledPath
@@ -154,23 +190,22 @@ var compiler = {
     if (fs.existsSync(compiledPath)) {
       return
     }
+    var starTime = new Date().getTime()
     var m = {
       _compile: writeCompiled
     }
-    tsHandler(m, fileName)    
+    tsHandler(m, fileName)
     try {
       m._compile(code, fileName)
+      compiler.log.debug(
+        fileName,
+        'compiled in',
+        new Date().getTime() - starTime,
+        'ms'
+      )
     } catch (e) {
-      var splits = e.message.split('\n')
-      var title = splits.shift()
-      var message = splits.join('\n')
-      // compiler.notify(title, '\n' + message, 'error')      
-      // compiler.stop()
-      // setTimeout(function () {
-      //   compiler.stop()
-      // })
       code = 'throw ' + 'new Error(' + JSON.stringify(e.message) + ')' + ';'
-      writeCompiled(code)      
+      writeCompiled(code)
     }
   }
 }

lib/get-compiled-path.js

@@ -3,12 +3,11 @@ var path = require('path')
 var cwd = process.cwd()
 
 module.exports = (code, fileName, compiledDir) => {
-  var hash = crypto.createHash('sha256')
-    .update(fileName + code, 'utf8').digest('hex')
-    fileName = path.relative(cwd, fileName)
-  var hashed =
-    fileName.replace(/[^\w]/g, '_') +
-    '_' + hash +
-    '.js'
+  var hash = crypto
+    .createHash('sha256')
+    .update(fileName + code, 'utf8')
+    .digest('hex')
+  fileName = path.relative(cwd, fileName)
+  var hashed = fileName.replace(/[^\w]/g, '_') + '_' + hash + '.js'
   return path.join(compiledDir, hashed)
-}
+}