@payloadcms/eslint-plugin/index.mjs

Payload plugin for ESLint

import noJsxImportStatements from './customRules/no-jsx-import-statements.js'
import noNonRetryableAssertions from './customRules/no-non-retryable-assertions.js'
import noRelativeMonorepoImports from './customRules/no-relative-monorepo-imports.js'
import noImportsFromExportsDir from './customRules/no-imports-from-exports-dir.js'
import noFlakyAssertions from './customRules/no-flaky-assertions.js'
import noImportsFromSelf from './customRules/no-imports-from-self.js'
import properPinoLoggerErrorUsage from './customRules/proper-payload-logger-usage.js'

/**
 * @type {import('eslint').ESLint.Plugin}
 */
const index = {
  rules: {
    'no-jsx-import-statements': noJsxImportStatements,
    'no-relative-monorepo-imports': noRelativeMonorepoImports,
    'no-imports-from-exports-dir': noImportsFromExportsDir,
    'no-imports-from-self': noImportsFromSelf,
    'proper-payload-logger-usage': properPinoLoggerErrorUsage,

    // Testing-related
    'no-non-retryable-assertions': noNonRetryableAssertions,
    'no-flaky-assertions': noFlakyAssertions,
    'no-wait-function': {
      create: function (context) {
        return {
          CallExpression(node) {
            // Check if the function being called is named "wait"
            if (node.callee.name === 'wait') {
              context.report({
                node,
                message:
                  'Usage of "wait" function is discouraged as it\'s flaky. Proper assertions should be used instead.',
              })
            }
          },
        }
      },
    },
  },
}

export default index