-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge master-scoped-package to master (#7155)
This concludes the `mdn-` package name and continues development under the `@mdn/browser-compat-data` name. * Implement 2.0.0 breaking changes (#6713) * Rename package and increment version to pre-2.0 * Require Node 10 or later * Rename package in the docs * Increment prerelease version * Initial release of @mdn/browser-compat-data A continuation of mdn/browser-compat-data * Patch release containing data or non-breaking updates only * Revert "Add mdn- and Node.js 8 deprecation warnings for 1.1 release (#6777)" This applies only to the 1.1.x releases. This reverts commit ee7feac. * Patch release containing data or non-breaking updates only * Patch release containing data or non-breaking updates only * Use Node.js ≥10 for CI and drop Travis (#6797) * Use Node.js ≥10 for CI * Remove Travis CI config * Remove badges from README * Patch release containing data or non-breaking updates only
- Loading branch information
Showing
13 changed files
with
140 additions
and
91 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,122 @@ | ||
# Use [`@mdn/browser-compat-data`](https://www.npmjs.com/package/@mdn/browser-compat-data) instead! | ||
# `@mdn/browser-compat-data` | ||
|
||
This package is deprecated. Use [`@mdn/browser-compat-data`](https://www.npmjs.com/package/@mdn/browser-compat-data) instead. | ||
[https://github.com/mdn/browser-compat-data](https://github.com/mdn/browser-compat-data) | ||
|
||
If you're already using `mdn-browser-compat-data`, read [the upgrade guide](https://github.com/mdn/browser-compat-data/blob/v1.1.0/UPGRADE-2.0.x.md). | ||
This repository contains compatibility data for Web technologies. | ||
Browser compatibility data describes which platforms (where "platforms" are | ||
usually, but not always, web browsers) support particular Web APIs. | ||
|
||
This data can be used in documentation, to build compatibility tables listing | ||
browser support for APIs. For example: | ||
[Browser support for WebExtension APIs](https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Browser_support_for_JavaScript_APIs). | ||
|
||
Read how this project is [governed](https://github.com/mdn/browser-compat-data/blob/master/GOVERNANCE.md). | ||
|
||
Chat on [chat.mozilla.org#mdn](https://chat.mozilla.org/#/room/#mdn:mozilla.org). | ||
|
||
## Installation | ||
|
||
You can install `@mdn/browser-compat-data` as a node package. | ||
|
||
``` | ||
npm install @mdn/browser-compat-data | ||
``` | ||
|
||
## Usage | ||
|
||
```js | ||
const bcd = require('@mdn/browser-compat-data'); | ||
bcd.css.properties.background; | ||
// returns a compat data object (see schema) | ||
``` | ||
|
||
## Repository contents | ||
|
||
There's a top-level directory for each broad area covered: for example, "http", | ||
"javascript", "webextensions". Inside each of these directories is one or more | ||
JSON file containing the compatibility data. | ||
|
||
- [api/](https://github.com/mdn/browser-compat-data/tree/master/api) contains data for each [Web API](https://developer.mozilla.org/en-US/docs/Web/API) interface. | ||
|
||
- [css/](https://github.com/mdn/browser-compat-data/tree/master/css) contains data for [CSS](https://developer.mozilla.org/en-US/docs/Web/CSS) properties, selectors, and at-rules. | ||
|
||
- [html/](https://github.com/mdn/browser-compat-data/tree/master/html) contains data for | ||
[HTML](https://developer.mozilla.org/en-US/docs/Web/HTML) elements, attributes, and global attributes. | ||
|
||
- [http/](https://github.com/mdn/browser-compat-data/tree/master/http) contains data for [HTTP](https://developer.mozilla.org/en-US/docs/Web/HTTP) headers, statuses, and methods. | ||
|
||
- [javascript/](https://github.com/mdn/browser-compat-data/tree/master/javascript) contains data for [JavaScript](https://developer.mozilla.org/en-US/docs/Web/JavaScript) built-in Objects, statement, operators, and other ECMAScript language features. | ||
|
||
- [mathml/](https://github.com/mdn/browser-compat-data/tree/master/mathml) contains data for [MathML](https://developer.mozilla.org/docs/Web/MathML) elements, attributes, and global attributes. | ||
|
||
- [svg/](https://github.com/mdn/browser-compat-data/tree/master/svg) contains data for [SVG](https://developer.mozilla.org/en-US/docs/Web/SVG) elements, attributes, and global attributes. | ||
|
||
- [webdriver/](https://github.com/mdn/browser-compat-data/tree/master/webdriver) contains data for [WebDriver](https://developer.mozilla.org/en-US/docs/Web/WebDriver) commands. | ||
|
||
- [webextensions/](https://github.com/mdn/browser-compat-data/tree/master/webextensions) contains data for [WebExtensions](https://developer.mozilla.org/en-US/Add-ons/WebExtensions) JavaScript APIs and manifest keys. | ||
|
||
- [xpath/](https://github.com/mdn/browser-compat-data/tree/master/xpath) contains data for [XPath](https://developer.mozilla.org/docs/Web/XPath) axes, and functions. | ||
|
||
- [xslt/](https://github.com/mdn/browser-compat-data/tree/master/xslt) contains data for [XSLT](https://developer.mozilla.org/docs/Web/XSLT) elements, attributes, and global attributes. | ||
|
||
## Format of the browser compat json files | ||
|
||
The definitive description of the format used to represent compatibility data is the [schema file](https://github.com/mdn/browser-compat-data/blob/master/schemas/compat-data.schema.json). | ||
You can also have a look at the [schema documentation](https://github.com/mdn/browser-compat-data/blob/master/schemas/compat-data-schema.md). | ||
|
||
## Issues? | ||
|
||
If you find a problem, please [file a bug](https://github.com/mdn/browser-compat-data/issues/new). | ||
|
||
## Contributing | ||
|
||
We're very happy to accept contributions to this data. See [Contributing to browser-compat-data](/docs/contributing.md) for more information. | ||
|
||
## Projects using the data | ||
|
||
Here are some projects using the data, as an [npm module](https://www.npmjs.com/browse/depended/@mdn/browser-compat-data) or directly: | ||
|
||
- [Add-ons Linter](https://github.com/mozilla/addons-linter) - the Add-ons Linter is used on [addons.mozilla.org](https://addons.mozilla.org/) and the [web-ext](https://github.com/mozilla/web-ext/) tool. It uses browser-compat-data to check that the Firefox version that the add-on lists support for does in fact support the APIs used by the add-on. | ||
- [Browser Compatibility Data Explorer](https://github.com/connorshea/mdn-compat-data-explorer) - View, search, and visualize data from the compatibility dataset. | ||
- [caniuse](https://caniuse.com/) - In addition to the existing caniuse database, caniuse includes features from the MDN BCD project, formatted and interactive like any other caniuse support table. | ||
- [Compat Report](https://addons.mozilla.org/en-US/firefox/addon/compat-report/) - Firefox Add-on that shows compatibility data for the current site in the developer tools. | ||
- [compat-tester](https://github.com/SphinxKnight/compat-tester) - Scan local documents for compatibility issues. | ||
- [Visual Studio Code](https://code.visualstudio.com) - Shows the compatibility information in [the code completion popup](https://code.visualstudio.com/updates/v1_25#_improved-accuracy-of-browser-compatibility-data). | ||
- [webhint.io](https://webhint.io/docs/user-guide/hints/hint-compat-api/) - Hints to check if your CSS HTML and JavaScript have deprecated or not broadly supported features. | ||
- [WebStorm](https://www.jetbrains.com/webstorm/whatsnew/#v2019-1-html-and-css) - JavaScript IDE allowing you to check whether all CSS properties you use are supported in the target browser version. | ||
- [Hexo Plugin: hexo-compat-report](https://github.com/TimDaub/hexo-compat-report) - Allows to embed MDN's compatibility table in a hexo blog post. | ||
|
||
## Acknowledgments | ||
|
||
Thanks to: | ||
|
||
<table> | ||
<tr align="center"> | ||
<td> | ||
<img | ||
src="https://user-images.githubusercontent.com/498917/52569900-852b3080-2e12-11e9-9bd0-f1e256b13e53.png" | ||
height="86" | ||
alt="BrowserStack" | ||
/> | ||
<p> | ||
The | ||
<a href="https://www.browserstack.com/open-source" | ||
>BrowserStack Open Source Program</a | ||
> | ||
for testing services | ||
</p> | ||
</td> | ||
<td> | ||
<img | ||
src="https://opensource.saucelabs.com/images/opensauce/powered-by-saucelabs-badge-white.png?sanitize=true" | ||
height="86" | ||
alt="Testing Powered By Sauce Labs" | ||
/> | ||
<p> | ||
<a href="https://opensource.saucelabs.com/">Sauce Labs Open Source</a | ||
> | ||
for testing services | ||
</p> | ||
</td> | ||
</tr> | ||
</table> |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters