provide picomatch/posix, documentation

Author: acao

README.md

@@ -118,6 +118,8 @@ Creates a matcher function from one or more glob patterns. The returned function
 
 **Example**
 
+By default, `picomatch` uses [`os.platform()`](https://nodejs.org/api/os.html#osplatform) to detect the operating system.
+
 ```js
 const picomatch = require('picomatch');
 // picomatch(glob[, options]);
@@ -127,6 +129,23 @@ console.log(isMatch('a.a')); //=> false
 console.log(isMatch('a.b')); //=> true
 ```
 
+**Example without node.js**
+
+For environments without `node.js`, `picomatch/posix` provides you a dependency-free matcher, without automatic OS detection.
+
+```js
+const picomatch = require('picomatch/posix');
+// the same API, defaulting to posix paths
+const isMatch = picomatch('a/*');
+console.log(isMatch('a\\b')); //=> false
+console.log(isMatch('a/b')); //=> true
+
+// you can still configure the matcher function to accept windows paths
+const isMatch = picomatch('a/*', { options: windows });
+console.log(isMatch('a\\b')); //=> true
+console.log(isMatch('a/b')); //=> true
+```
+
 ### [.test](lib/picomatch.js#L117)
 
 Test `input` with the given `regex`. This is used by the main `picomatch()` function to test the input string.

index.js

@@ -1,3 +1,26 @@
 'use strict';
 
-module.exports = require('./lib/picomatch');
+const os = require('os');
+const pico = require('./lib/picomatch');
+
+const isWindows = os.platform() === 'win32';
+
+function picomatch(glob, options, returnState = false) {
+  // default to os.platform()
+  if (options.windows === null || options.windows === undefined) {
+    options.windows = isWindows;
+  }
+  return pico(glob, options, returnState);
+}
+
+module.exports = picomatch;
+// public api
+module.exports.test = pico.test;
+module.exports.matchBase = pico.matchBase;
+module.exports.isMatch = pico.isMatch;
+module.exports.parse = pico.parse;
+module.exports.scan = pico.scan;
+module.exports.compileRe = pico.compileRe;
+module.exports.toRegex = pico.toRegex;
+// for tests
+module.exports.makeRe = pico.makeRe;

package.json

@@ -1,8 +1,8 @@
 {
-  "name": "picomatch-browser",
-  "description": "(temporary fork of picomatch) Blazing fast and accurate glob matcher written in JavaScript, with no dependencies and full support for standard and extended Bash glob features, including braces, extglobs, POSIX brackets, and regular expressions.",
-  "version": "2.2.5",
-  "homepage": "https://github.com/acao/picomatch",
+  "name": "picomatch",
+  "description": "Blazing fast and accurate glob matcher written in JavaScript, with no dependencies and full support for standard and extended Bash glob features, including braces, extglobs, POSIX brackets, and regular expressions.",
+  "version": "2.2.2",
+  "homepage": "https://github.com/micromatch/picomatch",
   "author": "Jon Schlinkert (https://github.com/jonschlinkert)",
   "funding": "https://github.com/sponsors/jonschlinkert",
   "repository": "micromatch/picomatch",
@@ -12,6 +12,7 @@
   "license": "MIT",
   "files": [
     "index.js",
+    "posix.js",
     "lib"
   ],
   "main": "index.js",

posix.js

@@ -0,0 +1,3 @@
+'use strict';
+
+module.exports = require('./lib/picomatch');

test/api.posix.js

@@ -0,0 +1,17 @@
+'use strict';
+
+const assert = require('assert');
+const picomatch = require('../posix');
+
+describe('picomatch/posix', () => {
+  it('should use posix paths only by default', () => {
+    const match = picomatch('a/**');
+    assert(match('a/b'));
+    assert(!match('a\\b'));
+  });
+  it('should still be manually configurable to accept non-posix paths', () => {
+    const match = picomatch('a/**', { windows: true });
+    assert(match('a\\b'));
+    assert(match('a/b'));
+  });
+});