@logicer/eslint-plugin

Logicer's ESLint Base Configuration

Logicer's ESLint configuration as a plugin for use in other projects. Designed to be built upon for the project's specific needs. For use in flat config files.

Contents:

• Install
• Usage
  • Options
    • javascript
    • typescript
    • prettier
    • jsdoc
    • svelte
  • Predefined Configs
    • recommended
    • recommended-prettier
    • recommended-typescript

Install

npm install --save-dev eslint @logicer/eslint-plugin

Usage

In your eslint.config.js:

import {ConfigGenerator} from "@logicer/eslint-plugin";

const generator = new ConfigGenerator({
  javascript: true, // or false
  jsdoc: true, // or false
  prettier: true, // or false
  svelte: true, // or false
  typescript: true // or false
});

const config = [
  ...(await generator.config),
  // <Your custom config>
  ...(await generator.endConfig)
];

export default config;

Options

javascript

Automatically configures:

• "@eslint/js".configs.recommended
• "eslint-plugin-n".configs["flat/mixed-esm-and-cjs"] and "eslint-plugin-n"configs["flat/recommended"] for all other files
• "eslint-plugin-unicorn".configs["flat/recommended"]
• plugin:regexp/recommended (via FlatCompat)
• plugin:import/recommended (via FlatCompat)

typescript

Automatically enables javascript. Configures @typescript-eslint/parser and enables, in this order:

• plugin:@typescript-eslint/strict-type-checked (via FlatCompat)
• plugin:@typescript-eslint/stylistic-type-checked (via FlatCompat)
• plugin:deprecation/recommended (via FlatCompat)
• plugin:import/typescript (via FlatCompat)

prettier

Automatically configures plugin:prettier/recommended

See also svelte

jsdoc

Automatically configures plugin:jsdoc/recommended-typescript-error for TypeScript and flat/recommended-typescript-flavor-error for JavaScript.

svelte

Automatically configures plugin:svelte/recommended. If prettier is also set, it also configures plugin:svelte/prettier.

Predefined Configs

This plugin comes with some predefined configurations, generated with the following options:

recommended

{
  javascript: true,
  jsdoc: true
}

recommended-prettier

{
  javascript: true,
  jsdoc: true,
  prettier: true
}

recommended-typescript

{
  javascript: true,
  jsdoc: true,
  typescript: true
}