@useinsider/eslint-config

ESLint Configurations

Table of Contents

• ESLint Configurations
  • Table of Contents
  • Getting Started
    • Installation
  • Versioning Policy
  • Available Configurations
    • Vanilla 🍦
    • Framework-specific
    • ⏳ Upcoming Configurations
      • Vanilla 🍦
      • Framework-specific
  • 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 🍦

Environment	Browser (DOM)	Node
EcmaScript/JS	@useinsider/eslint-config/dom	@useinsider/eslint-config @useinsider/eslint-config/node
TypeScript	@useinsider/eslint-config/typescript-dom	@useinsider/eslint-config/typescript
Config files		@useinsider/eslint-config/config

Framework-specific

Environment	JavaScript	TypeScript
Vue 3	@useinsider/eslint-config/vue3	@useinsider/eslint-config/vue3-typescript

---

⏳ Upcoming Configurations

Not available yet!

Vanilla 🍦

Environment	Browser (DOM)	Node
Legacy ES5 💀​	@useinsider/eslint-config/legacy-dom	@useinsider/eslint-config/legacy

Framework-specific

Environment	JavaScript	TypeScript
Vue 2	@useinsider/eslint-config/vue2	@useinsider/eslint-config/vue2-typescript

Contributing

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