browserslist 1.0.0 → 1.1.2

package/.npmignore

@@ -5,4 +5,5 @@ node_modules/
 test/
 .travis.yml
 
-gulpfile.js
+.editorconfig
+.eslintrc

package/CHANGELOG.md

@@ -1,5 +1,20 @@
-## 1.0.0
+## 1.1.2
+* Fix JSPM support (by Sean Anderson).
+
+## 1.1.1
+* Fix space-less `>10%` and `>10% in my stats` queries.
+* Normalize error messages.
+* Remove development files from npm package.
+
+## 1.1
+* Added query against custom browser usage data (by Daniel Rey).
+
+## 1.0.1
+* Update Firefox ESR (by Rouven Weßling).
+
+## 1.0
 * Remove Opera 12.1 from default query.
+* Add `not` keyword and exclude browsers by query.
 * Add Microsoft Edge support (by Andrey Polischuk).
 * Add CLI for debug and non-JS usage (by Luke Horvat).
 * Use own class in Browserslist errors.

package/README.md

@@ -3,29 +3,23 @@
 Get browser versions that match given criteria.
 Useful for tools like [Autoprefixer].
 
-You can select browsers by passing a string. This library will use Can I Use
-data to return the appropriate list of all matching versions.
-
-For example, the last version of each major browser and versions,
-with a usage of over 5% in global usage statistics:
+You can select browsers by passing a string. This library will use
+Can I Use data to return list of all matching versions.
+For example, query to select all browser versions that are the last version
+of each major browser, or have a usage of over 10% in global usage statistics:
 
 ```js
-browserslist('last 1 version, > 5%');
-//=> ['and_chr 44', 'and_uc 9.9', 'chrome 44', 'chrome 43', 'edge 1',
-//    'firefox 40', 'firefox 39', 'ie 11', 'ie_mob 11', 'ios_saf 8.1-8.4',
-//    'opera 30', 'safari 8']
+browserslist('last 1 version, > 10%');
+//=> ["and_chr 47", "chrome 48", "chrome 47", "edge 13", "firefox 44",
+//    "ie 11", "ie_mob 11", "ios_saf 9.0-9.2", "opera 34", "safari 9"]
 ```
 
-Browserslist will use browsers criterias from:
-
-1. First argument.
-2. `BROWSERSLIST` environment variable.
-3. `browserslist` config file in current or parent directories.
-4. If all methods will not give a result, Browserslist will use defaults:<br>
-   `> 1%, last 2 versions, Firefox ESR`.
-
 <a href="https://evilmartians.com/?utm_source=browserslist">
-<img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg" alt="Sponsored by Evil Martians" width="236" height="54">
+  <img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg"
+    alt="Sponsored by Evil Martians"
+    width="236"
+    height="54"
+  \>
 </a>
 
 [Autoprefixer]: https://github.com/postcss/autoprefixer
@@ -34,12 +28,24 @@ Browserslist will use browsers criterias from:
 
 ## Queries
 
+Browserslist will use browsers criterias from:
+
+1. First argument.
+2. `BROWSERSLIST` environment variable.
+3. `browserslist` config file in current or parent directories.
+4. If all methods will not give a result, Browserslist will use defaults:
+   `> 1%, last 2 versions, Firefox ESR`.
+
+Multiple criteria are combined as a boolean `OR`. A browser version must match
+at least one of the criteria to be selected.
+
 You can specify the versions by queries (case insensitive):
 
 * `last 2 versions`: the last 2 versions for each major browser.
 * `last 2 Chrome versions`: the last 2 versions of Chrome browser.
 * `> 5%`: versions selected by global usage statistics.
 * `> 5% in US`: uses USA usage statistics. It accepts [two-letter country code].
+* `> 5% in my stats`: uses [custom usage data].
 * `ie 6-8`: selects an inclusive range of versions.
 * `Firefox > 20`: versions of Firefox newer than 20.
 * `Firefox >= 20`: versions of Firefox newer than or equal to 20.
