Refactor move docs (#8108)
* feat: [skip] generate readme script * docs: [skip ci] update READMEs * docs: [skip ci] fix code block type * chore: [skip ci] move generator script
This commit is contained in:
@@ -1,41 +1,19 @@
|
||||
# @babel/helper-plugin-utils
|
||||
|
||||
The intention of this module is to provide a place for us to expose a
|
||||
standardized API layer over top of what Babel's core API provides on its own.
|
||||
> General utilities for plugins to use
|
||||
|
||||
This is not aiming to implement APIs that are missing on a given Babel version,
|
||||
but it is means to provide clear error messages if a plugin is run on a version
|
||||
of Babel that doesn't have the APIs that the plugin is trying to use.
|
||||
See our website [@babel/helper-plugin-utils](https://new.babeljs.io/docs/en/next/babel-helper-plugin-utils.html) for more information.
|
||||
|
||||
Every one of Babel's core plugins and presets will use this module, and ideally
|
||||
because of that its size should be kept to a miminum because this may or may
|
||||
not be deduplicated when installed.
|
||||
## Install
|
||||
|
||||
Using npm:
|
||||
|
||||
## Usage
|
||||
|
||||
```js
|
||||
import { declare } from "@babel/helper-plugin-utils";
|
||||
|
||||
export default declare((api, options, dirname) => {
|
||||
return {};
|
||||
});
|
||||
```sh
|
||||
npm install --save @babel/helper-plugin-utils
|
||||
```
|
||||
|
||||
or using yarn:
|
||||
|
||||
## What this does
|
||||
|
||||
Currently, this plugin provides a few services to ensure that plugins function
|
||||
well-enough to throw useful errors.
|
||||
|
||||
### `options` is always passed
|
||||
|
||||
Babel 6 does not pass a second parameter. This frequently means that plugins
|
||||
written for Babel 7 that use `options` will attempt to destructure options
|
||||
out of an `undefined` value. By supplying the default, we avoid that risk.
|
||||
|
||||
### `api.assertVersion` always exists
|
||||
|
||||
Babel 6 and early betas of Babel 7 do not have `assertVersion`, so this
|
||||
wrapper ensures that it exists and throws a useful error message when not
|
||||
supplied by Babel itself.
|
||||
```sh
|
||||
yarn add --save @babel/helper-plugin-utils
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user