elements/eslint.config.mjs at main · ory/elements · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
import eslint from "@eslint/js"
import tsParser from "@typescript-eslint/parser"
import formatjs from "eslint-plugin-formatjs"
import pluginPromise from "eslint-plugin-promise"
import react from "eslint-plugin-react"
import reactHooks from "eslint-plugin-react-hooks"
import storybook from "eslint-plugin-storybook"
import eslintPluginBetterTailwindcss from "eslint-plugin-better-tailwindcss"
import tsdoc from "eslint-plugin-tsdoc"
import globals from "globals"
import tseslint from "typescript-eslint"
import path from "node:path"

const config = tseslint.config([
  {
    ignores: [
      "**/assets/*.js",
      "**/.storybook/**",
      "**/dist/**",
      "**/storybook-static/**",
      "**/*.config.{js,mjs,cjs,ts}",
      "**/jest.preset.{cjs,ts}",
      "**/tsup.config.{js,ts}",
      "**/.next/**",
      "**/examples/nextjs-app-router/.next/**",
      "**/examples/nextjs-app-router/next-env.d.ts",
      "**/examples/nextjs-pages-router/.next/**",
      "**/examples/nextjs-pages-router/next-env.d.ts",
      "**/examples/nextjs-app-router-custom-components/.next/**",
      "**/examples/nextjs-app-router-custom-components/next-env.d.ts",
    ],
  },
  eslint.configs.recommended,
  ...tseslint.configs.recommendedTypeChecked,
  {
    languageOptions: {
      parserOptions: {
        projectService: true,
        tsconfigRootDir: import.meta.dirname,
      },
    },
  },
  pluginPromise.configs["flat/recommended"],
  storybook.configs["flat/recommended"],
  {
    rules: {
      "@typescript-eslint/no-unused-vars": [
        "error",
        {
          args: "all",
          argsIgnorePattern: "^_",
          caughtErrors: "all",
          caughtErrorsIgnorePattern: "^_",
          destructuredArrayIgnorePattern: "^_",
          varsIgnorePattern: "^_",
          ignoreRestSiblings: true,
        },
      ],
    },
  },
  {
    files: ["**/src/**/*.{js,jsx,mjs,cjs,ts,tsx}"],
    plugins: {
      react,
      tsdoc,
      formatjs,
    },

    languageOptions: {
      globals: {
        ...globals.browser,
        ...globals.node,
      },

      parser: tsParser,
      ecmaVersion: 2021,
      sourceType: "module",

      parserOptions: {
        tsconfigRootDir: "./",

        ecmaFeatures: {
          jsx: true,
        },
      },
    },

    rules: {
      // TODO: https://github.com/microsoft/tsdoc/issues/374 (and specifically https://github.com/microsoft/tsdoc/issues/374#issuecomment-2336536959)
      "tsdoc/syntax": "off",
      "formatjs/no-offset": "error",
      "@typescript-eslint/no-floating-promises": "error",
      // The legacy elements is written with lots of any types
      "no-unused-vars": "off",
      "no-undef": "off",
      "@typescript-eslint/consistent-type-definitions": "off",
      "react/prop-types": "off",
      "@typescript-eslint/no-unsafe-assignment": "off",
      "@typescript-eslint/no-unsafe-member-access": "off",

      "@typescript-eslint/no-unused-vars": [
        "error",
        {
          argsIgnorePattern: "^_",
          varsIgnorePattern: "^_",
          caughtErrorsIgnorePattern: "^_",
        },
      ],

      "no-extra-semi": "off",
    },
  },
  {
    files: [
      "examples/nextjs-app-router/**/*.ts",
      "examples/nextjs-app-router/**/*.tsx",
    ],
    languageOptions: {
      parserOptions: {
        project: ["./examples/nextjs-app-router/tsconfig.json"],
      },
    },
  },
  {
    name: "elements-react",
    files: ["packages/elements-react/**"],
    languageOptions: {
      parserOptions: {
        ecmaFeatures: {
          jsx: true,
        },
      },
    },
    plugins: {
      "react-hooks": reactHooks,
      "better-tailwindcss": eslintPluginBetterTailwindcss,
    },
    rules: {
      ...reactHooks.configs.recommended.rules,
      // enable all recommended rules to report an error
      ...eslintPluginBetterTailwindcss.configs["recommended-error"].rules,
      "better-tailwindcss/enforce-consistent-line-wrapping": "off",
      "better-tailwindcss/no-unregistered-classes": [
        "error",
        { ignore: ["ory-elements"] },
      ],
    },
    settings: {
      "better-tailwindcss": {
        // // tailwindcss 4: the path to the entry file of the css based tailwind config (eg: `src/global.css`)
        entryPoint: "packages/elements-react/src/theme/default/global.css",
      },
    },
  },
  {
    name: "tests",
    files: ["**/*.test.ts", "**/*.test.tsx", "**/*.spec.ts", "**/*.spec.tsx"],
    rules: {
      "@typescript-eslint/no-explicit-any": "off",
      "@typescript-eslint/no-unsafe-call": "off",
    },
  },
  {
    files: ["packages/elements-react/stories/**/*.{js,jsx,ts,tsx}"],
    rules: {
      "@typescript-eslint/no-require-imports": "off",
    },
  },
  {
    name: "no-react-hook-form-imports",
    files: ["packages/elements-react/src/theme/default/**"],
    rules: {
      "no-restricted-imports": [
        "error",
        {
          paths: [
            {
              name: "react-hook-form",
              message:
                "Please do not use react-hook-form in the default theme. Use Ory's form context instead.",
            },
          ],
        },
      ],
    },
  },
])

export default config