Prettier, add support for Opera mobile

Shubham Kanodia · Shubham Kanodia · commit 5ea4700968b6 · 2022-02-09T03:40:58.000+05:30
diff --git a/.babelrc b/.babelrc
@@ -1,3 +1,3 @@
 {
   "presets": ["es2015", "stage-2"]
-}
+}
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -3,19 +3,18 @@ on: [push]
 
 jobs:
   build:
-
     runs-on: ubuntu-latest
 
     strategy:
       matrix:
         node-version: [12.x, 14.x, 16.x]
 
     steps:
-    - uses: actions/checkout@v2
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v2
-      with:
-        node-version: ${{ matrix.node-version }}
-    - run: yarn install
-    - run: yarn build
-    - run: yarn test
+      - uses: actions/checkout@v2
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: yarn install
+      - run: yarn build
+      - run: yarn test
diff --git a/.prettierignore b/.prettierignore
@@ -0,0 +1 @@
+.yarn/cache
diff --git a/.prettierrc.json b/.prettierrc.json
@@ -0,0 +1,6 @@
+{
+  "trailingComma": "es5",
+  "tabWidth": 2,
+  "semi": false,
+  "singleQuote": true
+}
diff --git a/.yarn/install-state.gz b/.yarn/install-state.gz
diff --git a/.yarn/releases/yarn-3.1.1.cjs b/.yarn/releases/yarn-3.1.1.cjs
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,51 +1,63 @@
 # v3.0.0
+
 - **Fix**: Don't crash when `options` parameter is not specified
 - **Fix**: Use `loose` option to parse browsers versions. Doesn't crash on versions like `6.00.1` or 6.0.0005` etc.
 
 - **Feature**: Added support for Samsung Internet
 
-- **Breaking**: Safari on desktop and on iOS are now considered as separate browsers. 
-You'll need to use separate browserslist queries to target both of them - `['Safari >= 10', 'iOS >= 10.1']`. See #23
-- **Breaking**: Removing support for undocumented option to `matchesUA` - `all`. 
-This was used internally, and shouldn't be breaking change for you unless you poked around code to discover it.
+- **Breaking**: Safari on desktop and on iOS are now considered as separate browsers.
+  You'll need to use separate browserslist queries to target both of them - `['Safari >= 10', 'iOS >= 10.1']`. See #23
+- **Breaking**: Removing support for undocumented option to `matchesUA` - `all`.
+  This was used internally, and shouldn't be breaking change for you unless you poked around code to discover it.
 - **Breaking**: Remove deprecated `_allowHigherVersions` flag. This has been replaced by `allowHigherVersions` in the past.
 
 # v2.0.1
-- Remove deprecated _allowHigherVersions option from README
+
+- Remove deprecated \_allowHigherVersions option from README
 
 # v2.0.0
+
 - **Feature**: Added Yandex to list of supported browsers
 - **Feature**: Added support for Yandex Browser
 - **Deprecation**: Deprecated `_allowHigherVersions`
 
 #v1.2.1
+
 - Fixed build link
 
 #v1.2.0
+
 - **Feature**: Updated packages and added support for headless chrome and chromium
 - Fixed links in badges
 
 #v1.1.0
+
 - **Feature**: Added support for selecting environment
 - Updated browserslist version
 
 #v1.0.4
+
 - delete gitignore
 
 #v1.0.3
+
 - Update README.md
 
 #v1.0.2
+
 - Second try at fixing logo
 
 #v1.0.1
+
 - Updated browserslist version
 
 #v1.0.0
+
 - Create LICENSE
 - /browserlist/ => browserslist
 - Refactored code and rewrote Readme
 
 #v0.0.2
+
 - Added install instructions
 - Initial commit
diff --git a/README.md b/README.md
@@ -5,21 +5,22 @@
 
 <img align="right" width="120" height="120"
      src="https://cdn.rawgit.com/pastelsky/browserslist-useragent/master/logo.svg" alt="Browserslist Useragent logo (original by Anton Lovchikov)" />
-     
 
