Add support for globs (#4)

Author: boneskull

api.js

@@ -5,13 +5,14 @@ const fs = require('fs');
 const writeFileAtomic = require('write-file-atomic');
 const escapeStringRegexp = require('escape-string-regexp');
 const arrify = require('arrify');
+const globby = require('globby');
 
 const readFile = promisify(fs.readFile);
 
 // TODO(sindresorhus): I will extract this to a separate module at some point when it's more mature.
 // `find` is expected to be `Array<string | RegExp>`
 // The `ignoreCase` option overrides the `i` flag for regexes in `find`
-module.exports = async (filePaths, {find, replacement, ignoreCase} = {}) => {
+module.exports = async (filePaths, {find, replacement, ignoreCase, glob} = {}) => {
 	filePaths = arrify(filePaths);
 
 	if (filePaths.length === 0) {
@@ -32,8 +33,7 @@ module.exports = async (filePaths, {find, replacement, ignoreCase} = {}) => {
 		.replace(/\\r/g, '\r')
 		.replace(/\\t/g, '\t');
 
-	// Deduplicate
-	filePaths = [...new Set(filePaths.map(filePath => path.resolve(filePath)))];
+	filePaths = glob ? await globby(filePaths) : [...new Set(filePaths.map(filePath => path.resolve(filePath)))];
 
 	find = find.map(element => {
 		const iFlag = ignoreCase ? 'i' : '';

cli.js

@@ -13,10 +13,12 @@ const cli = meow(`
 	  --string          String to find  (Can be set multiple times)
 	  --replacement     Replacement string  (Required)
 	  --ignore-case     Search case-insensitively
+	  --no-glob         Disable globbing
 
 	Examples
 	  $ replace-in-files --string='horse' --regex='unicorn|rainbow' --replacement='🦄' foo.md
 	  $ replace-in-files --regex='v\\d+\\.\\d+\\.\\d+' --replacement=v$npm_package_version foo.css
+	  $ replace-in-files --string='blob' --replacement='blog' 'some/**/[gb]lob/*' '!some/glob/foo'
 
 	You can use the same replacement patterns as with \`String#replace()\`, like \`$&\`.
 `, {
@@ -33,6 +35,10 @@ const cli = meow(`
 		ignoreCase: {
 			type: 'boolean',
 			default: false
+		},
+		glob: {
+			type: 'boolean',
+			default: true
 		}
 	}
 });
@@ -60,6 +66,7 @@ if (cli.flags.replacement === undefined) {
 			...arrify(cli.flags.regex).map(regexString => new RegExp(regexString, 'g'))
 		],
 		replacement: cli.flags.replacement,
-		ignoreCase: cli.flags.ignoreCase
+		ignoreCase: cli.flags.ignoreCase,
+		glob: cli.flags.glob
 	});
 })();

package.json

@@ -43,6 +43,7 @@
 	"dependencies": {
 		"arrify": "^2.0.1",
 		"escape-string-regexp": "^2.0.0",
+		"globby": "^10.0.1",
 		"meow": "^5.0.0",
 		"write-file-atomic": "^3.0.0"
 	},

readme.md

@@ -23,10 +23,12 @@ $ replace-in-files --help
     --string          String to find  (Can be set multiple times)
     --replacement     Replacement string  (Required)
     --ignore-case     Search case-insensitively
+    --no-glob         Disable globbing
 
   Examples
     $ replace-in-files --string='horse' --regex='unicorn|rainbow' --replacement='🦄' foo.md
     $ replace-in-files --regex='v\d+\.\d+\.\d+' --replacement=v$npm_package_version foo.css
+    $ replace-in-files --string='blob' --replacement='blog' 'some/**/[gb]lob/*' '!some/glob/foo'
 
   You can use the same replacement patterns as with `String#replace()`, like `$&`.
 ```

test.js

@@ -1,4 +1,6 @@
 import fs from 'fs';
+import os from 'os';
+import path from 'path';
 import test from 'ava';
 import execa from 'execa';
 import tempWrite from 'temp-write';
@@ -34,3 +36,31 @@ test('multiple newlines and tabs', async t => {
 	await execa('./cli.js', ['--string=,', '--replacement=\\n\\n\\t\\r', filePath]);
 	t.is(fs.readFileSync(filePath, 'utf8'), 'a\n\n\t\rb\n\n\t\rc');
 });
+
+test('globs', async t => {
+	const filePaths = [await tempWrite('foo bar foo', 'a.glob'), await tempWrite('foo bar foo', 'b.glob')];
+	const tmpdir = os.tmpdir();
+
+	await execa('./cli.js', ['--string=bar', '--replacement=foo', path.join(tmpdir, '*', '*.glob')]);
+	t.is(fs.readFileSync(filePaths[0], 'utf8'), 'foo foo foo');
+	t.is(fs.readFileSync(filePaths[1], 'utf8'), 'foo foo foo');
+});
+
+test('no globs', async t => {
+	const filePaths = [await tempWrite('foo bar foo', '*.glob'), await tempWrite('foo bar foo', 'foo.glob')];
+	const dirnames = filePaths.map(filePath => path.dirname(filePath));
+
+	await t.throwsAsync(
+		execa('./cli.js', [
+			'--string=bar',
+			'--replacement=foo',
+			'--no-glob',
+			path.join(dirnames[0], '*.glob'),
+			path.join(dirnames[1], '*.glob')
+		]),
+		{
+			code: 1,
+			message: /ENOENT/
+		}
+	);
+});