75c2300c28
* Add @babel/eslint-plugin-internal * Add dry-error-messages rule * Address feedback * Enable new rule * fix author field * Fix errors * Add readme * Add example configuration * Handle directories * run make bootstrap * More updates! * Fix errors * Update tests * Fix CI race condition
71 lines
1.4 KiB
Markdown
71 lines
1.4 KiB
Markdown
# @babel/eslint-plugin-development-internal
|
|
|
|
The Babel team's custom ESLint rules for the babel/babel monorepo.
|
|
|
|
## Installation
|
|
|
|
```sh
|
|
$ npm install --save-dev @babel/eslint-plugin-development-internal
|
|
```
|
|
or
|
|
```sh
|
|
$ yarn add --save-dev @babel/eslint-plugin-development-internal
|
|
```
|
|
|
|
## Usage
|
|
|
|
The plugin can be loaded in your `.eslintrc.*` configuration file as follows: (note that you can omit the `eslint-plugin-` prefix):
|
|
|
|
```json
|
|
{
|
|
"plugins": ["@babel/development-internal"]
|
|
}
|
|
```
|
|
|
|
## Rules
|
|
|
|
### `@babel/development-internal/dry-error-messages`
|
|
|
|
Intended for use in `packages/babel-parser/src/**/*`. When enabled, this rule warns when `this.raise()` invocations raise errors that are not imported from a designated error module.
|
|
|
|
Accepts an object configuration option:
|
|
|
|
```ts
|
|
{
|
|
errorModule: string
|
|
}
|
|
```
|
|
|
|
`errorModule` (required): The rule expects either an absolute path or a module name (for a module in `node_modules`). Please note that the rule will not check anything if` errorModule` is not given.
|
|
|
|
Example configuration:
|
|
|
|
```js
|
|
{
|
|
rules: {
|
|
"@babel/development-internal/dry-error-messages": [
|
|
"error",
|
|
{
|
|
errorModule: "@babel/shared-error-messages"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
```
|
|
and
|
|
```js
|
|
{
|
|
rules: {
|
|
"@babel/development-internal/dry-error-messages": [
|
|
"error",
|
|
{
|
|
errorModule: path.resolve(
|
|
__dirname,
|
|
"packages/shared-error-messages/lib/index.js"
|
|
)
|
|
}
|
|
]
|
|
}
|
|
}
|
|
```
|