@culur/config-eslint

Sharing Eslint configurations.

✨ Features

The library is a shareable Eslint configuration. It has some key features as follows:

• Extends all config from @antfu/eslint-config.
• Override and add some rules according to personal opinion.
• Full customizable (use the same functions as @antfu/eslint-config).

💿 Installation

Add @culur/config-eslint dependency to your project.

# Using npm
npm install @culur/config-eslint --save-dev

# Using pnpm
pnpm install @culur/config-eslint --dev

# Using yarn
yarn add @culur/config-eslint --dev

Other packages:

• Use need to install eslint package in devDependencies.
• For inspector, you can install @eslint/config-inspector in devDependencies.

📖 Usage

In eslint.config.js, use defineConfig:

// .eslint.config.cjs
const defineConfig = require('@culur/config-eslint');

module.exports = defineConfig();

// .eslint.config.mjs
import defineConfig from '@culur/config-eslint';

export default defineConfig();

📜 Scripts

Some commonly used scripts in package.json.

{
  "scripts": {
    "fix:es": "eslint --fix",
    "lint:es": "eslint",
    "lint:es-in": "eslint-config-inspector"
  }
}

🗃️ Changelog

See CHANGELOG for more information on what has changed recently.

🔒 License

See LICENSE for license rights and limitations (MIT).