@lcooper/eslint-config NPM

@lcooper/eslint-config

An ESlint shareable flat config that extends eslint-config-airbnb-base.

Installation

The peer dependency eslint must be installed alongside this package.

install with npm:
npm install -D eslint @lcooper/eslint-config
install with yarn:
yarn add -D eslint @lcooper/eslint-config
Note: This project requires Eslint version >=9.3, and NodeJS version ^18.18.0 || ^20.9.0 || >=21.1.0.

Usage

Add an eslint.config.js config file to your project's root directory:

import config from '@lcooper/eslint-config';

export default [
    ...config,
];

If your project does not specify "type": "module" in its package.json file, then eslint.config.js must be in CommonJS format:

const config = require('@lcooper/eslint-config');

module.exports = [
    ...config,
];

To add browser globals for browser environments, import additional configuration from @lcooper/eslint-config/envs.

import config from '@lcooper/eslint-config';
import { browser } from '@lcooper/eslint-config/envs';

export default [
    ...config,
    browser,
];

This project is no longer compatable with the legacy eslintrc format, and requires you use the flat config format. Check out this page for more details about migrating from the eslintrc format to the flat config format.

@lcooper/eslint-plugin - Plugin with awesome extra ESLint rules used by this config
@lcooper/eslint-config-react - Enhancement config for React projects
@lcooper/eslint-config-typescript - Base config for TypeScript projects
@lcooper/eslint-config-typescript-react - Enhancement config for React projects that use TypeScript
@lcooper/eslint-config-jest - Enhancement config for projects using Jest