Files
payloadcms/packages/eslint-config-payload/eslint-config/index.js
2024-03-14 23:40:07 -04:00

190 lines
5.9 KiB
JavaScript

const baseRules = {
// This rule makes no sense when overriding class methods. This is used a lot in richtext-lexical.
'class-methods-use-this': 'off',
'arrow-body-style': 0,
'import/prefer-default-export': 'off',
'no-restricted-exports': ['warn', { restrictDefaultExports: { direct: true } }],
'no-console': 'warn',
'no-sparse-arrays': 'off',
'no-underscore-dangle': 'off',
'no-use-before-define': 'off',
'object-shorthand': 'warn',
'no-useless-escape': 'warn',
'perfectionist/sort-objects': [
'error',
{
type: 'natural',
order: 'asc',
'partition-by-comment': true,
groups: ['top', 'unknown'],
'custom-groups': {
top: ['_id', 'id', 'name', 'slug', 'type'],
},
},
],
}
const reactRules = {
// react/jsx-max-props-per-line conflicts with prettier. Sometimes react/jsx-max-props-per-line tells you to put it on a new line, but prettier moves it back.
'react/jsx-max-props-per-line': 'off',
// react/jsx-one-expression-per-line conflicts with prettier. Sometimes react/jsx-one-expression-per-line tells you to put it on a new line, but prettier moves it back.
'react/jsx-one-expression-per-line': 'off',
// react/jsx-wrap-multilines conflicts with prettier. Sometimes react/jsx-wrap-multilines tells you to put it on a new line, but prettier moves it back.
'react/jsx-wrap-multilines': 'off',
// react/jsx-indent conflicts with prettier. Sometimes react/jsx-indent tells you to put it on a new line, but prettier moves it back.
'react/jsx-indent': 'off',
// react/jsx-curly-newline conflicts with prettier. Sometimes react/jsx-curly-newline tells you to put it on a new line, but prettier moves it back.
'react/jsx-curly-newline': 'off',
'react/no-unused-prop-types': 'off',
'react/prop-types': 'off',
'react/require-default-props': 'off',
'react/destructuring-assignment': 'warn',
'react/no-unescaped-entities': 'warn',
'jsx-a11y/anchor-is-valid': 'warn',
'jsx-a11y/control-has-associated-label': 'warn',
'jsx-a11y/no-static-element-interactions': 'warn',
'jsx-a11y/label-has-associated-control': 'warn',
}
const typescriptRules = {
'@typescript-eslint/no-use-before-define': 'off',
'@typescript-eslint/ban-ts-comment': 'off',
// Type-aware any rules:
'@typescript-eslint/no-unsafe-assignment': 'off',
'@typescript-eslint/no-unsafe-member-access': 'off',
'@typescript-eslint/no-unsafe-call': 'off',
'@typescript-eslint/no-unsafe-argument': 'off',
'@typescript-eslint/no-unsafe-return': 'off',
'@typescript-eslint/unbound-method': 'warn',
// This rule doesn't work well in .tsx files
'@typescript-eslint/no-misused-promises': 'off',
'@typescript-eslint/consistent-type-imports': 'warn',
'@typescript-eslint/no-explicit-any': 'warn',
// Type-aware any rules end
// ts-expect should always be preferred over ts-ignore
'@typescript-eslint/prefer-ts-expect-error': 'warn',
// By default, it errors for unused variables. This is annoying, warnings are enough.
'@typescript-eslint/no-unused-vars': [
'warn',
{
vars: 'all',
args: 'after-used',
ignoreRestSiblings: false,
argsIgnorePattern: '^_',
varsIgnorePattern: '^_',
destructuredArrayIgnorePattern: '^_',
caughtErrorsIgnorePattern: '^ignore',
},
],
'@typescript-eslint/no-base-to-string': 'warn',
'@typescript-eslint/restrict-template-expressions': 'warn',
'@typescript-eslint/no-redundant-type-constituents': 'warn',
'@typescript-eslint/no-unnecessary-type-constraint': 'warn',
'@typescript-eslint/ban-types': 'warn',
}
const baseExtends = [
'eslint:recommended',
'plugin:perfectionist/recommended-natural',
'plugin:regexp/recommended',
'prettier',
]
/** @type {import('eslint').Linter.Config} */
module.exports = {
ignorePatterns: [
'*.d.ts',
'**/tsconfig.json',
'package.json',
'*.MD',
'.tmp',
'**/.git',
'**/build',
'**/dist/**',
'**/node_modules',
'**/temp',
'*.yml',
'*.json',
],
env: {
es6: true,
browser: true,
node: true,
},
parserOptions: {
ecmaFeatures: {
jsx: true,
},
ecmaVersion: 'latest',
sourceType: 'module',
},
plugins: [], // Plugins are defined in the overrides to be more specific and only target the files they are meant for.
overrides: [
{
files: ['**/*.ts'],
plugins: ['@typescript-eslint'],
extends: [...baseExtends, 'plugin:@typescript-eslint/recommended-type-checked'],
parser: '@typescript-eslint/parser',
rules: {
...baseRules,
...typescriptRules,
},
},
{
files: ['**/*.tsx'],
plugins: ['@typescript-eslint'],
extends: [
...baseExtends,
'plugin:@typescript-eslint/recommended-type-checked',
'plugin:react/recommended',
'plugin:react-hooks/recommended',
'./configs/react/index.js',
],
parser: '@typescript-eslint/parser',
rules: {
...baseRules,
...typescriptRules,
...reactRules,
},
},
{
files: ['**/*.spec.ts'],
plugins: ['@typescript-eslint'],
extends: [
...baseExtends,
'plugin:@typescript-eslint/recommended-type-checked',
'./configs/jest/index.js',
],
parser: '@typescript-eslint/parser',
rules: {
...baseRules,
...typescriptRules,
'@typescript-eslint/unbound-method': 'off',
},
},
{
files: ['*.config.ts'],
rules: {
...baseRules,
...typescriptRules,
'no-restricted-exports': 'off',
},
},
{
files: ['config.ts'],
rules: {
...baseRules,
...typescriptRules,
'no-restricted-exports': 'off',
},
},
],
rules: {}, // Rules are defined in the overrides to be more specific and only target the files they are meant for.
settings: {
'import/parsers': {
'@typescript-eslint/parser': ['.ts', '.tsx'],
},
},
}