.eslintrc.js

/* eslint-disable import/no-commonjs */
module.exports = {
    extends: ["./packages/eslint-config-khan/index.js"],
    plugins: [
        "@babel",
        "import",
        "jest",
        "jsdoc",
        "promise",
        "monorepo",
        "disable",
    ],
    settings: {
        "eslint-plugin-disable": {
            paths: {
                react: ["./*.js", "src/*.js"],
                "jsx-a11y": ["./*.js", "src/*.js"],
            },
        },
        "import/resolver": {
            typescript: {
                project: [
                    "packages/*/tsconfig.json",
                    "packages/tsconfig-shared.json",
                ],
            },
            node: {
                project: [
                    "packages/*/tsconfig.json",
                    "packages/tsconfig-shared.json",
                ],
            },
        },
    },
    globals: {
        __IS_BROWSER__: "readonly",
    },
    overrides: [
        {
            files: ["utils/*.js"],
            rules: {
                "import/no-commonjs": "off",
            },
        },
        {
            files: ["**/__tests__/**/*.test.ts"],
            rules: {
                "max-lines": "off",
                "@typescript-eslint/no-empty-function": "off",
            },
        },
        {
            files: ["**/bin/**/*.ts", "build-scripts/*.ts"],
            rules: {
                "no-console": "off",
            },
        },
    ],
    rules: {
        /**
         * built-in rules
         */
        "new-cap": "off",
        "no-invalid-this": "off",
        "object-curly-spacing": "off",
        semi: "off",

        /**
         * @babel rules
         */
        "@babel/new-cap": "error",
        "@babel/no-invalid-this": "error",
        "@babel/object-curly-spacing": "error",
        "@babel/semi": "error",

        /**
         * import rules
         */
        "import/no-default-export": "error",
        "import/no-unresolved": "error",
        "import/named": "error",
        "import/default": "error",
        "import/no-absolute-path": "error",
        "import/no-self-import": "error",
        "import/no-useless-path-segments": "error",
        "import/no-named-as-default": "error",
        "import/no-named-as-default-member": "error",
        "import/no-deprecated": "error",
        "import/no-commonjs": "error",
        "import/first": "error",
        "import/no-duplicates": "error",
        "import/order": [
            "error",
            {
                groups: ["builtin", "external"],
            },
        ],
        "import/newline-after-import": "error",
        "import/no-unassigned-import": [
            "error",
            {
                allow: ["jest-extended"],
            },
        ],
        "import/no-named-default": "error",
        "import/extensions": [
            "error",
            "never",
            {
                ignorePackages: true,
            },
        ],
        // NOTE: This rule reports false positives for cross-module imports using
        // `@khanacademy/wonder-stuff-*`.  This is likely due to a bad interaction
        // with the settings we're using for `import/resolver`.
        // "monorepo/no-relative-import": "error",
        "import/no-restricted-paths": [
            "error",
            {
                zones: [
                    {
                        target: "./packages/(?!.*test.js).*",
                        from: "utils",
                    },
                ],
            },
        ],

        /**
         * jest rules
         */
        "jest/no-focused-tests": "error",

        /**
         * jsdoc rules
         */
        "jsdoc/valid-types": "error",

        /**
         * promise rules
         */
        "promise/always-return": "error",
        "promise/no-return-wrap": "error",
        "promise/param-names": "error",
        "promise/catch-or-return": "error",
        "promise/no-new-statics": "error",
        "promise/no-return-in-finally": "error",

        /**
         * monorepo rules
         */
        "monorepo/no-internal-import": "error",

        /**
         * typescript rules
         */
        // import/no-common-js covers this already
        "@typescript-eslint/no-require-imports": "off",
    },
};