1.9.0 • Published 6 months ago

@estarlincito/eslint v1.9.0

Weekly downloads
-
License
MIT
Repository
github
Last release
6 months ago

@estarlincito/eslint

@estarlincito/eslint is a flexible ESLint configuration package that provides multiple pre-configured setups for different project types. It includes:

  • baseConfig: A general-purpose ESLint setup for JavaScript and TypeScript projects.
  • nextJsConfig: An extended configuration optimized for Next.js applications.

🛠 Available configurations

🔹 baseConfig

🔹 nextJsConfig

📌 Features

  • Multiple configurations tailored for different use cases.
  • Extends best practices with @typescript-eslint, prettier, import, and more.
  • Includes essential plugins like safeguard, sort-keys-fix, and unused-imports.
  • Ensures clean, maintainable, and performant code.

🚀 Installation

Install the package using pnpm, npm, or yarn:

pnpm add -D eslint @estarlincito/eslint
npm install --save-dev eslint @estarlincito/eslint
yarn add -D eslint @estarlincito/eslint

🛠 Configuration

You can choose the appropriate configuration based on your project needs.

Base Configuration

For JavaScript or TypeScript projects, use baseConfig:

Flat Config Setup eslint.config.js

import { baseConfig } from '@estarlincito/eslint';

export default baseConfig;

Next.js Configuration

For Next.js projects, use nextJsConfig:

.eslintrc.js

module.exports = {
  extends: '@estarlincito/eslint',
};

Flat Config Setup

import { nextJsConfig } from '@estarlincito/eslint';

export default nextJsConfig;

⚡ Usage

Run ESLint with your package manager:

pnpm eslint .
npm run eslint .
yarn eslint .

🛠 How It Works

  • baseConfig: Ensures general best practices for JavaScript and TypeScript.
  • nextJsConfig: Builds upon baseConfig and adds Next.js optimizations.
  • Uses prettier for formatting consistency.
  • Detects unused imports automatically with unused-imports.
  • Enforces better error handling using safeguard.

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

Author: Estarlin R (estarlincito.com)