@eslint/eslintrc
Advanced tools
Package description
The @eslint/eslintrc package is a utility for working with ESLint configuration files. It provides tools to load and parse ESLint configuration files, resolve extends chains, and manage configuration cascading and hierarchy.
Loading ESLint Configuration
This feature allows you to load an ESLint configuration file using the ConfigArrayFactory class. The loaded configuration can then be used to configure the ESLint engine.
const { ConfigArrayFactory } = require('@eslint/eslintrc');
const factory = new ConfigArrayFactory();
const configArray = factory.loadFile('.eslintrc.js');Parsing Configuration Files
This feature is used to parse ESLint configuration files directly. It is part of the legacy API and allows for direct interaction with configuration files.
const { Legacy: { ConfigFile } } = require('@eslint/eslintrc');
const config = ConfigFile.load('.eslintrc');Resolving Extends Chains
This feature resolves the 'extends' chains in ESLint configuration files, allowing you to get the final configuration that applies to a specific file, taking into account all the extended configurations.
const { CascadingConfigArrayFactory } = require('@eslint/eslintrc');
const factory = new CascadingConfigArrayFactory();
const configArray = factory.getConfigArrayForFile('some-file.js');The 'eslint' package is the core linting library that provides the primary functionality for linting JavaScript code. It includes the ability to load and interpret configuration files, which @eslint/eslintrc also does, but as a separate utility focused on configuration management.
The 'eslint-config-prettier' package is an ESLint configuration that disables rules that might conflict with Prettier. While it does not provide utilities for managing configurations, it is an example of a package that extends ESLint's configuration capabilities.
The 'eslint-plugin-import' package is a plugin that provides linting rules related to ES6+ import/export syntax. It extends ESLint's functionality with additional rules, similar to how @eslint/eslintrc extends configuration management capabilities.
Readme
This repository contains the legacy ESLintRC configuration file format for ESLint. This package is not intended for use outside of the ESLint ecosystem. It is ESLint-specific and not intended for use in other programs.
Note: This package is frozen except for critical bug fixes as ESLint moves to a new config system.
You can install the package as follows:
npm install @eslint/eslintrc --save-dev
# or
yarn add @eslint/eslintrc -D
The primary class in this package is FlatCompat, which is a utility to translate ESLintRC-style configs into flat configs. Here's how you use it inside of your eslint.config.js file:
import { FlatCompat } from "@eslint/eslintrc";
import path from "path";
import { fileURLToPath } from "url";
// mimic CommonJS variables -- not needed if using CommonJS
const __filename = fileURLToPath(import.meta.url);
const __dirname = path.dirname(__filename);
const compat = new FlatCompat({
baseDirectory: __dirname, // optional; default: process.cwd()
resolvePluginsRelativeTo: __dirname // optional
});
export default [
// mimic ESLintRC-style extends
...compat.extends("standard", "example"),
// mimic environments
...compat.env({
es2020: true,
node: true
}),
// mimic plugins
...compat.plugins("airbnb", "react"),
// translate an entire config
...compat.config({
plugins: ["airbnb", "react"],
extends: "standard",
env: {
es2020: true,
node: true
},
rules: {
semi: "error"
}
})
];
MIT License
FAQs
The legacy ESLintRC config file format for ESLint
The npm package @eslint/eslintrc receives a total of 26,402,468 weekly downloads. As such, @eslint/eslintrc popularity was classified as popular.
We found that @eslint/eslintrc demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.
Security News
GitHub is susceptible to a CDN flaw that allows attackers to host malware on any public repository.
Security News
At Node Congress, Socket CEO Feross Aboukhadijeh uncovers the darker aspects of open source, where applications that rely heavily on third-party dependencies can be exploited in supply chain attacks.