@useinsider/eslint-config v1.2.0

ESLint Configurations

Table of Contents

• ESLint Configurations
  • Table of Contents
  • Getting Started
    • Installation
  • Versioning Policy
  • Available Configurations
    • Vanilla 🍦
    • Framework-specific
    • ⏳ Upcoming Configurations
  • Contributing

Getting Started

To ensure consistency and prevent version conflicts, we recommend adding this library as a development dependency with a fixed version. This can be achieved using the -D and -E flags in your package manager commands.

Installation

1. Install as a Development Dependency:
   • For pnpm users:

     pnpm add -D -E @useinsider/eslint-config

   • For npm users:

     npm install -D -E @useinsider/eslint-config

2. Create an ESLint config file: You'll need an ESLint config file in your projects root directory.

   You can check the official ESLint documentation to get more details.

3. Extend the Configuration: Add the following to your .eslintrc file to extend the configuration:

   {
     "extends": ["@useinsider/eslint-config/dom"],
     // Add the rest of your configuration here
   }

Versioning Policy

This project follows the Semantic Versioning policy.

Available Configurations

We provide a variety of configurations to suit different environments and frameworks. Here's a list of available configurations:

Vanilla 🍦

Framework-specific

⏳ Upcoming Configurations

Not available yet!

Contributing

Please refer to the CONTRIBUTING.md file for guidelines on how to contribute to this project.