.eslintrc.cjs

module.exports = {
    // consider picking a config from a well-known company:
    //https://github.com/dustinspecker/awesome-eslint#configs

    //env: "Which environments your script is designed to run in. Each environment brings with it a certain set of predefined global variables."
    //Remember: the node dev server doesn't itself run in the browser but is a node program.
    //without this, module.exports at the top of this file is not accepted by eslint.  (we could have the linter ignore it)
    env: {
        browser: true,
        es2021: true,
        node: true,
    },
    extends: [
        // By extending from a plugin config, we can get recommended rules without having to add them manually.
        "eslint:recommended",
        "plugin:react/recommended",
        "plugin:react-hooks/recommended",

        //react-app is from facebook's from Create React App
        //I think we have most of it from elsewhere, but not everything.
        // eqeqeq: "warn"
        "react-app",

        //react-app/jest is also from facebook's from Create React App
        //but based on https://github.com/jest-community/eslint-plugin-jest/
        // "react-app/jest",

        //linting of ES2015+ (ES6+) import/export syntax, and prevent issues with misspelling of file paths and import names
        "plugin:import/recommended",

        //accessibility rules on JSX elements
        "plugin:jsx-a11y/recommended",

        //https://typescript-eslint.io/getting-started
        "plugin:@typescript-eslint/recommended",

        //(no thanks!)
        //Runs Prettier as an ESLint rule and reports differences as individual ESLint issues
        // 'plugin:prettier/recommended'

        // This disables the formatting rules in ESLint that Prettier is going to be responsible for handling.
        // Make sure it's always the last config, so it gets the chance to override other configs.
        "eslint-config-prettier",
    ],
    settings: {
        react: {
            // Tells eslint-plugin-react to automatically detect the version of React to use.
            version: "detect",
        },
        // Tells eslint how to resolve imports
        "import/resolver": {
            node: {
                paths: ["src"],
                extensions: [".js", ".jsx", ".ts", ".tsx"],
            },
        },
    },
    rules: {
        // Add your own rules here to override ones from the extended configs.
        // Note: You may have to restart your dev server for these changes to take effect
        "no-unused-vars": "off",
        "@typescript-eslint/no-unused-vars": "off", //let's handle this in typescript instead
        "@typescript-eslint/ban-ts-comment": "off", //allows @ts-ignore
        // "@typescript-eslint/no-explicit-any": "off",

        //So that we don't need to import React just to use JSX - enabled by  eslint-plugin-react
        "react/jsx-uses-react": "off", // https://reactjs.org/blog/2020/09/22/introducing-the-new-jsx-transform.html#eslint
        "react/react-in-jsx-scope": "off", // https://reactjs.org/blog/2020/09/22/introducing-the-new-jsx-transform.html#eslint,

        //So that we can write html with certain characters - e.g. <p>Dragon's Lair</p>  - without getting grief
        "react/no-unescaped-entities": "off",

        //Disabling some of import/recommended to avoid writing import type {foo}
        "import/no-unresolved": "off",
        "import/named": "off",

        //In production you might want to change these:
        "@typescript-eslint/no-non-null-assertion": "off",
        "no-debugger": "off",
        // "no-console": ["error", { allow: ["warn", "error"] }]
    },
};