payload/eslint.config.js at main · payloadcms/payload · 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
import payloadEsLintConfig from '@payloadcms/eslint-config'
import payloadPlugin from '@payloadcms/eslint-plugin'
import mdxTextParser from '@payloadcms/eslint-plugin/customRules/mdx-text-parser.js'

export const defaultESLintIgnores = [
  '**/.temp',
  '**/.*', // ignore all dotfiles
  '**/.git',
  '**/.hg',
  '**/.pnp.*',
  '**/.svn',
  '**/playwright.config.ts',
  '**/vite.tanstack.config.ts',
  '**/vitest.config.ts',
  '**/vitest.setup.ts',
  '**/tsconfig.tsbuildinfo',
  '**/README.md',
  '**/eslint.config.js',
  '**/payload-types.ts',
  '**/dist/',
  '**/.yarn/',
  '**/build/',
  '**/node_modules/',
  '**/temp/',
  'packages/**/*.spec.ts',
  'next-env.d.ts',
  '**/app',
  // The TanStack app dirs (shippable `app-tanstack` + its test duplicates) are
  // thin app wiring; their `app/` routes are already ignored above, and these
  // dirs carry no tsconfig of their own. The adapter logic lives in
  // `packages/tanstack-start` and is linted there.
  '**/app-tanstack/components/**',
  '**/app-tanstack/router.tsx',
  'src/**/*.spec.ts',
  'packages/payload/rollup.dts.config.mjs',
  'scripts/**/*.js',
  'packages/plugin-mcp/bin.js',
]

/** @typedef {import('eslint').Linter.Config} Config */

export const rootParserOptions = {
  sourceType: 'module',
  ecmaVersion: 'latest',
  projectService: true,
}

/** @type {Config[]} */
export const rootEslintConfig = [
  ...payloadEsLintConfig,
  {
    ignores: [
      ...defaultESLintIgnores,
      'packages/eslint-*/**',
      'test/live-preview/next-app',
      'packages/**/*.spec.ts',
      'templates/**',
      'examples/**',
      'packages/drizzle/src/postgres/predefinedMigrations/v2-v3/**',
      'packages/drizzle/src/postgres/predefinedMigrations/localize-status/**',
      'packages/drizzle/src/sqlite/predefinedMigrations/localize-status/**',
      'packages/codemod/src/transforms/**/*.input.ts',
      'packages/codemod/src/transforms/**/*.output.ts',
      'packages/tanstack-start/scripts/**',
      'packages/tanstack-start/test/**',
    ],
  },
  {
    plugins: {
      payload: payloadPlugin,
    },
    rules: {
      'payload/no-jsx-import-statements': 'warn',
      'payload/no-relative-monorepo-imports': 'error',
      'payload/no-imports-from-exports-dir': 'error',
      'payload/no-imports-from-self': 'error',
      'payload/proper-payload-logger-usage': 'error',
    },
  },
  {
    files: ['packages/ui/**/*.{ts,tsx}'],
    rules: {
      'no-console': 'error',
    },
  },
  {
    files: ['scripts/**/*.ts'],
    rules: {
      '@typescript-eslint/no-unused-vars': 'off',
      'no-console': 'off',
      'perfectionist/sort-object-types': 'off',
      'perfectionist/sort-objects': 'off',
    },
  },
  {
    files: ['tools/**/*.ts'],
    rules: {
      'no-console': 'off',
      'perfectionist/sort-object-types': 'off',
      'perfectionist/sort-objects': 'off',
      'payload/no-relative-monorepo-imports': 'off',
    },
  },
]

export default [
  ...rootEslintConfig,
  {
    files: ['packages/eslint-config/**/*.ts'],
    rules: {
      'perfectionist/sort-objects': 'off',
    },
  },
  {
    files: ['templates/vercel-postgres/**'],
    rules: {
      'no-restricted-exports': 'off',
    },
  },
  // MDX/Markdown documentation linting for code block languages
  {
    files: ['docs/**/*.mdx', 'docs/**/*.md'],
    plugins: {
      payload: payloadPlugin,
    },
    languageOptions: {
      parser: mdxTextParser,
    },
    rules: {
      'payload/valid-code-block-languages': 'error',
    },
  },
]