ESLint Configuration for Flare

This repository contains the ESLint configuration used across Flare projects to ensure consistent code quality and style.

Overview

Use this ESLint configuration in all typescript projects developed by Flare.

Installation

Install the ESLint configuration package:

pnpm add --save-dev eslint @eslint/compat @flarenetwork/eslint-config-flare

if you are using prettier also add

pnpm add --save-dev eslint-config-prettier

pnpm add --save-dev eslint @eslint/compat @flarenetwork/eslint-config-flare eslint-config-prettier

Create a eslint.config.mjs file in the root of your project with the following content:

// @ts-check
import { includeIgnoreFile } from "@eslint/compat";
import { defaultConfig } from "@flarenetwork/eslint-config-flare";
import prettier from "eslint-config-prettier";
import path from "node:path";
import { fileURLToPath } from "node:url";

const gitignorePath = path.resolve(
  path.dirname(fileURLToPath(import.meta.url)),
  ".gitignore",
);

export default [includeIgnoreFile(gitignorePath), ...defaultConfig, prettier];

Usage

You can run ESLint using the following command:

Configure linter in package.json:

{
  ...
  "scripts": {
    ...
    "lint:fix": "eslint \"{src,test}/**/*.ts\" --fix",
    "lint:check": "eslint \"{src,test}/**/*.ts\"",
    ...
  },
  ...
}