🐺 Wolves League ESLint config

Setup

Install the package and ESLint as dev dependencies:

NPM

npm i -D @wolves-league/eslint-config eslint

PNPM

pnpm add -D @wolves-league/eslint-config eslint

Bun

bun add -D @wolves-league/eslint-config eslint

If you use VSCode

In settings.json add the following configuration:

"eslint.useFlatConfig": true,

Node.js/Bun

eslint.config.js

import wlConfig from "@wolves-league/eslint-config";

/** @type {Array<import('@wolves-league/eslint-config').Config>} */
export default wlConfig.configs.node;

React

eslint.config.js

import wlConfig from "@wolves-league/eslint-config";

/** @type {Array<import('@wolves-league/eslint-config').Config>} */
export default wlConfig.configs.react;

Next.js

eslint.config.js

import wlConfig from "@wolves-league/eslint-config";

/** @type {Array<import('@wolves-league/eslint-config').Config>} */
export default wlConfig.configs.next;

Extend the configuration

If you want to extend or override the configuration you can just spread the config inside an array, and add configuration objects:

eslint.config.js

import wlConfig from "@wolves-league/eslint-config";

/** @type {Array<import('@wolves-league/eslint-config').Config>} */
export default [
  ...wlConfig.configs.node,
  {
    rules: {
      semi: "error",
    },
  },
];

Refer to ESLint official documentation for more information.

CommonJS

If you need to use CommonJS, you can use the following configuration:

eslint.config.js

/* eslint-disable @typescript-eslint/no-var-requires */
const wlConfig = require("@wolves-league/eslint-config");

module.exports = wlConfig.configs.react; // react | node | next

Override or Extend Prettier Configuration

If you need to override or extend the Prettier configuration, you can create a prettier.config.js file in the root of your project. The following code is an example of extending the Prettier configuration with prettier-plugin-tailwindcss:

prettier.config.js

import wlConfig from "@wolves-league/eslint-config";

/** @type {import('@wolves-league/eslint-config').Config['prettier']} */
export default {
  ...wlConfig.configs.prettier, // Omit this line to use the default Prettier configuration
  plugins: ["prettier-plugin-tailwindcss"],
  // Add your custom rules and settings here
};