.eslintrc.json

// base: https://github.com/BabylonJS/Babylon.js/blob/129f56b538bab37d342ed2ba663fc89cb0ab3d1f/.eslintrc
{
    "root": true,
    "parser": "@typescript-eslint/parser",
    "parserOptions": {
        "sourceType": "module",
        "ecmaVersion": 2020
        // "ecmaFeatures": {
        //     "jsx": true
        // }
    },
    // commented out to align rules with Babylon.js
    // // Limit TypeScript linting to TS/TSX
    // // https://github.com/typescript-eslint/typescript-eslint/issues/1928
    // "overrides": [
    //     {
    //         "files": ["src/**/*.{ts,tsx}"],
    //         "extends": [
    //             "plugin:@typescript-eslint/eslint-recommended",
    //             "plugin:@typescript-eslint/recommended",
    //             "plugin:@typescript-eslint/recommended-requiring-type-checking"
    //             // "plugin:eslint-plugin-tsdoc/recommended"
    //         ],
    //         "rules": {
    //             "@typescript-eslint/ban-ts-comment": "off",
    //             "@typescript-eslint/explicit-function-return-type": "off",
    //             "@typescript-eslint/no-unused-vars": ["warn", { "argsIgnorePattern": "^_" }],
    //             // All the @typescript-eslint/* rules here...
    //             "@typescript-eslint/no-unnecessary-type-arguments": "error",
    //             "@typescript-eslint/prefer-nullish-coalescing": "error",
    //             "@typescript-eslint/prefer-optional-chain": "error"
    //         },
    //         "parser": "@typescript-eslint/parser",
    //         "parserOptions": {
    //             "tsconfigRootDir": "./",
    //             "project": "./tsconfig.json"
    //         }
    //     }
    // ],
    "env": {
        "browser": true,
        "node": true
        // "jest": true
    },
    "plugins": [
    //     //   "react"
    //     // "prettier", // add this if we want to use prettier error reporting
    //     "jest",
        "@typescript-eslint"
    //     "eslint-plugin-tsdoc",
    //     "jsdoc"
    ],
    "extends": [
        "eslint:recommended",
        "plugin:@typescript-eslint/eslint-recommended",
        "plugin:import/errors",
        "plugin:import/warnings",
        "plugin:import/typescript",
        // "plugin:jest/recommended",
        // "plugin:jsdoc/recommended",
        "prettier"
    ],
    // "settings": {
    //     "react": {
    //         "pragma": "h",
    //         "createClass": ""
    //     }
    // },
    "rules": {
        "block-spacing": "error",
        // "capitalized-comments": ["error", "always"],
        // ... All other rules (not @typescript-eslint/*)
        //   "react/no-adjacent-inline-elements": "error",
        //   "react/react-in-jsx-scope": "error",
        //   "react/self-closing-comp": "error",
        // "import/no-unresolved": "off", // because of the way the repo is structured
        // todo - make this work with external modules
        "import/named": "error",
        "import/no-cycle": [1, { "maxDepth": 1, "ignoreExternal": true }],
        "import/no-internal-modules": [
            "error",
            {
                // {   "allow": ["**/*.ts", "**/*.tsx"]
                "forbid": ["**/index", "**/"]
            }
        ],
        // Another way of implementing that:
        // "no-restricted-imports": ["error", {
        //     "patterns": [{
        //       "group": ["index"],
        //       "message": "Do not import from index"
        //     }]
        // }],
        // "no-duplicate-imports": ["error", { "includeExports": true }],
        // should be error, no?
        "@typescript-eslint/no-unused-vars": ["warn", { "argsIgnorePattern": "^_" }],
        "@typescript-eslint/consistent-type-imports": ["error", { "disallowTypeAnnotations": false }],
        "@typescript-eslint/no-this-alias": "error",
        "@typescript-eslint/naming-convention": [
            "warn",
            {
                "selector": "default",
                "format": ["camelCase"]
            },
            {
                "selector": "variable",
                "format": ["camelCase", "UPPER_CASE", "snake_case"],
                "leadingUnderscore": "allow"
            },
            {
                "selector": "parameter",
                "format": ["camelCase"],
                "leadingUnderscore": "allow"
            },
            {
                "selector": "enumMember",
                "format": ["PascalCase", "UPPER_CASE"]
            },
            {
                "selector": "memberLike",
                "modifiers": ["public", "static"],
                "format": ["PascalCase", "UPPER_CASE"],
                "leadingUnderscore": "allow"
            },
            {
                "selector": "memberLike",
                "modifiers": ["private", "static"],
                "format": ["PascalCase", "UPPER_CASE"],
                "leadingUnderscore": "require"
            },
            {
                "selector": "memberLike",
                "modifiers": ["public"],
                "format": ["camelCase"],
                "leadingUnderscore": "allow"
            },
            {
                "selector": "memberLike",
                "modifiers": ["private"],
                "format": ["camelCase"],
                "leadingUnderscore": "require"
            },
            {
                "selector": "memberLike",
                "modifiers": ["protected"],
                "format": ["camelCase"],
                "leadingUnderscore": "require"
            },
            {
                "selector": "typeLike",
                "format": ["PascalCase"]
            },
            {
                "selector": "variable",
                "format": ["camelCase", "UPPER_CASE"]
            },
            {
                "selector": "variable",
                "modifiers": ["const", "global"],
                "format": ["PascalCase", "camelCase"],
                "leadingUnderscore": "allow"
            },
            {
                "selector": "function",
                "format": ["PascalCase", "camelCase"],
                "leadingUnderscore": "allow"
            },
            {
                "selector": "function",
                "modifiers": ["exported", "global"],
                "format": ["PascalCase", "camelCase"],
                "leadingUnderscore": "allow"
            },
            {
                "selector": "interface",
                "format": ["PascalCase"]
            },
            {
                "selector": "class",
                "format": ["PascalCase"],
                "leadingUnderscore": "allow"
            }
        ],
        "no-unused-vars": "off",
        "no-empty": ["error", { "allowEmptyCatch": true }],
        "space-infix-ops": "error",
        "template-curly-spacing": "error",
        "template-tag-spacing": "error",
        // "jest/no-standalone-expect": ["error", { "additionalTestBlockFunctions": ["afterEach"] }],
        // "jest/valid-expect": "off",
        // "tsdoc/syntax": "error",
        // "jsdoc/check-param-names": "warn",
        // "jsdoc/check-property-names": "error",
        // "jsdoc/require-param": "error",
        // "jsdoc/require-param-name": "error",
        // "jsdoc/require-returns": "warn",
        // "jsdoc/require-returns-check": "error",
        "import/export": "warn",
        "no-useless-escape": "warn",
        "no-case-declarations": "warn",
        "no-prototype-builtins": "warn",
        "no-loss-of-precision": "warn",
        "prefer-spread": "off",
        "prefer-rest-params": "off",
        "no-fallthrough": "warn",
        "no-async-promise-executor": "warn"
        // "prettier/prettier": "error" // add this if we want to use prettier error reporting.
    }
}