@@ -47,24 +53,21 @@ You can specify the versions by queries (case insensitive):
 * `Firefox <= 20`: versions of Firefox less than or equal to 20.
 * `Firefox ESR`: the latest [Firefox ESR] version.
 * `iOS 7`: the iOS browser version 7 directly.
-* `not ie <= 8`: exclude browsers selected before by this query.
+* `not ie <= 8`: exclude browsers selected before by previous queries.
   You can add `not ` to any query.
 
-Blackberry and Android WebView will not be used in `last n versions`.
-You should add them by name.
-
-Browserslist works with separated versions of browsers. To use all versions
-of some browsers you can use for example `Firefox > 0`,
-but it is bad practice.
+Browserslist works with separated versions of browsers.
+You should avoid queries like `Firefox > 0`.
 
 [two-letter country code]: http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements
+[custom usage data]:       #custom-usage-data
 
 ## Browsers
 
 Names are case insensitive:
 
-* `Android` for Android WebView.
-* `BlackBerry` or `bb` for Blackberry browser.
+### Major Browsers
+
 * `Chrome` for Google Chrome.
 * `Firefox` or `ff` for Mozilla Firefox.
 * `Explorer` or `ie` for Internet Explorer.
@@ -72,17 +75,22 @@ Names are case insensitive:
 * `iOS` or `ios_saf` for iOS Safari.
 * `Opera` for Opera.
 * `Safari` for desktop Safari.
-* `OperaMobile` or `op_mob` for Opera Mobile.
-* `OperaMini` or `op_mini` for Opera Mini.
+* `ExplorerMobile` or `ie_mob` for Internet Explorer Mobile.
+
+### Other
+
+* `Android` for Android WebView.
+* `BlackBerry` or `bb` for Blackberry browser.
 * `ChromeAndroid` or `and_chr` for Chrome for Android
-  (mostly same as common `Chrome`).
+  (in Other section, because mostly same as common `Chrome`).
 * `FirefoxAndroid` or `and_ff` for Firefox for Android.
-* `ExplorerMobile` or `ie_mob` for Internet Explorer Mobile.
+* `OperaMobile` or `op_mob` for Opera Mobile.
+* `OperaMini` or `op_mini` for Opera Mini.
 
 ## Config File
 
 Browserslist’s config should be named `browserslist` and have browsers queries
-split by a new line. You can write a comment after `#`:
+split by a new line. Comments starts with `#` symbol:
 
 ```yaml
 # Browsers that we support
@@ -92,9 +100,9 @@ Last 2 versions
 IE 8 # sorry
 ```
 
-Browserslist will check config in every directory in `config.path` path.
-So, if tool with Browserslist process `app/styles/main.css`, you can put
-config to root, `app/` or `app/styles`.
+Browserslist will check config in every directory in `path`.
+So, if tool process `app/styles/main.css`, you can put config to root,
+`app/` or `app/styles`.
 
 You can specify direct path to config by `config` option
 or `BROWSERSLIST_CONFIG` environment variables.
