@dfinity/eslint-config-oisy-wallet/configs/eslint.rules.mjs

Shared ESLint configurations from the Oisy Wallet team

import localRules from "eslint-plugin-local-rules";
import preferArrow from "eslint-plugin-prefer-arrow";
import { join } from "node:path";
import { existsSync } from "node:fs";
import { fixupPluginRules, includeIgnoreFile } from "@eslint/compat";
import _import from "eslint-plugin-import";
import { fileURLToPath } from "node:url";
import { nonNullish } from "@dfinity/utils";

const resolveGitIgnorePath = () => {
  const gitIgnore = join(process.cwd(), ".gitignore");

  if (existsSync(gitIgnore)) {
    return fileURLToPath(new URL(gitIgnore, import.meta.url));
  }

  return undefined;
};

const gitignorePath = resolveGitIgnorePath();

export const eslintRules = [
  ...(nonNullish(gitignorePath) ? [includeIgnoreFile(gitignorePath)] : []),
  {
    plugins: {
      "local-rules": localRules,
      "prefer-arrow": preferArrow,
      import: fixupPluginRules(_import),
    },

    rules: {
      "@typescript-eslint/consistent-type-imports": "error",
      "@typescript-eslint/no-import-type-side-effects": "error",
      "@typescript-eslint/no-inferrable-types": "error",
      "@typescript-eslint/no-unnecessary-type-assertion": "error",
      "@typescript-eslint/no-unused-vars": [
        "warn",
        {
          argsIgnorePattern: "^_",
          varsIgnorePattern: "^_",
          caughtErrorsIgnorePattern: "^_",
        },
      ],
      "@typescript-eslint/prefer-nullish-coalescing": "error",
      "@typescript-eslint/prefer-reduce-type-parameter": "error",

      "arrow-body-style": ["warn", "as-needed"],
      curly: "error",
      "func-style": "error",

      "local-rules/prefer-object-params": "warn",

      // TODO: Disabled for now to allow the migration of ESLint v9 in OISY, as the rule is not yet enforced.
      // It should also be introduced as an optional rule.
      // "local-rules/use-nullish-checks": "warn",

      "local-rules/use-option-type-wrapper": "warn",

      "import/no-duplicates": ["error", { "prefer-inline": true }],
      "import/no-relative-parent-imports": "error",

      "object-shorthand": "error",
      "prefer-destructuring": "error",
      "no-console": ["error", { allow: ["error", "warn"] }],
      "no-continue": "warn",
      "no-delete-var": "error",
      "no-else-return": ["warn", { allowElseIf: false }],
      "no-unused-vars": "off",
      "no-useless-rename": "error",
      "prefer-arrow-callback": "error",

      "prefer-arrow/prefer-arrow-functions": [
        "error",
        {
          disallowPrototype: true,
          singleReturnOnly: false,
          classPropertiesAllowed: false,
        },
      ],

      "prefer-template": "error",
      "require-await": "error",
    },
  },
  {
    files: ["**/*.ts"],

    rules: {
      "prefer-const": "error",
    },
  },
];