Registry / testing / eslint-config-algolia

eslint-config-algolia

library24.0.0jsnpmunverified

ESLint shareable config by Algolia for enforcing consistent code style across JavaScript, TypeScript, React, and Vue projects. v24.0.0 supports ESLint 5–9 and requires Prettier 3.x and @stylistic/eslint-plugin. Includes flat config support for ESLint 9. Provides preset for Vanilla, Jest, React, TypeScript, TypeScript+React, and Vue. Deprecated Flow support. Differentiator: opinionated, all-in-one setup with autofix and IDE integration.

testing

npm install eslint-config-algolia

github ↗package ↗

INSTALL

IMPORT

SIG · ESLINT-CONFIG-ALGO

eslint-config-algolia

testingjavascriptv24.0.0

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

algolia/base

✓ const algolia = require('eslint-config-algolia/flat/base');

✗ import algolia from 'eslint-config-algolia/flat/base';

ESLint 9 flat config: use require for CommonJS.

algolia/react

✓ const algoliaReact = require('eslint-config-algolia/flat/react');

✗ const algoliaReact = require('eslint-config-algolia/react');

Flat config requires /flat/ prefix; legacy .eslintrc.js uses 'algolia/react'.

default legacy config

✓ extends: 'algolia'

✗ extends: 'eslint-config-algolia'

For .eslintrc.js, use shorthand 'algolia', not full package name.

TypeScript flat config

✓ const algoliaTS = require('eslint-config-algolia/flat/typescript');

✗ const algoliaTS = require('eslint-config-algolia/typescript');

Flat config path includes /flat/; legacy is 'algolia/typescript'.

Jest flat config

✓ const algoliaJest = require('eslint-config-algolia/flat/jest');

✗ const algoliaJest = require('eslint-config-algolia/jest');

Requires eslint-plugin-jest installed separately.

Setup for TypeScript project with ESLint flat config and Prettier.

// Install base dependencies yarn add eslint @babel/eslint-parser prettier eslint-config-algolia eslint-config-prettier eslint-plugin-import eslint-plugin-prettier @eslint-community/eslint-plugin-eslint-comments eslint-plugin-jsdoc @stylistic/eslint-plugin --dev // For TypeScript, add these as well: yarn add @typescript-eslint/parser @typescript-eslint/eslint-plugin typescript --dev // Create eslint.config.js: const algolia = require('eslint-config-algolia/flat/base'); const algoliaTS = require('eslint-config-algolia/flat/typescript'); module.exports = [ ...algolia, ...algoliaTS, ]; // Add scripts to package.json: { "scripts": { "lint": "eslint .", "lint:fix": "eslint . --fix" } }

Debug

Known issues

breakingESLint 9 requires flat config; eslintrc.js is deprecated.

fix

Use eslint.config.js with require('eslint-config-algolia/flat/...') presets.

affects: >=20.0.0

deprecatedFlow presets (algolia/flowtype) are deprecated and may be removed in future versions.

fix

Migrate to TypeScript or remove Flow preset.

affects: >=18.0.0

gotchaFlat config presets must be spread (...algolia) because they are arrays.

fix

Use module.exports = [ ...algolia, ...others ];

affects: >=20.0.0

gotchaRequires prettier 3.x as peer dependency – older prettier versions are incompatible.

fix

Update prettier to ^3.0.0.

affects: >=24.0.0

gotchaAdditional plugins (like react, typescript) must be installed separately; they are not included as dependencies.

fix

Install eslint-plugin-react, @typescript-eslint/eslint-plugin, etc. as dev dependencies.

affects: >=1.0.0

Errors

Common errors & fixes

Error: Cannot find module 'eslint-config-algolia/flat/base'

Package version too old (pre-20) or wrong path.

fix

Update eslint-config-algolia to >=20.0.0, and use correct path: require('eslint-config-algolia/flat/base')

Parsing error: The keyword 'const' is reserved

Using Babel parser without proper config or missing @babel/eslint-parser.

fix

Install @babel/eslint-parser and set parser in config.

Failed to load plugin 'import' declared in 'eslint-config-algolia/base': Cannot find module 'eslint-plugin-import'

Missing required plugin.

fix

Run: yarn add eslint-plugin-import --dev

TypeError: algolia is not a function (or cannot spread a non-iterable)

In flat config, the preset is an array, but user imported incorrectly.

fix

Use: const algolia = require('eslint-config-algolia/flat/base'); module.exports = [ ...algolia ];

Error: Failed to load config "algolia/typescript" from extended config

Using .eslintrc.js extends with flat config path.

fix

For .eslintrc.js use 'algolia/typescript' (without /flat/). For flat config use require('.../flat/typescript').

Upgrade

Version history

24.0.0latest on npm

Audit

Dependencies

eslintrequiredpeer dependency for ESLint config

prettierrequiredpeer dependency for Prettier integration

@stylistic/eslint-pluginrequiredpeer dependency for Stylistic ESLint rules

Agent activity

2 hits · last 30 days

node

Resources

githubhttps://github.com/algolia/eslint-config-algolia ↗

packagehttps://www.npmjs.com/package/eslint-config-algolia ↗