zulip/eslint.config.js

// @ts-check

import {FlatCompat} from "@eslint/eslintrc";
import js from "@eslint/js";
import confusingBrowserGlobals from "confusing-browser-globals";
import {defineConfig} from "eslint/config";
import prettier from "eslint-config-prettier";
import {configs as astroConfigs} from "eslint-plugin-astro";
import formatjs from "eslint-plugin-formatjs";
import importPlugin from "eslint-plugin-import";
import * as mdx from "eslint-plugin-mdx";
import noJquery from "eslint-plugin-no-jquery";
import unicorn from "eslint-plugin-unicorn";
import globals from "globals";
import tseslint from "typescript-eslint";

const compat = new FlatCompat({baseDirectory: import.meta.dirname});

/** @type {import("eslint").Linter.Config[]} */
export const config = defineConfig(
    {
        // This is intended for generated files and vendored third-party files.
        // For our source code, instead of adding files here, consider using
        // specific eslint-disable comments in the files themselves.
        ignores: [
            "docs/_build",
            "static/generated",
            "static/webpack-bundles",
            "var",
            "web/generated",
            "web/third",
        ],
    },
    js.configs.recommended,
    importPlugin.flatConfigs.recommended,
    compat.config(noJquery.configs.recommended),
    compat.config(noJquery.configs.deprecated),
    unicorn.configs.recommended,
    prettier,
    tseslint.configs.strictTypeChecked,
    tseslint.configs.stylisticTypeChecked,
    mdx.flat,
    {
        files: ["**/*.cts", "**/*.mts", "**/*.ts"],
        extends: [importPlugin.flatConfigs.typescript],
    },
    {
        plugins: {
            formatjs,
            "no-jquery": noJquery,
        },
        linterOptions: {
            reportUnusedDisableDirectives: true,
        },
        languageOptions: {
            ecmaVersion: "latest",
            globals: {
                JQuery: "readonly",
            },
            parserOptions: {
                projectService: true,
                tsConfigRootDir: import.meta.dirname,
                warnOnUnsupportedTypeScriptVersion: false,
            },
        },
        settings: {
            formatjs: {
                additionalFunctionNames: ["$t", "$t_html"],
            },
            "import/resolver": {
                node: {
                    extensions: [".ts", ".d.ts", ".js"],
                },
            },
            "no-jquery": {
                collectionReturningPlugins: {expectOne: "always"},
                variablePattern: "^\\$(?!t$|t_html$).",
            },
        },
        rules: {
            "@typescript-eslint/consistent-return": "error",
            "@typescript-eslint/consistent-type-assertions": ["error", {assertionStyle: "never"}],
            "@typescript-eslint/consistent-type-definitions": ["error", "type"],
            "@typescript-eslint/consistent-type-imports": "error",
            "@typescript-eslint/explicit-function-return-type": ["error", {allowExpressions: true}],
            "@typescript-eslint/member-ordering": "error",
            "@typescript-eslint/method-signature-style": "error",
            "@typescript-eslint/no-loop-func": "error",
            "@typescript-eslint/no-misused-spread": "off",
            "@typescript-eslint/no-non-null-assertion": "off",
            "@typescript-eslint/no-restricted-imports": [
                "error",
                {paths: [{name: "zod", message: "Use zod/mini."}]},
            ],
            "@typescript-eslint/no-unnecessary-condition": "off",
            "@typescript-eslint/no-unnecessary-qualifier": "error",
            "@typescript-eslint/no-unused-vars": [
                "error",
                {args: "all", argsIgnorePattern: "^_", ignoreRestSiblings: true},
            ],
            "@typescript-eslint/no-use-before-define": [
                "error",
                {functions: false, variables: false},
            ],
            "@typescript-eslint/parameter-properties": "error",
            "@typescript-eslint/promise-function-async": "error",
            "@typescript-eslint/restrict-plus-operands": ["error", {}],
            "@typescript-eslint/restrict-template-expressions": ["error", {}],
            "array-callback-return": "error",
            "arrow-body-style": "error",
            curly: "error",
            eqeqeq: "error",
            "formatjs/enforce-default-message": ["error", "literal"],
            "formatjs/enforce-placeholders": [
                "error",
                {ignoreList: ["b", "code", "em", "i", "kbd", "p", "strong"]},
            ],
            "formatjs/no-id": "error",
            "guard-for-in": "error",
            "import/extensions": ["error", "ignorePackages"],
            "import/first": "error",
            "import/newline-after-import": "error",
            "import/no-cycle": ["error", {ignoreExternal: true}],
            "import/no-duplicates": "error",
            "import/no-self-import": "error",
            "import/no-unresolved": "off",
            "import/no-useless-path-segments": "error",
            "import/order": ["error", {alphabetize: {order: "asc"}, "newlines-between": "always"}],
            "import/unambiguous": "error",
            "lines-around-directive": "error",
            "new-cap": "error",
            "no-alert": "error",
            "no-bitwise": "error",
            "no-caller": "error",
            "no-constant-condition": ["error", {checkLoops: false}],
            "no-div-regex": "error",
            "no-else-return": "error",
            "no-eval": "error",
            "no-implicit-coercion": "error",
            "no-jquery/no-append-html": "error",
            "no-jquery/no-constructor-attributes": "error",
            "no-jquery/no-parse-html-literal": "error",
            "no-jquery/no-sizzle": ["error", {}],
            "no-label-var": "error",
            "no-labels": "error",
            "no-multi-str": "error",
            "no-new-func": "error",
            "no-new-wrappers": "error",
            "no-object-constructor": "error",
            "no-octal-escape": "error",
            "no-plusplus": "error",
            "no-proto": "error",
            "no-restricted-globals": ["error", ...confusingBrowserGlobals],
            "no-return-assign": "error",
            "no-script-url": "error",
            "no-self-compare": "error",
            "no-undef": "error",
            "no-undef-init": "error",
            "no-unneeded-ternary": ["error", {defaultAssignment: false}],
            "no-useless-concat": "error",
            "no-var": "error",
            "object-shorthand": ["error", "always", {avoidExplicitReturnArrows: true}],
            "one-var": ["error", "never"],
            "prefer-arrow-callback": "error",
            "prefer-const": ["error", {ignoreReadBeforeAssign: true}],
            radix: "error",
            "sort-imports": ["error", {ignoreDeclarationSort: true}],
            "spaced-comment": ["error", "always", {markers: ["/"]}],
            strict: "error",
            "unicorn/consistent-function-scoping": "off",
            "unicorn/filename-case": "off",
            "unicorn/no-await-expression-member": "off",
            "unicorn/no-negated-condition": "off",
            "unicorn/no-null": "off",
            "unicorn/no-process-exit": "off",
            "unicorn/no-useless-undefined": "off",
            "unicorn/numeric-separators-style": "off",
            "unicorn/prefer-global-this": "off",
            "unicorn/prefer-string-raw": "off",
            "unicorn/prefer-ternary": "off",
            "unicorn/prefer-top-level-await": "off",
            "unicorn/prevent-abbreviations": "off",
            "unicorn/switch-case-braces": "off",
            "valid-typeof": ["error", {requireStringLiterals: true}],
            yoda: "error",
        },
    },
    {
        ignores: ["**/*.cts", "**/*.mts", "**/*.ts"],
        extends: [tseslint.configs.disableTypeChecked],
        rules: {
            "@typescript-eslint/consistent-type-imports": "off",
            "@typescript-eslint/explicit-function-return-type": "off",
            "@typescript-eslint/no-require-imports": "off",
            "consistent-return": "error",
            "dot-notation": "error",
            "no-implied-eval": "error",
            "no-throw-literal": "error",
        },
    },
    {
        files: ["**/*.cjs"],
        languageOptions: {
            sourceType: "commonjs",
        },
    },
    {
        files: ["**/*.mdx"],
        rules: {
            "@typescript-eslint/no-unused-vars": "off",
            "comma-spacing": "error",
            "import/extensions": "off",
            "import/unambiguous": "off",
            quotes: "error",
        },
    },
    {
        files: ["web/tests/**"],
        rules: {
            "@typescript-eslint/no-empty-function": "off",
            "@typescript-eslint/no-extraneous-class": "off",
            "no-jquery/no-selector-prop": "off",
            "no-redeclare": "off",
        },
    },
    {
        files: ["web/e2e-tests/**"],
        languageOptions: {
            globals: {
                zulip_test: "readonly",
            },
        },
    },
    {
        files: ["**/*.d.ts"],
        rules: {
            "import/unambiguous": "off",
        },
    },
    {
        ignores: ["web/shared/**", "web/src/**"],
        languageOptions: {
            globals: globals.node,
        },
    },
    {
        files: ["web/e2e-tests/**", "web/tests/**"],
        languageOptions: {
            globals: {
                CSS: "readonly",
                document: "readonly",
                navigator: "readonly",
                window: "readonly",
            },
        },
        rules: {
            "formatjs/no-id": "off",
            "new-cap": "off",
        },
    },
    {
        files: ["web/debug-require.cjs"],
        rules: {
            "no-var": "off",
            "object-shorthand": "off",
            "prefer-arrow-callback": "off",
        },
    },
    {
        files: ["web/shared/**", "web/src/**"],
        settings: {
            "import/resolver": {
                webpack: {
                    config: {},
                },
            },
        },
        rules: {
            "no-console": "error",
        },
    },
    {
        files: ["web/src/**"],
        languageOptions: {
            globals: {
                ...globals.browser,
                DEVELOPMENT: "readonly",
                StripeCheckout: "readonly",
                ZULIP_VERSION: "readonly",
            },
        },
    },
    {
        files: ["starlight_help/src/scripts/client/**"],
        rules: {
            "unicorn/prefer-module": "off",
        },
        languageOptions: {
            globals: {
                ...globals.browser,
            },
            sourceType: "script",
        },
    },
    {
        files: ["web/shared/**"],
        languageOptions: {
            globals: globals["shared-node-browser"],
        },
        rules: {
            "import/no-restricted-paths": [
                "error",
                {
                    zones: [
                        {
                            target: "./web/shared",
                            from: ".",
                            except: ["./node_modules", "./web/shared"],
                        },
                    ],
                },
            ],
            "unicorn/prefer-string-replace-all": "off",
        },
    },
    astroConfigs.recommended,
    {
        files: ["starlight_help/src/components/ZulipNote.astro"],
        rules: {
            "import/unambiguous": "off",
        },
    },
    {
        files: ["starlight_help/src/content/include/*"],
        rules: {
            // We need to turn off this rule since we want import statements
            // to be easily copy-paste-able between content/include and
            // content/docs.
            "import/no-useless-path-segments": "off",
        },
    },
);
export default config;