eslint-config-ipfs

8.0.0 verified Sat Apr 25 auth: no javascript

ESLint Shareable Config for IPFS project. Current stable version: 8.0.0. Release cadence: irregular, with major version bumps for breaking changes. Provides a curated set of ESLint rules tailored for JavaScript/TypeScript libraries in the IPFS ecosystem. Differentiators: built on eslint-config-love (replacing deprecated eslint-config-standard-with-typescript), enforces consistent type imports, and integrates seamlessly with AEgir build tool. Supports both .js and .ts files with separate rule sets. Requires Node >=16 and optional TypeScript peer dependency.

Common errors

error Error: Cannot find module 'eslint-config-ipfs' ↓

cause Package not installed or not listed in devDependencies.

fix

Run npm install --save-dev eslint-config-ipfs.

error ESLint couldn't find the config 'ipfs' ↓

cause The config name is incorrect or missing in extends.

fix

Ensure your .eslintrc has "extends": "ipfs" (without the 'eslint-config-' prefix).

error Parsing error: Cannot read file 'tsconfig.json' ↓

cause TypeScript parser requires tsconfig.json, but none is present or configured.

fix

Create a tsconfig.json file in your project root. Alternatively, set parserOptions.project: false in your ESLint overrides for TS files.

error Definition for rule '@typescript-eslint/consistent-type-imports' was not found ↓

cause The required eslint-plugin-@typescript-eslint is missing or outdated.

fix

Install/update: npm install --save-dev @typescript-eslint/eslint-plugin.

Warnings

breaking v7.0.0 replaced eslint-config-standard-with-typescript with eslint-config-love. This may cause new rule violations. ↓

fix Run eslint --fix to auto-fix new rules. Review any remaining errors manually.

breaking v8.0.0 enforces consistent type import style (e.g., import type vs inline type). ↓

fix Run eslint --fix to automatically update imports to match new rule.

deprecated eslint-config-standard-with-typescript is deprecated and replaced by eslint-config-love. ↓

fix Update to v7+ which uses eslint-config-love. If on v6, migrate to v7 or adopt eslint-config-love directly.

gotcha The package name for extending is 'ipfs', not 'eslint-config-ipfs'. Wrong name causes ESLint to fail loading config. ↓

fix Use extends: 'ipfs' in your ESLint config.

gotcha If not using AEgir, you must manually install TypeScript and satisfy all peer dependencies (e.g., eslint-plugin-*). ↓

fix Run `npm install typescript` and check for missing plugin warnings. Consider using AEgir to avoid this.

Install

npm install eslint-config-ipfs

yarn add eslint-config-ipfs

pnpm add eslint-config-ipfs

Imports

config (default)
wrong
```
extends: 'eslint-config-ipfs'
```
correct
```
extends: 'ipfs'
```
In ESLint, config names are shortened to the package name without 'eslint-config-' prefix. This works in .eslintrc or package.json eslintConfig.
use with AEgir
```
Using AEgir automatically includes this config. No extra setup needed.
```
AEgir is the monolithic build tool that includes eslint-config-ipfs. If you use AEgir, you don't need to manually install this package.
manual setup without AEgir
wrong
```
npm install eslint-config-ipfs --global
```
correct
```
npm install eslint-config-ipfs
```
Install as devDependency. Then create .eslintrc with extends: 'ipfs'. You may also need to install typescript and eslint-plugin-* dependencies manually.

Quickstart

Basic setup to use eslint-config-ipfs in any project. Install as devDependency, create .eslintrc with extends key, then lint.

// 1. Install
npm install --save-dev eslint-config-ipfs

// 2. Create .eslintrc.json
{
  "extends": "ipfs"
}

// 3. Run ESLint
npx eslint .