flow-remove-types 1.1.2 → 1.2.0

package/README.md

@@ -2,7 +2,7 @@ flow-remove-types
 =================
 
 [![npm](https://img.shields.io/npm/v/flow-remove-types.svg?maxAge=86400)](https://www.npmjs.com/package/flow-remove-types)
-[![Build Status](https://img.shields.io/travis/leebyron/flow-remove-types.svg?style=flat&label=travis&branch=master)](https://travis-ci.org/leebyron/flow-remove-types)
+[![Build Status](https://img.shields.io/travis/flowtype/flow-remove-types.svg?style=flat&label=travis&branch=master)](https://travis-ci.org/flowtype/flow-remove-types)
 
 Turn your JavaScript with [Flow](https://flowtype.org/) type annotations into
 standard JavaScript in an instant with no configuration and minimal setup.
@@ -89,10 +89,6 @@ require('flow-remove-types/register')
 require('./some-module-with-flow-type-syntax')
 ```
 
-As always, don't forget to use `flow-remove-types` to compile files before
-distributing your code on npm, as using the require hook affects the whole
-runtime and not just your module.
-
 You can also provide options to the require hook:
 
 ```js
@@ -100,14 +96,19 @@ You can also provide options to the require hook:
 require('flow-remove-types/register')({ all: true })
 ```
 
-Use options to define exactly which files to `include` or `exclude` with regular
+Use options to define exactly which files to `includes` or `excludes` with regular
 expressions. All files are included by default except those found in the
 `node_modules` folder, which is excluded by default.
 
 ```js
-require('flow-remove-types/register')({ include: /\/custom_path\// })
+require('flow-remove-types/register')({ includes: /\/custom_path\// })
 ```
 
+> #### Don't use the require hook in packages distributed on NPM
+> As always, don't forget to use `flow-remove-types` to compile files before distributing
+> your code on npm, as using the require hook affects the whole runtime and not
+> just your module and may hurt the runtime performance of code that includes it.
+
 
 ## Dead-Simple Transforms
 

package/flow-remove-types

@@ -18,6 +18,7 @@ var usage = 'Usage: flow-remove-types [options] [sources] \n' +
 '  -p, --pretty      Remove flow types without replacing with spaces, \n' +
 '                    producing prettier output but may require using source maps\n' +
 '  -m, --sourcemaps  Also output source map files. Optionally pass "inline"\n' +
+'  -q, --quiet       Does not produce any output concerning successful progress.\n' +
 
 '\nExamples:\n' +
 
@@ -39,11 +40,6 @@ var usage = 'Usage: flow-remove-types [options] [sources] \n' +
 '\nTransform stdin:\n' +
 '  cat input.js | flow-remove-types > output.js\n';
 
-function error(msg) {
-  process.stderr.write('\n\033[31m  ' + msg + '\033[0m\n\n');
-  process.exit(1);
-}
-
 var _memo = {};
 
 function mkdirp(dirpath) {
@@ -79,6 +75,7 @@ var all;
 var pretty;
 var sourceMaps;
 var inlineSourceMaps;
+var quiet;
 var sources = [];
 var i = 2;
 while (i < process.argv.length) {
@@ -107,11 +104,24 @@ while (i < process.argv.length) {
       inlineSourceMaps = true;
       i++;
     }
+  } else if (arg === '-q' || arg === '--quiet') {
+    quiet = true;
   } else {
     sources.push(arg);
   }
 }
 
+function info(msg) {
+  if (!quiet) {
+    process.stderr.write(msg);
+  }
+}
+
+function error(msg) {
+  process.stderr.write('\n\033[31m  ' + msg + '\033[0m\n\n');
+  process.exit(1);
+}
+
 // Validate arguments
 if (outDir && outFile) {
   error('Only specify one of --out-dir or --out-file');
@@ -204,11 +214,11 @@ function transformAndOutput(content, outFile, source) {
 
   if (outFile) {
     fs.writeFileSync(outFile, code);
-    process.stdout.write(fileName + '\n \u21B3 \033[32m' + outFile + '\033[0m\n');
+    info(fileName + '\n \u21B3 \033[32m' + outFile + '\033[0m\n');
     if (sourceMaps && !inlineSourceMaps) {
       var mapOutFile = outFile + '.map';
       fs.writeFileSync(mapOutFile, JSON.stringify(map) + '\n');
-      process.stdout.write('\033[2m \u21B3 \033[32m' + mapOutFile + '\033[0m\n');
+      info('\033[2m \u21B3 \033[32m' + mapOutFile + '\033[0m\n');
     }
   } else {
     process.stdout.write(code);

package/index.js

@@ -69,7 +69,14 @@ module.exports = function flowRemoveTypes(source, options) {
     plugins: [ '*', 'jsx', 'flow' ],
   });
 
-  visit(ast, removedNodes, removeFlowVisitor);
+  var context = {
+    ast: ast,
+    source: source,
+    removedNodes: removedNodes,
+    pretty: Boolean(options && options.pretty)
+  };
+
+  visit(ast, context, removeFlowVisitor);
 
   return resultPrinter(options, source, removedNodes);
 }
@@ -139,39 +146,56 @@ var removeFlowVisitor = {
   ClassDeclaration: removeImplementedInterfaces,
   ClassExpression: removeImplementedInterfaces,
 
-  Identifier: function (removedNodes, node, ast) {
+  Identifier: function (context, node, ast) {
     if (node.optional) {
       // Find the optional token.
       var idx = findTokenIndex(ast.tokens, node.start);
       do {
         idx++;
       } while (ast.tokens[idx].type.label !== '?');
-      removeNode(removedNodes, ast.tokens[idx]);
+      removeNode(context, ast.tokens[idx]);
     }
   },
 
-  ClassProperty: function (removedNodes, node) {
+  ClassProperty: function (context, node) {
     if (!node.value) {
-      return removeNode(removedNodes, node)
+      return removeNode(context, node)
     }
   },
 
-  ExportNamedDeclaration: function (removedNodes, node) {
-    if (node.exportKind === 'type') {
-      return removeNode(removedNodes, node);
+  ExportNamedDeclaration: function (context, node) {
+    if (node.exportKind === 'type' || node.exportKind === 'typeof') {
+      return removeNode(context, node);
     }
   },
 
-  ImportDeclaration: function (removedNodes, node) {
-    if (node.importKind === 'type') {
-      return removeNode(removedNodes, node);
+  ImportDeclaration: function (context, node) {
+    if (node.importKind === 'type' || node.importKind === 'typeof') {
+      return removeNode(context, node);
+    }
+  },
+
+  ImportSpecifier: function(context, node) {
+    if (node.importKind === 'type' || node.importKind === 'typeof') {
+      removeNode(context, node);
+
+      // Remove trailing comma
+      var ast = context.ast;
+      var idx = findTokenIndex(ast.tokens, node.end);
+      while (isComment(ast.tokens[idx])) {
+        idx++;
+      }
+      if (ast.tokens[idx].type.label === ',') {
+        removeNode(context, ast.tokens[idx]);
+      }
+      return false;
     }
   }
 };
 
 // If this class declaration or expression implements interfaces, remove
 // the associated tokens.
-function removeImplementedInterfaces(removedNodes, node, ast) {
+function removeImplementedInterfaces(context, node, ast) {
   if (node.implements && node.implements.length > 0) {
     var first = node.implements[0];
     var last = node.implements[node.implements.length - 1];
@@ -182,9 +206,8 @@ function removeImplementedInterfaces(removedNodes, node, ast) {
 
     var lastIdx = findTokenIndex(ast.tokens, last.start);
     do {
-      if (ast.tokens[idx].type !== 'CommentBlock' &&
-          ast.tokens[idx].type !== 'CommentLine') {
-        removeNode(removedNodes, ast.tokens[idx]);
+      if (!isComment(ast.tokens[idx])) {
+        removeNode(context, ast.tokens[idx]);
       }
     } while (idx++ !== lastIdx);
   }
@@ -192,17 +215,131 @@ function removeImplementedInterfaces(removedNodes, node, ast) {
 
 // Append node to the list of removed nodes, ensuring the order of the nodes
 // in the list.
-function removeNode(removedNodes, node) {
+function removeNode(context, node) {
+  var removedNodes = context.removedNodes;
   var length = removedNodes.length;
   var index = length;
+
+  // Check for line's leading and trailing space to be removed.
+  var spaceNode = context.pretty ? getLeadingSpaceNode(context, node) : null;
+  var lineNode = context.pretty ? getTrailingLineNode(context, node) : null;
+
   while (index > 0 && removedNodes[index - 1].end > node.start) {
     index--;
   }
+
   if (index === length) {
+    if (spaceNode) {
+      removedNodes.push(spaceNode);
+    }
     removedNodes.push(node);
+    if (lineNode) {
+      removedNodes.push(lineNode);
+    }
   } else {
-    removedNodes.splice(index, 0, node);
+    if (lineNode) {
+      if (spaceNode) {
+        removedNodes.splice(index, 0, spaceNode, node, lineNode);
+      } else {
+        removedNodes.splice(index, 0, node, lineNode);
+      }
+    } else if (spaceNode) {
+      removedNodes.splice(index, 0, spaceNode, node);
+    } else {
+      removedNodes.splice(index, 0, node);
+    }
   }
+
+  return false;
+}
+
+function getLeadingSpaceNode(context, node) {
+  var source = context.source;
+  var end = node.start;
+  var start = end;
+  while (source[start - 1] === ' ' || source[start - 1] === '\t') {
+    start--;
+  }
+  if (start !== end) {
+    return {
+      start: start,
+      end: end,
+      loc: { start: node.loc.start, end: node.loc.start }
+    };
+  }
+}
+
+function getTrailingLineNode(context, node) {
+  var source = context.source;
+  var start = node.end;
+  var end = start;
+  while (source[end] === ' ' || source[end] === '\t') {
+    end++;
+  }
+
+  // Remove all space including the line break if this token was alone on the line.
+  if (source[end] === '\n' || source[end] === '\r') {
+    if (source[end] === '\r' && source[end + 1] === '\n') {
+      end++;
+    }
+    end++;
+
+    if (isLastNodeRemovedFromLine(context, node)) {
+      return {
+        start: start,
+        end: end,
+        loc: { start: node.loc.end, end: node.loc.end }
+      };
+    }
+  }
+}
+
+// Returns true if node is the last to be removed from a line.
+function isLastNodeRemovedFromLine(context, node) {
+  var tokens = context.ast.tokens;
+  var priorTokenIdx = findTokenIndex(tokens, node.start) - 1;
+  var token = tokens[priorTokenIdx];
+  var line = node.loc.end.line;
+
+  // Find previous token that was not removed on the same line.
+  while (priorTokenIdx >= 0 &&
+         token.loc.end.line === line &&
+         isRemovedToken(context, token)) {
+    token = tokens[--priorTokenIdx]
+  }
+
+  // If there's no prior token (start of file), or the prior token is on another
+  // line, this line must be fully removed.
+  return !token || token.loc.end.line !== line;
+}
+
+// Returns true if the provided token was previously marked as removed.
+function isRemovedToken(context, token) {
+  var removedNodes = context.removedNodes;
+  var nodeIdx = removedNodes.length - 1;
+
+  // Find the last removed node which could possibly contain this token.
+  while (nodeIdx >= 0 && removedNodes[nodeIdx].start > token.start) {
+    nodeIdx--;
+  }
+
+  var node = removedNodes[nodeIdx];
+
+  // This token couldn't be removed if not contained within the removed node.
+  if (nodeIdx === -1 || node.end < token.end) {
+    return false;
+  }
+
+  // Iterate through the tokens contained by the removed node to find a match.
+  var tokens = context.ast.tokens;
+  var tokenIdx = findTokenIndex(tokens, node.start);
+  while (tokens[tokenIdx].end <= node.end) {
+    if (token === tokens[tokenIdx]) {
+      return true;
+    }
+    tokenIdx++;
+  }
+
   return false;
 }
 
@@ -260,6 +397,11 @@ function findTokenIndex(tokens, offset) {
   return ptr;
 }
 
+// True if the provided token is a comment.
+function isComment(token) {
+  return token.type === 'CommentBlock' || token.type === 'CommentLine';
+}
+
 // Produce a string full of space characters of a given size.
 function space(size) {
   var sp = ' '
@@ -282,6 +424,10 @@ function space(size) {
 // with spaces.
 function generateSourceMappings(removedNodes) {
   var mappings = '';
+  if (!removedNodes || removedNodes.length === '') {
+    return mappings;
+  }
+
   var end = { line: 1, column: 0 };
 
   for (var i = 0; i < removedNodes.length; i++) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "flow-remove-types",
-  "version": "1.1.2",
+  "version": "1.2.0",
   "description": "Removes Flow type annotations from JavaScript files with speed and simplicity.",
   "author": "Lee Byron <lee@leebyron.com> (http://leebyron.com/)",
   "license": "BSD-3-Clause",
@@ -17,13 +17,13 @@
     "LICENSE",
     "PATENTS"
   ],
-  "homepage": "https://github.com/leebyron/flow-remove-types",
+  "homepage": "https://github.com/flowtype/flow-remove-types",
   "bugs": {
-    "url": "https://github.com/leebyron/flow-remove-types/issues"
+    "url": "https://github.com/flowtype/flow-remove-types/issues"
   },
   "repository": {
     "type": "git",
-    "url": "http://github.com/leebyron/flow-remove-types.git"
+    "url": "http://github.com/flowtype/flow-remove-types.git"
   },
   "scripts": {
     "test": "./test.sh",
@@ -38,7 +38,7 @@
     "es6"
   ],
   "dependencies": {
-    "babylon": "^6.8.4",
+    "babylon": "^6.15.0",
     "vlq": "^0.2.1"
   }
 }

package/register.js

@@ -3,9 +3,11 @@ var flowRemoveTypes = require('./index');
 // Supported options:
 //
 //   - all: Transform all files, not just those with a @flow comment.
-//   - includes: A Regexp to determine which files should be transformed.
-//   - excludes: A Regexp to determine which files should not be transformed,
-//               defaults to ignoring /node_modules/, set to null to excludes nothing.
+//   - includes: A Regexp/String to determine which files should be transformed.
+//               (alias: include)
+//   - excludes: A Regexp/String to determine which files should not be
+//               transformed, defaults to ignoring /node_modules/, provide null
+//               to exclude nothing. (alias: exclude)
 var options;
 module.exports = function setOptions(newOptions) {
   options = newOptions;
@@ -32,7 +34,33 @@ exts.forEach(function (ext) {
 });
 
 function shouldTransform(filename, options) {
-  var includes = options && options.includes;
-  var excludes = options && 'excludes' in options ? options.excludes : /\/node_modules\//;
-  return (!includes || include.test(filename)) && !(excludes && excludes.test(filename));
+  var includes = options && regexpPattern(options.includes || options.include);
+  var excludes =
+    options && 'excludes' in options ? regexpPattern(options.excludes) :
+    options && 'exclude' in options ? regexpPattern(options.exclude) :
+    /\/node_modules\//;
+  return (!includes || includes.test(filename)) && !(excludes && excludes.test(filename));
+}
+
+// Given a null | string | RegExp | any, returns null | Regexp or throws a
+// more helpful error.
+function regexpPattern(pattern) {
+  if (!pattern) {
+    return pattern;
+  }
+  // A very simplified glob transform which allows passing legible strings like
+  // "myPath/*.js" instead of a harder to read RegExp like /\/myPath\/.*\.js/.
+  if (typeof pattern === 'string') {
+    pattern = pattern.replace(/\./g, '\\.').replace(/\*/g, '.*');
+    if (pattern[0] !== '/') {
+      pattern = '/' + pattern;
+    }
+    return new RegExp(pattern);
+  }
+  if (typeof pattern.test === 'function') {
+    return pattern;
+  }
+  throw new Error(
+    'flow-remove-types: includes and excludes must be RegExp or path strings. Got: ' + pattern
+  );
 }