Skip to content

Commit

Permalink
Add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
kaicataldo committed Jun 22, 2020
1 parent ac04081 commit bc991ac
Showing 1 changed file with 38 additions and 0 deletions.
38 changes: 38 additions & 0 deletions eslint/babel-eslint-plugin-development-internal/README.md
@@ -0,0 +1,38 @@
# @babel/eslint-plugin-development-internal

A set of internal ESLint rules to enforce best practices in the Babel monorepo.

## Usage

The plugin can be loaded in your `.eslintrc.*` configuration file. You can omit the `eslint-plugin-` prefix, like so:

```json
{
"plugins": ["@babel/development-internal"]
}
```

## Supported Rules

> Note: Rules marked with :wrench: are autofixable.
### `@babel/development-internal/dry-error-messages` (:wrench:)

Enforce @babel/parser's error messages to be consolidated in one module.

Configuration options:

* `errorModule` (string, required): The rule must be configured with the path to the module containing error messages.

```json
{
"rules": {
"@babel/development-internal/dry-error-messages": [
"error",
{
"errorModule": "packages/babel-parser/src/parser/location.js"
}
]
}
}
```

0 comments on commit bc991ac

Please sign in to comment.