diff --git a/eslint/babel-eslint-plugin-development-internal/README.md b/eslint/babel-eslint-plugin-development-internal/README.md index e69de29bb2d1..96a43e45571d 100644 --- a/eslint/babel-eslint-plugin-development-internal/README.md +++ b/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" + } + ] + } +} +```