Registry / testing / eslint-config-ipfs

eslint-config-ipfs

library8.0.0jsnpmunverified

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.

testing devops

npm install eslint-config-ipfs

github ↗package ↗

INSTALL

IMPORT

SIG · ESLINT-CONFIG-IPFS

eslint-config-ipfs

testingjavascriptv8.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.

config (default)

✓ extends: 'ipfs'

✗ extends: 'eslint-config-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

✓ npm install eslint-config-ipfs

✗ npm install eslint-config-ipfs --global

Install as devDependency. Then create .eslintrc with extends: 'ipfs'. You may also need to install typescript and eslint-plugin-* dependencies manually.

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 .

Debug

Known issues

breakingv7.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.

affects: >=7.0.0

breakingv8.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.

affects: >=8.0.0

deprecatedeslint-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.

affects: >=7.0.0

gotchaThe 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.

affects: all

gotchaIf 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.

affects: all

Errors

Common errors & fixes

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

Package not installed or not listed in devDependencies.

fix

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

ESLint couldn't find the config 'ipfs'

The config name is incorrect or missing in extends.

fix

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

Parsing error: Cannot read file 'tsconfig.json'

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.

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

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

fix

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

Upgrade

Version history

8.0.0latest on npm

Audit

Dependencies

typescriptoptionalPeer dependency required when linting TypeScript files; rules depend on typescript parser.

Agent activity

2 hits · last 30 days

node

Resources

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

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