@@ -116,8 +124,58 @@ by [environment variables]:
   BROWSERSLIST_CONFIG=./config/browserslist gulp css
    ```
 
+* `BROWSERSLIST_STATS` with path to the custom usage data.
+
+   ```sh
+  BROWSERSLIST_STATS=./config/usage_data.json gulp css
+   ```
+
 [environment variables]: https://en.wikipedia.org/wiki/Environment_variable
 
+## Custom Usage Data
+
+If you have a website, you can query against the usage statistics of your site:
+
+1. Import your Google Analytics data into [Can I Use].
+   Press `Import…` button in Settings page.
+2. Open browser DevTools on [caniuse.com] add paste this snippet into Console:
+
+    ```js
+   var e=document.createElement('a');e.setAttribute('href', 'data:text/plain;charset=utf-8,'+encodeURIComponent(JSON.stringify(JSON.parse(localStorage['usage-data-by-id'])[localStorage['config-primary_usage']])));e.setAttribute('download','stats.json');document.body.appendChild(e);e.click();document.body.removeChild(e);}
+    ```
+3. Save data to file in your project.
+4. Give it to Browserslist by `stats` option
+   or `BROWSERSLIST_STATS` environment variable:
+
+    ```js
+   browserslist('> 5% in my stats', { stats: 'path/to/the/stats.json' });
+    ```
+
+Of course, you can generate usage statistics file by any other method.
+Option `stats` accepts path to file or data itself:
+
+```js
+var custom = {
+    ie: {
+        6: 0.01,
+        7: 0.4,
+        8: 1.5
+    },
+    chrome: {
+        …
+    },
+    …
+};
+
+browserslist('> 5% in my stats', { stats: custom });
+```
+
+Note that you can query against your custom usage data while also querying
+against global or regional data. For example, the query
+`> 5% in my stats, > 1%, > 10% in US` is permitted.
+
+[Can I Use]: http://caniuse.com/
+
 ## Usage
 
 ```js
@@ -130,13 +188,13 @@ var process = function (css, opts) {
 }
 ```
 
-If a list is missing, Browserslist will look for a config file.
-You can provide a `path` option (that can be a file) to find the config file
-relatively to it.
-
 Queries can be a string `"> 5%, last 1 version"`
 or an array `['> 5%', 'last 1 version']`.
 
+If a query is missing, Browserslist will look for a config file.
+You can provide a `path` option (that can be a file) to find the config file
+relatively to it.
+
 For non-JS environment and debug purpose you can use CLI tool:
 
 ```sh

package/index.js

@@ -25,6 +25,20 @@ function error(name) {
     throw obj;
 }
 
+// Helpers
+
+var normalize = function (versions) {
+    return versions.filter(function (version) {
+        return typeof version === 'string';
+    });
+};
+
+var fillUsage = function (result, name, data) {
+    for ( var i in data ) {
+        result[name + ' ' + i] = data[i];
+    }
+};
+
 // Return array of browsers by selection queries:
 //
 //   browserslist('IE >= 10, IE 8') //=> ['ie 11', 'ie 10', 'ie 8']
@@ -56,6 +70,25 @@ var browserslist = function (selections, opts) {
         selections = selections.split(/,\s*/);
     }
 
+    if ( opts.stats || process.env.BROWSERSLIST_STATS ) {
+        browserslist.usage.custom = { };
+        var stats = opts.stats || process.env.BROWSERSLIST_STATS;
+        if ( typeof stats === 'string' ) {
+            try {
+                stats = JSON.parse(fs.readFileSync(stats));
+            } catch (e) {
+                error('Can\'t read ' + stats);
+            }
+        }
+        if ( 'dataByBrowser' in stats ) {
+            // Allow to use the data as-is from the caniuse.com website
+            stats = stats.dataByBrowser;
+        }
+        for ( var browser in stats ) {
+            fillUsage(browserslist.usage.custom, browser, stats[browser]);
+        }
+    }
+
     var result = [];
 
     var exclude, query, match, array, used;
@@ -109,8 +142,6 @@ var browserslist = function (selections, opts) {
     });
 };
 
