[enhance] Allow passing of glob config

Author: adamreisnz

README.md

@@ -29,6 +29,7 @@ A simple utility to quickly replace text in one or more files or globs. Works sy
   - [Ignore multiple files or globs](#ignore-multiple-files-or-globs)
   - [Allow empty/invalid paths](#allow-emptyinvalid-paths)
   - [Disable globs](#disable-globs)
+  - [Specify glob configuration](#glob-configuration)
   - [Specify character encoding](#specify-character-encoding)
   - [Dry run](#dry-run)
 - [CLI usage](#cli-usage)
@@ -263,6 +264,19 @@ const options = {
 };
 ```
 
+### Specify glob configuration
+Specify configuration passed to the `glob` call:
+
+```js
+const options = {
+  glob: {
+    //Glob settings here
+  },
+};
+```
+
+Please note that the setting `nodir` will always be passed as `false`.
+
 ### Specify character encoding
 Use a different character encoding for reading/writing files. Defaults to `utf-8`.
 

lib/helpers/get-paths-async.js

@@ -9,7 +9,7 @@ const globAsync = require('./glob-async');
  * Get paths asynchrously
  */
 module.exports = function getPathsAsync(
-  patterns, ignore, disableGlobs, allowEmptyPaths
+  patterns, ignore, disableGlobs, allowEmptyPaths, cfg
 ) {
 
   //Not using globs?
@@ -19,6 +19,7 @@ module.exports = function getPathsAsync(
 
   //Expand globs and flatten paths
   return Promise
-    .all(patterns.map(pattern => globAsync(pattern, ignore, allowEmptyPaths)))
+    .all(patterns
+      .map(pattern => globAsync(pattern, ignore, allowEmptyPaths, cfg)))
     .then(paths => [].concat.apply([], paths));
 };

lib/helpers/get-paths-sync.js

@@ -8,16 +8,19 @@ const glob = require('glob');
 /**
  * Get paths (sync)
  */
-module.exports = function getPathsSync(patterns, ignore, disableGlobs) {
+module.exports = function getPathsSync(patterns, ignore, disableGlobs, cfg) {
 
   //Not using globs?
   if (disableGlobs) {
     return patterns;
   }
 
+  //Prepare glob config
+  cfg = Object.assign({ignore}, cfg, {nodir: true});
+
   //Get paths
   const paths = patterns
-    .map(pattern => glob.sync(pattern, {ignore, nodir: true}));
+    .map(pattern => glob.sync(pattern, cfg));
 
   //Return flattened
   return [].concat.apply([], paths);

lib/helpers/glob-async.js

@@ -8,9 +8,14 @@ const glob = require('glob');
 /**
  * Async wrapper for glob
  */
-module.exports = function globAsync(pattern, ignore, allowEmptyPaths) {
+module.exports = function globAsync(pattern, ignore, allowEmptyPaths, cfg) {
+
+  //Prepare glob config
+  cfg = Object.assign({ignore}, cfg, {nodir: true});
+
+  //Return promise
   return new Promise((resolve, reject) => {
-    glob(pattern, {ignore, nodir: true}, (error, files) => {
+    glob(pattern, cfg, (error, files) => {
 
       //istanbul ignore if: hard to make glob error
       if (error) {

lib/helpers/parse-config.js

@@ -11,6 +11,7 @@ const defaults = {
   isRegex: false,
   verbose: false,
   dry: false,
+  glob: {},
 };
 
 /**
@@ -23,8 +24,11 @@ module.exports = function parseConfig(config) {
     throw new Error('Must specify configuration object');
   }
 
+  //Fix glob
+  config.glob = config.glob || {};
+
   //Extract data
-  const {files, from, to, ignore, encoding} = config;
+  const {files, from, to, ignore, encoding, glob} = config;
 
   //Validate values
   if (typeof files === 'undefined') {
@@ -36,6 +40,9 @@ module.exports = function parseConfig(config) {
   if (typeof to === 'undefined') {
     throw new Error('Must specify a replacement (can be blank string)');
   }
+  if (typeof glob !== 'object') {
+    throw new Error('Invalid glob config');
+  }
 
   //Ensure arrays
   if (!Array.isArray(files)) {

lib/replace-in-file.js

@@ -29,16 +29,17 @@ function replaceInFile(config, cb) {
   //Get config
   const {
     files, from, to, encoding, ignore, allowEmptyPaths, disableGlobs,
-    dry, verbose,
+    dry, verbose, glob,
   } = config;
 
   //Dry run?
+  //istanbul ignore if: No need to test console logs
   if (dry && verbose) {
     console.log(chalk.yellow('Dry run, not making actual changes'));
   }
 
   //Find paths
-  return getPathsAsync(files, ignore, disableGlobs, allowEmptyPaths)
+  return getPathsAsync(files, ignore, disableGlobs, allowEmptyPaths, glob)
 
     //Make replacements
     .then(paths => Promise.all(paths.map(file => {
@@ -81,12 +82,13 @@ replaceInFile.sync = function(config) {
 
   //Get config, paths, and initialize changed files
   const {
-    files, from, to, encoding, ignore, disableGlobs, dry, verbose,
+    files, from, to, encoding, ignore, disableGlobs, dry, verbose, glob,
   } = config;
-  const paths = getPathsSync(files, ignore, disableGlobs);
+  const paths = getPathsSync(files, ignore, disableGlobs, glob);
   const changedFiles = [];
 
   //Dry run?
+  //istanbul ignore if: No need to test console logs
   if (dry && verbose) {
     console.log(chalk.yellow('Dry run, not making any changes'));
   }

lib/replace-in-file.spec.js

@@ -68,6 +68,15 @@ describe('Replace in file', () => {
       })).to.eventually.be.rejectedWith(Error);
     });
 
+    it('should throw an error when invalid `glob` config defined', () => {
+      return expect(replace({
+        files: 'test1',
+        from: /re\splace/g,
+        to: 'test',
+        glob: 'invalid',
+      })).to.eventually.be.rejectedWith(Error);
+    });
+
     it('should replace contents in a single file with regex', done => {
       replace({
         files: 'test1',
@@ -89,7 +98,7 @@ describe('Replace in file', () => {
           expect(file).to.equal('test1');
           return /re\splace/g;
         },
-        to: 'b'
+        to: 'b',
       }).then(() => {
         const test1 = fs.readFileSync('test1', 'utf8');
         const test2 = fs.readFileSync('test2', 'utf8');
@@ -344,6 +353,35 @@ describe('Replace in file', () => {
         done();
       });
     });
+
+    it('should accept glob configuration', done => {
+      replace({
+        files: 'test1',
+        from: /re\splace/g,
+        to: 'b',
+        allowEmptyPaths: true,
+        glob: {
+          ignore: ['test1'],
+        },
+      }).then(() => {
+        const test1 = fs.readFileSync('test1', 'utf8');
+        expect(test1).to.equal('a re place c');
+        done();
+      });
+    });
+
+    it('should ignore empty glob configuration', done => {
+      replace({
+        files: 'test1',
+        from: /re\splace/g,
+        to: 'b',
+        glob: null,
+      }).then(() => {
+        const test1 = fs.readFileSync('test1', 'utf8');
+        expect(test1).to.equal('a b c');
+        done();
+      });
+    });
   });
 
   /**
@@ -416,7 +454,7 @@ describe('Replace in file', () => {
           expect(file).to.equal('test1');
           return /re\splace/g;
         },
-        to: 'b'
+        to: 'b',
       }, () => {
         const test1 = fs.readFileSync('test1', 'utf8');
         const test2 = fs.readFileSync('test2', 'utf8');
@@ -749,7 +787,7 @@ describe('Replace in file', () => {
           expect(file).to.equal('test1');
           return /re\splace/g;
         },
-        to: 'b'
+        to: 'b',
       });
       const test1 = fs.readFileSync('test1', 'utf8');
       const test2 = fs.readFileSync('test2', 'utf8');

package.json

@@ -31,7 +31,7 @@
     "coverage": "open -a \"Google Chrome\" ./coverage/lcov-report/index.html"
   },
   "dependencies": {
-    "chalk": "^2.3.0",
+    "chalk": "^2.3.2",
     "glob": "^7.1.2",
     "yargs": "^11.0.0"
   },
@@ -43,7 +43,7 @@
     "chai-as-promised": "^7.1.1",
     "dirty-chai": "^2.0.1",
     "istanbul": "^1.0.0-alpha.2",
-    "mocha": "^5.0.0"
+    "mocha": "^5.0.4"
   },
   "browserify": {
     "transform": [