MadeComfy ESLint Config

1.0.7 verified Fri May 01 auth: no javascript maintenance

A shareable ESLint configuration package from MadeComfy, currently at version 1.0.7. It is intended for internal use across MadeComfy projects to enforce consistent code style. The package extends ESLint with a predefined rule set but has not been actively updated since 2020, which may lead to incompatibility with modern ESLint versions (ESLint 8+). It assumes code is located in ./src/ and provides minimal configuration by simply extending 'madecomfy'. Release cadence is low, with security and dependency updates in recent versions.

Common errors

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

cause eslint-config-madecomfy is not installed or not in node_modules.

fix

Run 'npm install eslint-config-madecomfy --save-dev' or 'yarn add eslint-config-madecomfy --dev'.

error Error: ESLint configuration is invalid: The 'extends' property value 'madecomfy' is not a valid configuration. ↓

cause The config string 'madecomfy' is not resolved or the config package is missing.

fix

Ensure eslint-config-madecomfy is installed and listed in devDependencies. Also verify ESLint version compatibility.

Warnings

gotcha This config is designed for ESLint 6/7 and may not work correctly with ESLint 8+ due to rule format changes. ↓

fix Pin ESLint to version 7.x or migrate to a maintained config like eslint-config-airbnb.

gotcha The config expects source code in ./src/. If your code is elsewhere, eslint will not find it. ↓

fix Modify the lint script to point to your source directory, e.g., 'lint': 'eslint src/ app/'.

Install

npm install eslint-config-madecomfy

yarn add eslint-config-madecomfy

pnpm add eslint-config-madecomfy

Imports

default config
wrong
```
require('eslint-config-madecomfy') or import statement
```
correct
```
extends: ['madecomfy'] in .eslintrc
```
This is a shareable config; it is used via the ESLint 'extends' mechanism, not imported directly.

ESLint module

wrong

Running eslint without config or without specifying source directory

correct

npx eslint src or yarn lint (after configuring script)

The config expects source files in ./src/. Ensure ESLint is installed as a dev dependency.

precommit hook (optional)

wrong

Using 'pre-commit' hook without lint-staged or incorrect glob pattern

correct

Add 'precommit': 'lint-staged' script and configure lint-staged in package.json

The config recommends husky and lint-staged for precommit linting but does not include them.

Quickstart

Minimal .eslintrc configuration to use MadeComfy ESLint config.

{
  "extends": ["madecomfy"],
  "rules": {}
}