-// Helpers
-
 var normalizeVersion = function (data, version) {
     if ( data.versions.indexOf(version) !== -1 ) {
         return version;
@@ -120,24 +151,11 @@ var normalizeVersion = function (data, version) {
     }
 };
 
-var normalize = function (versions) {
-    return versions.filter(function (version) {
-        return typeof version === 'string';
-    });
-};
-
-var fillUsage = function (result, name, data) {
-    for ( var i in data ) {
-        result[name + ' ' + i] = data[i];
-    }
-};
-
-browserslist.Error = BrowserslistError;
-
 // Will be filled by Can I Use data below
 browserslist.data  = { };
 browserslist.usage = {
-    global: { }
+    global: { },
+    custom: null
 };
 
 // Default browsers query
@@ -186,7 +204,7 @@ browserslist.checkName = function (name) {
 // Find config, read file and parse it
 browserslist.readConfig = function (from) {
     if ( from === false )   return false;
-    if ( !fs.readFileSync ) return false;
+    if ( !fs.readFileSync || !fs.existsSync || !fs.statSync ) return false;
     if ( typeof from === 'undefined' ) from = '.';
 
     var dirs = path.resolve(from).split(path.sep);
@@ -247,7 +265,7 @@ browserslist.queries = {
     },
 
     globalStatistics: {
-        regexp: /^> (\d+\.?\d*)%$/,
+        regexp: /^>\s?(\d+\.?\d*)%$/,
         select: function (popularity) {
             popularity = parseFloat(popularity);
             var result = [];
@@ -262,6 +280,27 @@ browserslist.queries = {
         }
     },
 
+    customStatistics: {
+        regexp: /^>\s?(\d+\.?\d*)% in my stats$/,
+        select: function (popularity) {
+            popularity = parseFloat(popularity);
+            var result = [];
+
+            var usage = browserslist.usage.custom;
+            if ( !usage ) {
+                error('Custom usage statistics was not provided');
+            }
+
+            for ( var version in usage ) {
+                if ( usage[version] > popularity ) {
+                    result.push(version);
+                }
+            }
+
+            return result;
+        }
+    },
+
     countryStatistics: {
         regexp: /^> (\d+\.?\d*)% in (\w\w)$/,
         select: function (popularity, country) {
@@ -344,7 +383,7 @@ browserslist.queries = {
     esr: {
         regexp: /^(firefox|ff|fx) esr$/i,
         select: function () {
-            return ['firefox 31'];
+            return ['firefox 38'];
         }
     },
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "browserslist",
-  "version": "1.0.0",
+  "version": "1.1.2",
   "description": "Get browsers versions that matches given criterias like in Autoprefixer",
   "keywords": [
     "caniuse",
@@ -13,17 +13,15 @@
     "url":  "https://github.com/ai/browserslist.git"
   },
   "dependencies": {
-    "caniuse-db": "^1.0.30000281"
+    "caniuse-db": "^1.0.30000409"
   },
   "bin": "./cli.js",
   "devDependencies": {
-    "gulp-eslint": "1.0.0",
-    "gulp-mocha":  "2.1.3",
-    "mocha":       "2.3.0",
-    "chai":        "3.2.0",
-    "gulp":        "3.9.0"
+    "eslint-config-postcss": "^1.0.0",
+    "eslint":                "1.10.3",
+    "ava":                   "0.11.0"
   },
   "scripts": {
-    "test": "gulp"
+    "test": "ava && eslint *.js test/*.js"
   }
 }

package/.eslintrc

@@ -1,126 +0,0 @@
-{
-  "rules": {
-    "space-before-function-paren": [2, { "named": "never" }],
-    "no-shadow-restricted-names":  [2],
-    "computed-property-spacing":   [2],
-    "no-empty-character-class":    [2],
-    "no-irregular-whitespace":     [2],
-    "no-unexpected-multiline":     [2],
-    "no-multiple-empty-lines":     [2],
-    "space-return-throw-case":     [2],
-    "no-constant-condition":       [2],
-    "no-extra-boolean-cast":       [2],
-    "no-inner-declarations":       [2],
-    "no-this-before-super":        [2],
-    "no-use-before-define":        [2],
-    "no-array-constructor":        [2],
-    "object-curly-spacing":        [2, "always"],
-    "no-floating-decimal":         [2],
-    "no-warning-comments":         [2],
-    "handle-callback-err":         [2],
-    "no-unneeded-ternary":         [2],
-    "operator-assignment":         [2],
-    "space-before-blocks":         [2],
-    "no-native-reassign":          [2],
-    "no-trailing-spaces":          [2],
-    "operator-linebreak":          [2, "after"],
-    "consistent-return":           [2],
-    "no-duplicate-case":           [2],
-    "no-invalid-regexp":           [2],
-    "no-negated-in-lhs":           [2],
-    "constructor-super":           [2],
-    "no-nested-ternary":           [2],
-    "no-extend-native":            [2],
-    "block-scoped-var":            [2],
-    "no-control-regex":            [2],
-    "no-sparse-arrays":            [2],
-    "no-throw-literal":            [2],
-    "no-return-assign":            [2],
-    "no-const-assign":             [2],
-    "no-class-assign":             [2],
-    "no-extra-parens":             [2],
-    "no-regex-spaces":             [2],
-    "no-implied-eval":             [2],
-    "no-useless-call":             [2],
-    "no-self-compare":             [2],
-    "no-octal-escape":             [2],
-    "no-new-wrappers":             [2],
-    "no-process-exit":             [2],
-    "no-catch-shadow":             [2],
-    "linebreak-style":             [2],
-    "space-infix-ops":             [2],
-    "space-unary-ops":             [2],
-    "no-cond-assign":              [2],
-    "no-func-assign":              [2],
-    "no-unreachable":              [2],
-    "accessor-pairs":              [2],
-    "no-empty-label":              [2],
-    "no-fallthrough":              [2],
-    "no-path-concat":              [2],
-    "no-new-require":              [2],
-    "no-spaced-func":              [2],
-    "no-unused-vars":              [2],
-    "spaced-comment":              [2],
-    "no-delete-var":               [2],
-    "comma-spacing":               [2],
-    "no-extra-semi":               [2],
-    "no-extra-bind":               [2],
-    "arrow-spacing":               [2],
-    "prefer-spread":               [2],
-    "no-new-object":               [2],
-    "no-multi-str":                [2],
-    "semi-spacing":                [2],
-    "no-lonely-if":                [2],
-    "dot-notation":                [2],
-    "dot-location":                [2, "property"],
-    "comma-dangle":                [2, "never"],
-    "no-dupe-args":                [2],
-    "no-dupe-keys":                [2],
-    "no-ex-assign":                [2],
-    "no-obj-calls":                [2],
-    "valid-typeof":                [2],
-    "default-case":                [2],
-    "no-redeclare":                [2],
-    "no-div-regex":                [2],
-    "no-sequences":                [2],
-    "no-label-var":                [2],
-    "comma-style":                 [2],
-    "brace-style":                 [2],
-    "no-debugger":                 [2],
-    "quote-props":                 [2, "as-needed"],
-    "no-iterator":                 [2],
-    "no-new-func":                 [2],
-    "key-spacing":                 [2, { "align": "value" }],
-    "complexity":                  [2],
-    "new-parens":                  [2],
-    "no-eq-null":                  [2],
-    "no-bitwise":                  [2],
-    "wrap-iife":                   [2],
-    "no-caller":                   [2],
-    "use-isnan":                   [2],
-    "no-labels":                   [2],
-    "no-shadow":                   [2],
-    "camelcase":                   [2],
-    "eol-last":                    [2],
-    "no-octal":                    [2],
-    "no-empty":                    [2],
-    "no-alert":                    [2],
-    "no-proto":                    [2],
-    "no-undef":                    [2],
-    "no-eval":                     [2],
-    "no-with":                     [2],
-    "no-void":                     [2],
-    "max-len":                     [2, 80],
-    "new-cap":                     [2],
-    "eqeqeq":                      [2],
-    "no-new":                      [2],
-    "quotes":                      [2, "single"],
-    "indent":                      [2, 4],
-    "semi":                        [2, "always"],
-    "yoda":                        [2, "never"]
-  },
-  "env": {
-    "mocha": true,
-    "node":  true
-  }
-}