ESLint-Config 🎯

Comprehensive ESLint configuration with TypeScript, React, and NestJS support using ESLint Flat config

📚 Table of Contents

• Description
• Features
• Installation
• Usage
• Roadmap
• FAQ
• License

📖 Description

ESLint-Config is a powerful, extensible ESLint configuration system designed for modern JavaScript and TypeScript projects. It provides a robust set of rules and configurations that help maintain code quality and consistency across different frameworks and environments. The configuration is particularly optimized for TypeScript, React, and NestJS applications, offering specialized rules and best practices for each ecosystem.

🚀 Features

• ✨ Modular configuration system with support for multiple frameworks
• ✨ Comprehensive TypeScript support with strict type checking
• ✨ Advanced React hooks and component validation rules
• ✨ NestJS-specific rules for better API documentation and controller structure
• ✨ Integration with Prettier for consistent code formatting
• ✨ Support for modern JavaScript features and best practices
• ✨ Custom naming conventions for different code elements
• ✨ Specialized rules for JSON, YAML, and package.json files
• ✨ Automatic import sorting and organization
• ✨ File naming convention enforcement

🛠 Installation

npm install --save-dev @elsikora/eslint-config

# Install peer dependencies
npm install --save-dev eslint typescript @typescript-eslint/parser @typescript-eslint/eslint-plugin

💡 Usage

Configuration Usage

Basic Setup

Create an eslint.config.js file in your project root:

import createConfig from "@elsikora/eslint-config";

export default await createConfig({
    withTypescript: true,
    withPrettier: true,
});

TypeScript Configuration

For TypeScript projects, enable specific features:

import createConfig from "@elsikora/eslint-config";

export default await createConfig({
    withTypescript: true,
    withPrettier: true,
    withSonar: true,
    withStylistic: true,
});

React Configuration

For React projects:

import createConfig from "@elsikora/eslint-config";

export default await createConfig({
    withTypescript: true,
    withReact: true,
    withPrettier: true,
    withTailwindCss: true,
});

NestJS Configuration

For NestJS applications:

import createConfig from "@elsikora/eslint-config";

export default await createConfig({
    withTypescript: true,
    withNest: true,
    withPrettier: true,
    withTypeorm: true,
});

CLI Usage

Add scripts to your package.json:

{
    "scripts": {
        "lint": "eslint .",
        "lint:fix": "eslint . --fix"
    }
}

Advanced Configuration

Combine multiple configurations:

import createConfig from "@elsikora/eslint-config";

export default await createConfig({
    withTypescript: true,
    withReact: true,
    withNest: true,
    withPrettier: true,
    withSonar: true,
    withStylistic: true,
    withPerfectionist: true,
    withUnicorn: true,
});

🛣 Roadmap

❓ FAQ

Frequently Asked Questions

How does this differ from standard ESLint configurations?

This configuration provides a more comprehensive and opinionated set of rules specifically tailored for TypeScript, React, and NestJS projects, with additional focus on code quality and maintainability.

Can I use this with Create React App?

Yes, the configuration is compatible with Create React App projects. You'll need to eject or use tools like CRACO to override the default ESLint configuration.

How do I override specific rules?

You can extend the configuration and override rules in your eslint.config.js file by adding custom rule configurations after the default export.

Does this work with VS Code?

Yes, the configuration works seamlessly with VS Code's ESLint extension. Just ensure you have the ESLint extension installed and properly configured.

🔒 License

This project is licensed under MIT License - Copyright (c) 2025 ElsiKora.

📋 Changelog

See CHANGELOG.md for details.