ESLint Configurations

Table of Contents

• ESLint Configurations
  • Table of Contents
  • Prerequisites
  • Available Presets
    • Vanilla 🍦
    • Library-specific & Standalone Configs
    • Framework-specific
    • ⏳ Upcoming Configurations
  • Examples
  • Troubleshooting
    • Missing dependencies detected:
  • Contributing

Prerequisites

• NodeJS 20+
• ESLint 9+

Available Presets

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

Vanilla 🍦

There are additional presets for DOM (browser) and Node.js environments, beside the vanilla configuration. The vanilla is suitable for general JavaScript and TypeScript projects that does not have any specific environment and can be configured for different environments, such as ServiceWorkers, WebWorkers, etc.

| Environment | Vanilla | Browser (DOM) | Node | | :---------------- | :---------------------------------------------- | :------------------------------------------------------ | :-------------------------------------------------------- | | EcmaScript/JS | javascript | javascript-dom | javascript-node | | TypeScript | typescript | typescript-dom | typescript-node |

Library-specific & Standalone Configs

| Environment | JavaScript & TypeScript | | :--------------- | :-------------------------------------- | | Config files | config | | Jest | jest | | Strict | strict |

Framework-specific

| Environment | JavaScript | TypeScript | | :-------------------------------- | :-------------------------------------------------------- | :-------------------------------------------------------- | | Vue 3 (Setup/Composition API) | vue3 | vue3-typescript | | Vue 2 (Setup/Composition API) | vue2-typescript | vue2-typescript | | Vue 2 (Options API) | vue2 | - |

⏳ Upcoming Configurations

Planned configurations for the next

• Legacy ES5 💀​

Examples

Checkout the examples directory to see various apps with the extended ESLint configuration.

Troubleshooting

Missing dependencies detected:

If you see this error, it means that the configuration you are trying to use has some dependencies that are not installed in your project. You can install them by running the command that it provides.

If you want to silence the warning, you can add the following code to your ESLint config file.

import { useInsider, silenceDependencyWarning } from '@useinsider/eslint-config';

silenceDependencyWarning(['@cspell/eslint-plugin', '@stylistic/eslint-plugin']);

Or you can pass true to the silenceDependencyWarning function to silence all warnings.

However, this is not recommended as it may cause unexpected issues while maintaining the dependencies.

import { useInsider, silenceDependencyWarning } from '@useinsider/eslint-config';

silenceDependencyWarning(true);

Contributing

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