Content

This repository contains the ESLint rules shared among all the Mimic repositories.

Setup

To set up this project, you'll need Git and Yarn installed. From your command line:

# Clone this repository
$ git clone https://github.com/mimic-fi/eslint-mimic-config

# Go into the repository
$ cd eslint-mimic-config

# Install dependencies
$ yarn

Usage

To use the Mimic ESLint configuration in your own project, follow these steps:

Prerequisites

• Node.js version >=18.0.0
• ESLint version >=8.21.0

Installation

Install the eslint-config-mimic package as a development dependency:

$ yarn add --dev eslint-config-mimic

Configuration

1. Create an ESLint configuration file

   In the root of your project, create a file named eslint.config.mjs. This file will use the new ESLint flat config system.

2. Extend the Mimic configuration

   Import the Mimic ESLint configuration and include it in your ESLint configuration array:

   // eslint.config.mjs
   
    import eslintConfigMimic from "eslint-config-mimic";
   
    export default [
      ...eslintConfigMimic,
      // You can add your own configurations or overrides here
    ];

   If your project uses CommonJS modules, you can import the configuration as follows:

   // eslint.config.mjs
   
   const mimicEslintConfig = require('eslint-config-mimic');
   
   module.exports = [
     ...mimicEslintConfig,
     // You can add your own configurations or overrides here
   ];

3. Ensure ESLint uses the correct configuration file

   When running ESLint, specify the configuration file if necessary:

   # Lint your project
   $ eslint . --config ./eslint.config.js

Notes

• Peer Dependencies: All necessary ESLint plugins and configurations are included as dependencies of eslint-config-mimic. You don't need to install them separately.

• Custom Rules: You can add custom rules or override existing ones by adding additional configuration objects to the exported array in your eslint.config.js file.

• Compatibility: Ensure that your project's ESLint version supports the flat config system. If you're using an older version of ESLint, you may need to upgrade.

License

GPL 3.0

Website mimic.fi  ·  GitHub @mimic-fi  ·  Twitter @mimicfi  ·  Discord mimic