Can ignore paths before jscodeshift runs

chrisdarroch · fkling · commit 5d58f4170394 · 2016-04-23T22:16:00.000-07:00
diff --git a/bin/__tests__/jscodeshift-test.js b/bin/__tests__/jscodeshift-test.js
@@ -20,6 +20,7 @@ var child_process = require('child_process');
 var fs = require('fs');
 var path = require('path');
 var temp = require('temp');
+var mkdirp = require('mkdirp');
 require('es6-promise').polyfill();
 
 function run(args, stdin, cwd) {
@@ -44,11 +45,23 @@ function run(args, stdin, cwd) {
 }
 
 describe('jscodeshift CLI', () => {
-  function createTempFileWith(content) {
+  function createTempFileWith(content, filename) {
     var info = temp.openSync();
+    var filePath = info.path;
     fs.writeSync(info.fd, content);
     fs.closeSync(info.fd);
-    return info.path;
+    if (filename) {
+      filePath = renameFileTo(filePath, filename);
+    }
+    return filePath;
+  }
+
+  function renameFileTo(oldPath, newFilename) {
+    var projectPath = path.dirname(oldPath);
+    var newPath = path.join(projectPath, newFilename);
+    mkdirp.sync(path.dirname(newPath));
+    fs.renameSync(oldPath, newPath);
+    return newPath;
   }
 
   function createTransformWith(content) {
@@ -120,13 +133,8 @@ describe('jscodeshift CLI', () => {
     var transform = createTransformWith(
       'return (function() { "use strict"; const a = 42; }).toString();'
     );
-    var babelrc = createTempFileWith(`{"ignore": ["${transform}"]}`);
-    //var babelrc = createTempFileWith('{}');
-    var projectPath = path.dirname(babelrc);
-    fs.renameSync(babelrc, path.join(projectPath, '.babelrc'));
-    var source = createTempFileWith('a');
-    fs.renameSync(source, path.join(projectPath, 'source.js'));
-    source = path.join(projectPath, 'source.js');
+    var babelrc = createTempFileWith(`{"ignore": ["${transform}"]}`, '.babelrc');
+    var source = createTempFileWith('a', 'source.js');
 
     return run(['-t', transform, source]).then(
       ([stdout, stderr]) => {
@@ -174,6 +182,79 @@ describe('jscodeshift CLI', () => {
     );
   });
 
+  describe('ignoring', () => {
+    var transform = createTransformWith(
+      'return "transform" + fileInfo.source;'
+    );
+    var sources = [];
+
+    beforeEach(() => {
+      sources = [];
+      sources.push(createTempFileWith('a', 'a.js'));
+      sources.push(createTempFileWith('a', 'a-test.js'));
+      // sources.push(createTempFileWith('b', 'src/lib/b.js'));
+    });
+
+    pit('supports basic glob', () => {
+      var pattern = '*-test.js';
+      return run(['-t', transform, '--ignore-pattern', pattern, ...sources]).then(
+        ([stdout, stderr]) => {
+          expect(fs.readFileSync(sources[0]).toString()).toBe('transforma');
+          expect(fs.readFileSync(sources[1]).toString()).toBe('a');
+        }
+      );
+    });
+
+    pit('supports filename match', () => {
+      var pattern = 'a.js';
+      return run(['-t', transform, '--ignore-pattern', pattern, ...sources]).then(
+        ([stdout, stderr]) => {
+          expect(fs.readFileSync(sources[0]).toString()).toBe('a');
+          expect(fs.readFileSync(sources[1]).toString()).toBe('transforma');
+        }
+      );
+    });
+
+    pit('accepts a list of patterns', () => {
+      var patterns = ['--ignore-pattern', 'a.js', '--ignore-pattern', '*-test.js'];
+      return run(['-t', transform, ...patterns, ...sources]).then(
+        ([stdout, stderr]) => {
+          expect(fs.readFileSync(sources[0]).toString()).toBe('a');
+          expect(fs.readFileSync(sources[1]).toString()).toBe('a');
+        }
+      );
+    });
+
+    pit('sources ignore patterns from configuration file', () => {
+      var patterns = ['sub/dir/', '*-test.js'];
+      var gitignore = createTempFileWith(patterns.join('\n'), '.gitignore');
+      sources.push(createTempFileWith('subfile', 'sub/dir/file.js'));
+
+      return run(['-t', transform, '--ignore-config', gitignore, ...sources]).then(
+        ([stdout, stderr]) => {
+          expect(fs.readFileSync(sources[0]).toString()).toBe('transforma');
+          expect(fs.readFileSync(sources[1]).toString()).toBe('a');
+          expect(fs.readFileSync(sources[2]).toString()).toBe('subfile');
+        }
+      );
+    });
+
+    pit('accepts a list of configuration files', () => {
+      var gitignore = createTempFileWith(['sub/dir/'].join('\n'), '.gitignore');
+      var eslintignore = createTempFileWith(['**/*test.js', 'a.js'].join('\n'), '.eslintignore');
+      var configs = ['--ignore-config', gitignore, '--ignore-config', eslintignore];
+      sources.push(createTempFileWith('subfile', 'sub/dir/file.js'));
+
+      return run(['-t', transform, ...configs, ...sources]).then(
+        ([stdout, stderr]) => {
+          expect(fs.readFileSync(sources[0]).toString()).toBe('a');
+          expect(fs.readFileSync(sources[1]).toString()).toBe('a');
+          expect(fs.readFileSync(sources[2]).toString()).toBe('subfile');
+        }
+      );
+    });
+  });
+
   describe('output', () => {
     pit('shows workers info and stats at the end by default', () => {
       var source = createTempFileWith('a');
diff --git a/bin/jscodeshift.sh b/bin/jscodeshift.sh
@@ -59,6 +59,17 @@ var opts = require('nomnom')
       default: 'js',
       help: 'File extensions the transform file should be applied to'
     },
+    ignorePattern: {
+      full: 'ignore-pattern',
+      list: true,
+      help: 'Ignore files that match a provided glob expression'
+    },
+    ignoreConfig: {
+      full: 'ignore-config',
+      list: true,
+      help: 'Ignore files if they match patterns sourced from a configuration file (e.g., a .gitignore)',
+      metavar: 'FILE'
+    },
     runInBand: {
       flag: true,
       default: false,
diff --git a/package.json b/package.json
@@ -30,6 +30,7 @@
     "colors": "^1.1.2",
     "es6-promise": "^3.0.0",
     "lodash": "^3.5.0",
+    "micromatch": "^2.3.7",
     "node-dir": "0.1.8",
     "nomnom": "^1.8.1",
     "recast": "^0.11.0",
@@ -38,7 +39,8 @@
   "devDependencies": {
     "babel": "^5.6.14",
     "babel-jest": "^5.3.0",
-    "jest-cli": "^0.9.0"
+    "jest-cli": "^0.9.0",
+    "mkdirp": "^0.5.1"
   },
   "jest": {
     "scriptPreprocessor": "<rootDir>/node_modules/babel-jest",
diff --git a/src/Runner.js b/src/Runner.js
@@ -19,6 +19,7 @@ const path = require('path');
 const http = require('http');
 const https = require('https');
 const temp = require('temp');
+const ignores = require('./ignoreFiles');
 
 const availableCpus = require('os').cpus().length - 1;
 const CHUNK_SIZE = 50;
@@ -86,6 +87,9 @@ function dirFiles (dir, callback, acc) {
             'Skipping path "' + name + '" which does not exist.\n'
           );
           done();
+        } else if (ignores.shouldIgnore(name)) {
+          // ignore the path
+          done();
         } else if (stats.isDirectory()) {
           dirFiles(name + '/', callback, acc);
         } else {
@@ -113,6 +117,9 @@ function getAllFiles(paths, filter) {
             file,
             list => resolve(list.filter(filter))
           );
+        } else if (ignores.shouldIgnore(file)) {
+          // ignoring the file
+          resolve([]);
         } else {
           resolve([file]);
         }
@@ -130,6 +137,9 @@ function run(transformFile, paths, options) {
   const statsCounter = {};
   const startTime = process.hrtime();
 
+  ignores.add(options.ignorePattern);
+  ignores.addFromFile(options.ignoreConfig);
+
   if (/^http/.test(transformFile)) {
     usedRemoteScript = true;
     return new Promise((resolve, reject) => {
diff --git a/src/ignoreFiles.js b/src/ignoreFiles.js
@@ -0,0 +1,68 @@
+'use strict';
+
+const fs = require('fs');
+const mm = require('micromatch');
+
+const matchers = [];
+
+/**
+ * Add glob patterns to ignore matched files and folders.
+ * Creates glob patterns to approximate gitignore patterns.
+ * @param {String} val - the glob or gitignore-style pattern to ignore
+ * @see {@linkplain https://git-scm.com/docs/gitignore#_pattern_format}
+ */
+function addIgnorePattern(val) {
+  if (val && typeof val === 'string') {
+    let pattern = val;
+    if (pattern.indexOf('/') === -1) {
+      matchers.push('**/' + pattern);
+    } else if (pattern[pattern.length-1] === '/') {
+      matchers.push('**/' + pattern + '**');
+      matchers.push(pattern + '**');
+    }
+    matchers.push(pattern);
+  }
+}
+
+/**
+ * Adds ignore patterns directly from function input
+ * @param {String|Array<String>} input - the ignore patterns
+ */
+function addIgnoreFromInput(input) {
+  let patterns = [];
+  if (input) {
+    patterns = patterns.concat(input);
+  }
+  patterns.forEach(addIgnorePattern);
+}
+
+/**
+ * Adds ignore patterns by reading files
+ * @param {String|Array<String>} input - the paths to the ignore config files
+ */
+function addIgnoreFromFile(input) {
+  let lines = [];
+  let files = [];
+  if (input) {
+    files = files.concat(input);
+  }
+
+  files.forEach(function(config) {
+    var stats = fs.statSync(config);
+    if (stats.isFile()) {
+      var content = fs.readFileSync(config, 'utf8');
+      lines = lines.concat(content.split('\n'));
+    }
+  });
+
+  lines.forEach(addIgnorePattern);
+}
+
+function shouldIgnore(path) {
+  var matched = matchers.length ? mm.any(path, matchers, { dot:true }) : false;
+  return matched;
+}
+
+exports.add = addIgnoreFromInput;
+exports.addFromFile = addIgnoreFromFile;
+exports.shouldIgnore = shouldIgnore;
