@ridedott/eslint-config

eslint-config

Safety-oriented, fp-first configuration of ESLint.

Usage

Basic setup

To use this configuration, install it as a devDependency first, alongside ESLint itself:

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

Once it is finished, add an ESLint configuration to your project in a top-level eslint.config.js file.

IMPORTANT: Starting from @ridedott/eslint-config@3, the exported configuration is a flat config (see ESLint docs for more details). To use it, please migrate your project's configuration to flat config as well.

Multiple versions of the configuration are exported:

• jest: the default export, for projects using Jest
• vitest: the configuration for projects using Vitest
• jest-esm: the configuration for projects using Jest with ESM
• vitest-esm: the configuration for projects using Vitest with ESM

An example configuration (using the default export) would look like this:

import sharedConfig from '@ridedott/eslint-config';
// equivalent to each of the following:
// import { jest as sharedConfig } from '@ridedott/eslint-config';
// import sharedConfig from '@ridedott/eslint-config/jest';

export default [
  ...sharedConfig,
  {
    rules: {
      // An example override for a rule configured in @ridedott/eslint-config
      'sort-keys': 'off',
    },
  },
];

and a script in your package.json which will help you run ESLint with correct dependencies:

{
  "scripts": {
    "lint": "eslint '**/*.ts'",
    "lint:fix": "eslint --fix '**/*.ts'"
  }
}

Visual Studio Code integration

If you would like to add a Visual Studio Code integration too, consider starting with the following configuration.

Add an extension to the list of suggested ones in .vscode/extensions.json:

{
  "recommendations": ["dbaeumer.vscode-eslint"]
}

Add ESLint settings to the workspace settings in .vscode/settings.json:

{
  "eslint.codeAction.disableRuleComment": {
    "enable": true,
    "location": "separateLine"
  },
  "eslint.codeAction.showDocumentation": {
    "enable": true
  },
  "eslint.enable": true,
  "eslint.lintTask.enable": true,
  "eslint.run": "onType",
  "eslint.useFlatConfig": true
}

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See usage notes on how to consume this package in your project.

Prerequisites

Minimal requirements to set up the project:

• Node.js, installation instructions can be found on the official website, a recommended installation option is to use Node Version Manager. It can be installed in a few commands.
• A package manager like Yarn or npm. All instructions in the documentation will follow the npm syntax.
• Optionally a Git client.

Installing

Start by cloning the repository:

git clone [e-mail]:ridedott/eslint-config.git

In case you don't have a git client, you can get the latest version directly by using this link and extracting the downloaded archive.

Go to the right directory and install dependencies:

cd eslint-config
npm install
npx husky install

That's it! You can now go to the next step.

Tests

This repository does not contain any source code, just the configuration, so no tests are present.

Formatting

This project uses Prettier to automate formatting. All supported files are being reformatted in a precommit hook. You can also use one of the two scripts to validate and optionally fix all the files:

npm run format
npm run format:fix

Publishing

Publishing is handled in an automated way and must not be performed manually.

Each commit to the master branch is automatically deployed to both npm and GitHub Packages registries with a version specified in package.json. All other commits are published as pre-releases by the integration pipeline.

Contributing

See CONTRIBUTING.md.

Built with

Automation

• GitHub Actions

Versioning

This project adheres to Semantic Versioning v2.

IMPORTANT Changes and additions of linting rules are not considered breaking changes.