-
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
add compat-data docs #3015
Open
JLHwung
wants to merge
2
commits into
babel:main
Choose a base branch
from
JLHwung:add-compat-data-docs
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+56
−0
Open
add compat-data docs #3015
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
--- | ||
id: babel-compat-data | ||
title: "@babel/compat-data" | ||
--- | ||
|
||
This package provides compatibility data for various JavaScript features across different browser and runtime environments. It is used by [`@babel/preset-env`](./preset-env.md) internally to determine the required Babel plugins for given [compilation targets](./options.md#targets). The compat data is extracted from the [compat-table project](https://github.com/compat-table/compat-table). | ||
|
||
## Install | ||
|
||
```shell npm2yarn | ||
npm install --save-dev @babel/compat-data | ||
``` | ||
|
||
## Usage | ||
|
||
### plugins | ||
```javascript title="my-babel-plugin.js" | ||
import _plugins from "@babel/compat-data/plugins"; | ||
const pluginsCompatData = _plugins.default; | ||
``` | ||
|
||
The `pluginsCompatData` is an object with the Babel plugin short name as key and a compat data entry as value. Each entry is an object with browser name as key and the minimum supported version as value. | ||
|
||
For example, `pluginsCompatData["transform-object-rest-spread"]` will return an object: | ||
|
||
```javascript title="my-babel-plugin.js" | ||
{ | ||
"chrome": "60", | ||
"opera": "47", | ||
"edge": "79", | ||
"firefox": "55", | ||
"safari": "11.1", | ||
"node": "8.3", | ||
"deno": "1", | ||
"ios": "11.3", | ||
"samsung": "8", | ||
"opera_mobile": "44", | ||
"electron": "2.0" | ||
} | ||
``` | ||
Here, the minimum Chrome version with object-rest-spread support is `60`. Therefore, `@babel/preset-env` will enable the object-rest-spread transform only if users are compiling to Chrome versions older than `60`, and likewise for other browsers. Check the [source](https://github.com/babel/babel/blob/main/packages/babel-compat-data/data/plugins.json) for supported Babel plugin short names. | ||
|
||
If you would like to know whether object-rest-spread is supported for any given `targets`, you don't have to manually compare it against the compat-data entry. Instead, you can use the [`isRequired`](./helper-compilation-targets.md#isrequired) utility from `@babel/helper-compilation-targets`: | ||
|
||
```javascript title="my-babel-plugin.js" | ||
import { isRequired } from "@babel/helper-compilation-targets"; | ||
|
||
module.exports = api => { | ||
// Check if the targets have native object-rest-spread support | ||
const objectRestSpreadSupported = !isRequired( | ||
"transform-object-rest-spread", | ||
api.targets() | ||
); | ||
}; | ||
``` |
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I didn't draft the
plugin-bugfixes
chapter since we might remove thebugfixes
option in Babel 8.