feat: add replaceSeparatorsForGlob utility

README.md

@@ -581,6 +581,16 @@ Clear the regex cache.
 mm.clearCache();
 ```
 
+### [.replaceSeparatorsForGlob](index.js#L871)
+
+Replaces backslashes used as path separators with forward slashes. This is useful on Windows when using `path.join` et.al. See [Backslashes](#backslashes).
+
+**Example**
+
+```js
+var reaplcedPath = mm.replaceSeparatorsForGlob(path.join(rootDir, 'other/path/**'));
+```
+
 ## Options
 
 * [basename](#optionsbasename)
@@ -945,6 +955,8 @@ We made this decision for micromatch for a couple of reasons:
 * consistency with bash conventions.
 * glob patterns are not filepaths. They are a type of [regular language](https://en.wikipedia.org/wiki/Regular_language) that is converted to a JavaScript regular expression. Thus, when forward slashes are defined in a glob pattern, the resulting regular expression will match windows or POSIX path separators just fine.
 
+You can use `.replaceSeparatorsForGlob` to replace backslashes used as path separators.
+
 **A note about joining paths to globs**
 
 Note that when you pass something like `path.join('foo', '*')` to micromatch, you are creating a filepath and expecting it to still work as a glob pattern. This causes problems on windows, since the `path.sep` is `\\`.

index.js

@@ -869,6 +869,19 @@ micromatch.compilers = compilers;
 micromatch.parsers = parsers;
 micromatch.caches = cache.caches;
 
+/**
+ * Replace backslashes used as path separator with forward slashes.
+ * This is useful when doing `path.resolve` etc. in Windows.
+ */
+
+micromatch.replaceSeparatorsForGlob = function(path) {
+ if (typeof path !== 'string') {
+ throw new TypeError('expected a string: "' + util.inspect(path) + '"');
+ }
+
+ return path.replace(/\\(?![{}()+?.^$])/g, '/');
+};
+
 /**
  * Expose `micromatch`
  * @type {Function}

package.json

@@ -18,7 +18,8 @@
  "Tom Byrer (https://github.com/tomByrer)",
  "Tyler Akins (http://rumkin.com)",
  "(https://github.com/DianeLooney)",
- "Tvrqvoise (https://github.com/tvrqvoise)"
+ "Tvrqvoise (https://github.com/tvrqvoise)",
+ "Simen Bekkhus (https://github.com/SimenB)"
  ],
  "repository": "micromatch/micromatch",
  "bugs": {

test/api.replaceSeparatorsForGlob.js

@@ -0,0 +1,20 @@
+'use strict';
+
+var assert = require('assert');
+var mm = require('..');
+
+describe('.replaceSeparatorsForGlob()', function() {
+ it('should throw an error when value is not a string', function() {
+ assert.throws(function() {
+ mm.replaceSeparatorsForGlob();
+ });
+ });
+
+ it('should replace backslashes', function() {
+ assert.equal(mm.replaceSeparatorsForGlob('/some/path\\with\\backslashes'), '/some/path/with/backslashes');
+ });
+
+ it('should not replace backslashes when they are escaped characters', function() {
+ assert.equal(mm.replaceSeparatorsForGlob('/some/path\\with\\backslashes/and\\(parens\\)'), '/some/path/with/backslashes/and\\(parens\\)');
+ });
+});