eslint-config-aqua

9.2.1 verified Sat Apr 25 auth: no javascript

A popular ESLint shareable config providing comprehensive linting rules for JavaScript, Node.js, React, Vue, Svelte, JSX, and Prettier integration. Current stable version is 9.2.1, with regular updates tracked on npm. Key differentiators: offers platform-specific configs via simple extends paths, supports both browser and Node environments, and includes optional Prettier configuration to disable conflicting ESLint rules. Requires Node >=10. Actively maintained with frequent dependency upgrades.

Common errors

error Could not find config "aqua". ↓

cause ESLint cannot locate the shareable config because it is not installed or not referenced correctly.

fix

Ensure eslint-config-aqua is installed: npm i -D eslint-config-aqua. Verify package.json or .eslintrc extends field.

error Configuration for rule "no-console" is invalid ↓

cause Conflict between eslint-config-aqua rules and user's own rules or Prettier config.

fix

Check for overlapping rules; use 'aqua/prettier' to disable formatting rules if using Prettier.

error ESLint couldn't find the plugin "eslint-plugin-vue". ↓

cause Missing required plugin for Vue config.

fix

Install required plugin: npm i -D eslint-plugin-vue (and babel-eslint).

error Error: Failed to load config "aqua/node" to extend from. ↓

cause Typo in extends path or package not installed.

fix

Use correct path: "aqua/node" (case-sensitive). Ensure package is installed.

Warnings

breaking In v8.0.0, all prettier configs require your own .prettierrc file. ↓

fix Create a .prettierrc file in your project root with your desired Prettier options.

deprecated The v7.x series used an older dependency pattern; upgrade to v8+ for latest. ↓

fix Update to v9.2.1 and follow new Prettier config requirements.

gotcha The Vue config requires additional installation of babel-eslint and eslint-plugin-vue; missing them will break. ↓

fix Run: npm i -D babel-eslint eslint-plugin-vue

gotcha The Prettier configs require eslint-plugin-prettier and eslint-config-prettier; missing will cause errors. ↓

fix Install: npm i -D prettier eslint-plugin-prettier eslint-config-prettier

gotcha Using 'aqua' without specifying env may result in warnings about browser/Node globals. ↓

fix Add env: { browser: true } or extend 'aqua/node' for Node projects.

breaking v7.x to v8.0.0 removed embedded prettier config; users must supply their own .prettierrc. ↓

fix Upgrade to v9.2.1 and create .prettierrc file.

Install

npm install eslint-config-aqua

yarn add eslint-config-aqua

pnpm add eslint-config-aqua

Imports

aqua

wrong

import config from 'eslint-config-aqua'; // Incorrect: cannot import directly

correct

// In .eslintrc or package.json:
{ "extends": "aqua" }

This is a shareable config, used via extends in ESLint configuration, not imported in code.

aqua/node
wrong
```
{ "extends": "aqua-node" }
```
correct
```
{ "extends": "aqua/node" }
```
Use path format with slash for sub-configs. 'aqua/node' targets Node.js environment.
aqua/prettier
wrong
```
{ "extends": "aqua/prettier/base" }
```
correct
```
{ "extends": "aqua/prettier" }
```
Prettier configs require installation of prettier, eslint-plugin-prettier, and eslint-config-prettier.
aqua/react
wrong
```
{ "extends": "aqua/react/base" }
```
correct
```
{ "extends": "aqua/react" }
```
React config enables React specific rules, use with project containing JSX.
aqua/vue
wrong
```
{ "extends": "aqua-vue" }
```
correct
```
{ "extends": "aqua/vue" }
```
Vue config requires additional installation of babel-eslint and eslint-plugin-vue.

Quickstart

Shows installation and configuration of eslint-config-aqua with base, Node, and Prettier setups.

// 1. Install
npm i -D eslint-config-aqua

// 2. Configure .eslintrc.json
{
  "extends": "aqua",
  "env": {
    "browser": true,
    "node": true
  }
}

// 3. Alternatively use platform-specific config
{
  "extends": "aqua/node"
}

// 4. For Prettier, also install:
npm i -D prettier eslint-plugin-prettier eslint-config-prettier
// Then in .eslintrc.json:
{
  "extends": "aqua/prettier"
}
// And create .prettierrc with your rules.