@eslint/compat weekly downloads statistics

ESLint Compatibility Utilities

Overview

This package contains functions that allow you to wrap existing ESLint rules, plugins, and configurations that were intended for use with ESLint v8.x or v9.x to allow them to work as-is in ESLint v9.x and v10.x.

Note: All plugins are not guaranteed to work in ESLint v9.x or v10.x. This package fixes the most common issues but can't fix everything.

Installation

For Node.js and compatible runtimes:

For Deno:

Usage

This package exports the following functions in both ESM and CommonJS format:

• fixupRule(rule) - wraps the given rule in a compatibility layer and returns the result • fixupPluginRules(plugin) - wraps each rule in the given plugin using fixupRule() and returns a new object that represents the plugin with the fixed-up rules • fixupConfigRules(configs) - wraps all plugins found in an array of config objects using fixupPluginRules() • includeIgnoreFile(path) (deprecated) - reads an ignore file (like .gitignore) and converts the patterns into the correct format for the config file

Fixing Rules

If you have a rule that you'd like to make compatible with ESLint v9.x or v10.x, you can do so using the fixupRule() function:

Or in CommonJS:

Fixing Plugins

If you are using a plugin in your eslint.config.js that is not yet compatible with ESLint v9.x or v10.x, you can wrap it using the fixupPluginRules() function:

Or in CommonJS:

Fixing Configs

If you are importing other configs into your eslint.config.js that use plugins that are not yet compatible with ESLint v9.x or v10.x, you can wrap the entire array or a single object using the fixupConfigRules() function:

Or in CommonJS:

Including Ignore Files

Deprecated: The includeIgnoreFile() exported by this package has been deprecated (eslint/rewrite#329). Use the includeIgnoreFile() function exported by @eslint/config-helpers instead (also available at eslint/config). This section is only preserved for historical reference.

If you were using an alternate ignore file in ESLint v8.x, such as using --ignore-path .gitignore on the command line, you can include those patterns programmatically in your config file using the includeIgnoreFile() function.

The includeIgnoreFile() function also accepts a second optional name parameter that allows you to set a custom name for this configuration object. If not specified, it defaults to "Imported .gitignore patterns". For example:

Or in CommonJS:

Limitation: This works without modification when the ignore file is in the same directory as your config file. If the ignore file is in a different directory, you may need to modify the patterns manually.

License

Apache 2.0

Sponsors

The following companies, organizations, and individuals support ESLint's ongoing maintenance and development. Become a Sponsor to get your logo on our READMEs and website.

Platinum Sponsors

Gold Sponsors

Silver Sponsors

Bronze Sponsors

Technology Sponsors

Technology sponsors allow us to use their products and services for free as part of a contribution to the open source ecosystem and our work.

Description from the npm listing.