@robot-inventor/eslint-config

eslint-config

@Robot-Inventor's ESLint config preset.

Installation

Until typescript-eslint supports ESLint v9, you need to add the following code to your .npmrc before installing @robot-inventor/eslint-config. If you didn't add it, you will get peer dependency warnings. See this issue for more information.

legacy-peer-deps=true

Then, install the package:

npm install --save-dev @robot-inventor/eslint-config

Usage

Add the following to your eslint.config.js file:

// ESModule
import { eslintConfig } from "@robot-inventor/eslint-config";

export default eslintConfig;

// CommonJS
const { eslintConfig } = require("@robot-inventor/eslint-config");

module.exports = eslintConfig;

If you don't need JSDoc rules, you can use the eslintConfigNoJSDoc instead.

// ESModule
import { eslintConfigNoJSDoc } from "@robot-inventor/eslint-config";

export default eslintConfigNoJSDoc;

// CommonJS
const { eslintConfigNoJSDoc } = require("@robot-inventor/eslint-config");

module.exports = eslintConfigNoJSDoc;

You can extend or override the config as needed.

// ESModule
import { eslintConfig } from "@robot-inventor/eslint-config";

export default [
    ...eslintConfig,
    {
        rules: {
            // Your rules here
        }
    }
];

// CommonJS
const { eslintConfig } = require("@robot-inventor/eslint-config");

module.exports = [
    ...eslintConfig,
    {
        rules: {
            // Your rules here
        }
    }
];