eslint-config-eyeo

3.2.0 verified Sat Apr 25 auth: no javascript

ESLint shareable config enforcing eyeo/Adblock Plus JavaScript coding style. Version 3.2.0, with ESLint >=6.7.0 as a peer dependency. Provides a consistent linting base for all eyeo projects, including Adblock Plus. It is a flat, unopinionated rule set that can be extended. Released as needed; no frequent updates. Unlike generic configs (e.g., eslint-config-standard), it is tailored to eyeo's internal style guide.

Common errors

error Cannot find module 'eslint-config-eyeo' ↓

cause Config not installed or not in node_modules.

fix

Run 'npm install --save-dev eslint-config-eyeo' in the project.

error Configuration for rule "xyz" is invalid: Severity should be one of the following: 0 = off, 1 = warning, 2 = error ↓

cause User overrides rule with invalid severity.

fix

Use integer severity: 0, 1, or 2.

error ESLint couldn't find the config "eslint-config-eyeo" to extend from. ↓

cause Config name typo or not installed.

fix

Check spelling and ensure package is installed. Must be 'eslint-config-eyeo'.

error Error: Cannot find module 'eslint-config-eyeo' from '/path/to/project' ↓

cause Config not in node_modules or missing peer dependency eslint.

fix

Install both eslint and eslint-config-eyeo locally.

Warnings

gotcha Requires ESLint >=6.7.0. Older ESLint versions will fail to parse the config. ↓

fix Update ESLint to >=6.7.0.

breaking Config uses ESLint's new config format (array of objects) which may not be compatible with older ESLint plugins expecting rc-style config. ↓

fix Ensure all ESLint plugins support ESLint's flat config if using eslint.config.js.

gotcha Global installation is discouraged; prefer local devDependencies to avoid version conflicts across projects. ↓

fix Install eslint and eslint-config-eyeo as devDependencies in each project and run via npx eslint.

deprecated The config extends base rules; any overrides must be explicitly set in user config. ↓

fix Add rules object in .eslintrc.json to override.

Install

npm install eslint-config-eyeo

yarn add eslint-config-eyeo

pnpm add eslint-config-eyeo

Imports

eslint-config-eyeo
wrong
```
module.exports = {
  extends: ['eslint-config-eyeo'],
  root: true
}
```
correct
```
module.exports = {
  extends: 'eslint-config-eyeo',
  root: true
}
```
Use a single string in extends, not array, for shareable configs. This works with .eslintrc.* or eslintConfig in package.json.
CLI usage
wrong
```
eslint --config eslint-config-eyeo some-file.js
```
correct
```
eslint some-file.js
```
The config is inherited via extends, not passed directly as a config file.
Global install
wrong
```
npm install -g eslint-config-eyeo
```
correct
```
npm install -g eslint eslint-config-eyeo
```
eslint must be installed globally alongside the config to use the CLI globally. For local projects, install both as devDependencies.

Quickstart

Setup ESLint with eyeo config. Create .eslintrc.json with extends, then run eslint from CLI or script.

// .eslintrc.json
{
  "extends": "eslint-config-eyeo",
  "root": true
}

// package.json script
"scripts": {
  "lint": "eslint ."
}