-Find if a given user agent string satisfies a [browserslist](https://github.com/ai/browserslist) query. 
+Find if a given user agent string satisfies a [browserslist](https://github.com/ai/browserslist) query.
 
-It automatically reads the browserslist configuration specified in your project, 
+It automatically reads the browserslist configuration specified in your project,
 but you can also specify the same using the `options` parameter.
 
 **If you wish to target modern browsers, read [this](#when-querying-for-modern-browsers).**
 
 ## Installation
+
 ```bash
 npm install browserslist-useragent
 ```
 
 ## Usage
+
 ```js
 const { matchesUA } = require('browserslist-useragent')
 
@@ -30,41 +31,49 @@ matchesUA('Mozilla/5.0 (Windows NT 10.0; rv:54.0) Gecko/20100101 Firefox/54.0')
 //returns boolean
 
 // with explicit browserslist
-matchesUA('Mozilla/5.0 (Windows NT 10.0; rv:54.0) Gecko/20100101 Firefox/54.0', { browsers: ['Firefox > 53']})
+matchesUA(
+  'Mozilla/5.0 (Windows NT 10.0; rv:54.0) Gecko/20100101 Firefox/54.0',
+  { browsers: ['Firefox > 53'] }
+)
 // returns true
 ```
 
-| Option | Default Value | Description |
-|--------|---------------|------------ |
-| browsers | — | Manually provide a browserslist query (or an array of queries). Specifying this overrides the browserslist configuration specified in your project. |
-| env | — | When multiple browserslist [environments](https://github.com/ai/browserslist#environments) are specified, pick the config belonging to this environment.|
-| path | `process.cwd()` | Specify a folder to search for the browserslist config (if it differs from the current working directory) |
-| ignorePatch | `true` | Ignore differences in patch browser numbers |
-| ignoreMinor | `false` | Ignore differences in minor browser versions |
-| allowHigherVersions | `false` | For all the browsers in the browserslist query, return a match if the user agent version is equal to or higher than the one specified in browserslist. See [why](#when-querying-for-modern-browsers) this might be useful.
+| Option              | Default Value   | Description                                                                                                                                                                                                                |
+| ------------------- | --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| browsers            | —               | Manually provide a browserslist query (or an array of queries). Specifying this overrides the browserslist configuration specified in your project.                                                                        |
+| env                 | —               | When multiple browserslist [environments](https://github.com/ai/browserslist#environments) are specified, pick the config belonging to this environment.                                                                   |
+| path                | `process.cwd()` | Specify a folder to search for the browserslist config (if it differs from the current working directory)                                                                                                                  |
+| ignorePatch         | `true`          | Ignore differences in patch browser numbers                                                                                                                                                                                |
+| ignoreMinor         | `false`         | Ignore differences in minor browser versions                                                                                                                                                                               |
+| allowHigherVersions | `false`         | For all the browsers in the browserslist query, return a match if the user agent version is equal to or higher than the one specified in browserslist. See [why](#when-querying-for-modern-browsers) this might be useful. |
 
 ## Supported browsers
- - Chrome (Chrome / Chromium / Yandex) as `and_chr` | `ChromeAndroid` | `Chrome`
- - Samsung Internet as `Samsung`
- - Firefox as `ff` | `and_ff` | `FirefoxAndroid` | `Firefox`
- - Safari iOS as `ios_saf` | `iOS`
- - Safari Desktop as `Safari`
- - IE as `ie` | `ie_mob`
- - Edge as `Edge`
- 
- PRs to add more _browserslist supported_ browsers are welcome 👋
- 
+
+- Chrome (Chrome / Chromium / Yandex) as `and_chr` | `ChromeAndroid` | `Chrome`
+- Samsung Internet as `Samsung`
+- Firefox as `ff` | `and_ff` | `FirefoxAndroid` | `Firefox`
+- Safari iOS as `ios_saf` | `iOS`
+- Safari Desktop as `Safari`
+- IE as `ie` | `ie_mob`
+- Edge as `Edge`
+- OperaMobile as `OperaMobile`
+
+PRs to add more _browserslist supported_ browsers are welcome 👋
+
 ## Notes
- - All browsers on iOS (Chrome, Firefox etc) use Safari's WebKit as the underlying engine, and hence will be resolved to Safari. Since `browserslist` is usually used for
+
+- All browsers on iOS (Chrome, Firefox etc) use Safari's WebKit as the underlying engine, and hence will be resolved to Safari. Since `browserslist` is usually used for
   transpiling / autoprefixing for browsers, this behaviour is what's intended in most cases, but might surprise you otherwise.
-  
- - Right now, Chrome for Android and Firefox for Android are resolved to their desktop equivalents. The `caniuse` database does not currently store historical data for these browsers separately (except the last version) See [#156](https://github.com/ai/browserslist/issues/156). However,
- safari for iOS and desktop can be matched separately, since this data is available for both.
+
+- Right now, Chrome for Android and Firefox for Android are resolved to their desktop equivalents. The `caniuse` database does not currently store historical data for these browsers separately (except the last version) See [#156](https://github.com/ai/browserslist/issues/156). However,
+  safari for iOS and desktop can be matched separately, since this data is available for both.
 
 ## When querying for modern browsers
- - It is a good idea to update this package often so that browser definitions are upto date. 
- - It is also a good idea to add `unreleased versions` to your browserslist query, and set `ignoreMinor` and `ignorePatch` to true so that alpha / beta / canary versions of browsers are matched.
- - In case you're unable to keep this package up-to-date, you can set the `allowHigherVersions` to `true`. For all the browsers specified in your browserslist query, this will return a match if the user agent version is equal to or higher than those specified in your browserslist query. Use this with care though, since it's a wildcard, and only lightly tested.
- 
- ## Further reads
- - [Smart Bundling: Shipping legacy code to only legacy browsers](https://www.smashingmagazine.com/2018/10/smart-bundling-legacy-code-browsers/) 
+
+- It is a good idea to update this package often so that browser definitions are upto date.
+- It is also a good idea to add `unreleased versions` to your browserslist query, and set `ignoreMinor` and `ignorePatch` to true so that alpha / beta / canary versions of browsers are matched.
+- In case you're unable to keep this package up-to-date, you can set the `allowHigherVersions` to `true`. For all the browsers specified in your browserslist query, this will return a match if the user agent version is equal to or higher than those specified in your browserslist query. Use this with care though, since it's a wildcard, and only lightly tested.
+
+## Further reads
+
+- [Smart Bundling: Shipping legacy code to only legacy browsers](https://www.smashingmagazine.com/2018/10/smart-bundling-legacy-code-browsers/)
diff --git a/index.js b/index.js
@@ -30,16 +30,19 @@ function resolveUserAgent(uaString) {
   // renderer
   // @see https://github.com/Financial-Times/polyfill-service/pull/416
 
-  let strippedUA = uaString.replace(/((CriOS|OPiOS)\/(\d+)\.(\d+)\.(\d+)\.(\d+))/, '')
+  let strippedUA = uaString.replace(
+    /((CriOS|OPiOS)\/(\d+)\.(\d+)\.(\d+)\.(\d+))/,
+    ''
+  )
 
   // Yandex Browser uses Chromium as the udnerlying engine
   strippedUA = strippedUA.replace(/YaBrowser\/(\d+\.?)+/g, '')
 
   // Yandex Search uses Chromium as the udnerlying engine
-  strippedUA = strippedUA.replace(/YandexSearch\/(\d+\.?)+/g, '');
+  strippedUA = strippedUA.replace(/YandexSearch\/(\d+\.?)+/g, '')
 
   // Facebook Webview
-  strippedUA = strippedUA.replace(/FB_IAB/g, '').replace(/FBAN\/FBIOS/g, '');
+  strippedUA = strippedUA.replace(/FB_IAB/g, '').replace(/FBAN\/FBIOS/g, '')
 
   const parsedUA = useragent.parse(strippedUA)
 
@@ -60,12 +63,12 @@ function resolveUserAgent(uaString) {
   if (parsedUA.os.family === 'iOS') {
     return {
       family: 'iOS',
-      version: [parsedUA.os.major, parsedUA.os.minor,
-        parsedUA.os.patch].join('.'),
+      version: [parsedUA.os.major, parsedUA.os.minor, parsedUA.os.patch].join(
+        '.'
+      ),
     }
   }
 
-
   // Case C: The caniuse database does not contain
   // historical browser versions for so called `minor`
   // browsers like Chrome for Android, Firefox for Android etc
@@ -84,6 +87,13 @@ function resolveUserAgent(uaString) {
     }
   }
 
+  if (parsedUA.family === 'Opera Mobile') {
+    return {
+      family: 'OperaMobile',
+      version: [parsedUA.major, parsedUA.minor, parsedUA.patch].join('.'),
+    }
+  }
+
   if (parsedUA.family === 'Samsung Internet') {
     return {
       family: 'Samsung',
@@ -120,28 +130,30 @@ function resolveUserAgent(uaString) {
 
 // Convert version to a semver value.
 // 2.5 -> 2.5.0; 1 -> 1.0.0;
-const semverify = (version) => semver.coerce(version, { loose: true }).version;
+const semverify = (version) => semver.coerce(version, { loose: true }).version
 
 function flatten(arr) {
   return arr.reduce(function (flat, toFlatten) {
-    return flat.concat(Array.isArray(toFlatten) ? flatten(toFlatten) : toFlatten);
-  }, []);
+    return flat.concat(
+      Array.isArray(toFlatten) ? flatten(toFlatten) : toFlatten
+    )
+  }, [])
 }
 
 // 10.0-10.2 -> 10.0, 10.1, 10.2
 function generateSemversInRange(versionRange) {
   const [start, end] = versionRange.split('-')
   const startSemver = semverify(start)
   const endSemver = semverify(end)
-  const versionsInRange = [];
-  let curVersion = startSemver;
+  const versionsInRange = []
+  let curVersion = startSemver
 
   while (semver.gte(endSemver, curVersion)) {
     versionsInRange.push(curVersion)
     curVersion = semver.inc(curVersion, 'minor')
   }
 
-  return versionsInRange;
+  return versionsInRange
 }
 
 function normalizeQuery(query) {
@@ -158,14 +170,13 @@ function normalizeQuery(query) {
 
 const parseBrowsersList = (browsersList) => {
   const browsers = browsersList
-    .map(browser => {
+    .map((browser) => {
       const [name, version] = browser.split(' ')
       return { name, version }
     })
     // #38 Filter out non-numerical browser versions
-    .filter(browser => browser.version !== 'TP')
-    .map(browser => {
-
+    .filter((browser) => browser.version !== 'TP')
+    .map((browser) => {
       let normalizedName = browser.name
       let normalizedVersion = browser.version
 
@@ -176,7 +187,7 @@ const parseBrowsersList = (browsersList) => {
       // browserslist might return ranges (9.0-9.2), unwrap them
       // see https://github.com/browserslist/browserslist-useragent/issues/41
       if (browser.version.indexOf('-') > 0) {
-        return generateSemversInRange(browser.version).map(version => ({
+        return generateSemversInRange(browser.version).map((version) => ({
           family: normalizedName,
           version,
         }))
@@ -188,7 +199,7 @@ const parseBrowsersList = (browsersList) => {
       }
     })
 
-  return flatten(browsers);
+  return flatten(browsers)
 }
 
 const compareBrowserSemvers = (versionA, versionB, options) => {
@@ -214,7 +225,7 @@ const compareBrowserSemvers = (versionA, versionB, options) => {
 const matchesUA = (uaString, opts = {}) => {
   // bail out early if the user agent is invalid
   if (!uaString) {
-    return false;
+    return false
   }
 
   let normalizedQuery
@@ -223,8 +234,9 @@ const matchesUA = (uaString, opts = {}) => {
   }
   const browsers = browserslist(normalizedQuery, {
     env: opts.env,
-    path: opts.path || process.cwd()
+    path: opts.path || process.cwd(),
   })
+
   const parsedBrowsers = parseBrowsersList(browsers)
 
   const resolvedUserAgent = resolveUserAgent(uaString)
@@ -235,9 +247,10 @@ const matchesUA = (uaString, opts = {}) => {
     ...opts,
   }
 
-  return parsedBrowsers.some(browser => {
+  return parsedBrowsers.some((browser) => {
     return (
-      browser.family.toLowerCase() === resolvedUserAgent.family.toLocaleLowerCase() &&
+      browser.family.toLowerCase() ===
+        resolvedUserAgent.family.toLocaleLowerCase() &&
       compareBrowserSemvers(resolvedUserAgent.version, browser.version, options)
     )
   })
@@ -248,4 +261,3 @@ module.exports = {
   resolveUserAgent,
   normalizeQuery,
 }
-
diff --git a/package.json b/package.json
@@ -31,6 +31,7 @@
     "babel-preset-es2015": "^6.24.1",
     "babel-preset-stage-2": "^6.24.1",
     "jest": "^23.6.0",
+    "prettier": "^2.5.1",
     "useragent-generator": "^1.1.0"
   },
   "jest": {
diff --git a/tests/index.test.js b/tests/index.test.js
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`	`1`	`{`
`2`	`2`	`"presets": ["es2015", "stage-2"]`
`3`		`-}`
	`3`	`+}`