baseline-browser-mapping 2.0.0 → 2.1.0

package/CONTRIBUTING.md

@@ -0,0 +1,21 @@
+# Contributing to `baseline-browser-mapping`
+
+## Bugs
+
+If you find a functional bug in `baseline-browser-mapping`, please create an issue in this repository. Any detail you can include, including as console errors, expected and actual output, is welcome. If you've already figured out how to solve the issue, please create a PR.
+
+## Downstream browser data accuracy and completeness
+
+The data for [Chromium downstream browsers](/README.md#limitations) not included in `@mdn/browser-compat-data` is provided on a best effort basis in [`src/data/downstream-browsers.json`](src/data/downstream-browsers.json). If you have an accurate source for the Chromium versions implemented by the browsers already in this module (UC Mobile, QQ Mobile, Yandex Browser), or if you have data for a browser not included in this module, we welcome issues or PRs to discuss including that data.
+
+## Working with `baseline-browser-mapping` locally
+
+To work with `baseline-browser-mapping` locally, clone this repository and install its dependencies:
+
+```bash
+git clone https://github.com/web-platform-dx/baseline-browser-mapping
+cd baseline-browser-mapping
+npm install
+```
+
+If you make changes to the code, make sure to run `nmp run prepare` before you test your changes from another package.

package/README.md

@@ -112,8 +112,7 @@ Returns the following versions:
 ```
 
 > [!NOTE]  
-> The minimum version of each browser is not necessarily the final version released in that calendar year. In the above example, Firefox 84 was the final version released in 2020; however Firefox 83 supported all of the features that were interoperable at the end of 2020.
-
+> The minimum version of each browser is not necessarily the final version released in that calendar year. In the above example, Firefox 84 was the final version released in 2020; however Firefox 83 supported all of the features that were interoperable at the end of 2020.  
 > [!WARNING]  
 > You cannot use `targetYear` and `widelyAavailableDate` together. Please only use one of these options at a time.
 
@@ -200,7 +199,6 @@ This data is updated on a daily basis using a [script](https://github.com/web-pl
 > [!NOTE]  
 > All the non-core browsers currently included implement Chromium. Their inclusion in any of the above methods is based on the Baseline feature set supported by the Chromium version they implement, not their release date.
 
-## Helping out and getting help
+## Contributing
 
-`baseline-browser-mapping` is part of the W3C WebDX Community Group's web-features project.
-Go to [web-platform-dx/web-features](https://github.com/web-platform-dx/web-features/) for more information on contributing or getting help.
+`baseline-browser-mapping` is part of the W3C WebDX Community Group's web-features project. To learn more about contributing to this module, see [CONTRIBUTING](/CONTRIBUTING.md).

package/package.json

@@ -1,20 +1,22 @@
 {
   "name": "baseline-browser-mapping",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "A library for obtaining browser versions with their maximum supported Baseline feature set and Widely Available status.",
   "exports": {
     ".": "./dist/index.js"
   },
   "files": [
-    "dist",
+    "dist/*",
     "LICENSE.txt",
-    "README.md"
+    "README.md",
+    "CONTRIBUTING.md"
   ],
   "types": "./dist/index.d.ts",
   "type": "module",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
-    "prepare": "rm -rf dist; prettier . --write; tsc"
+    "prepare": "rm -rf dist; prettier . --write; tsc",
+    "refresh-downstream": "npx tsx scripts/refresh-downstream.ts"
   },
   "license": "Apache-2.0",
   "dependencies": {
@@ -23,10 +25,8 @@
   },
   "devDependencies": {
     "@types/node": "^22.13.5",
-    "typescript": "^5.7.2"
+    "typescript": "^5.7.2",
+    "prettier": "^3.5.3"
   },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/tonypconway/web-features/tree/main/packages/baseline-browser-mapping"
-  }
+  "repository": "web-platform-dx/baseline-browser-mapping"
 }