.eslintrc.cjs

/** @type {import('eslint').Linter.Config} */
module.exports = {
	extends: [
		'xo',
		'xo-typescript',
		'plugin:jsdoc/recommended',
	],
	parserOptions: {
		project: './tsconfig.eslint.json',
	},
	rules: {
		'@typescript-eslint/naming-convention': [
			// Allow for OBS in class/interface name, UPPER_CASE const
			'error',
			{
				// selector: ['variableLike', 'memberLike', 'property', 'method'],
				// Note: Leaving out `parameter` and `typeProperty` because of the mentioned known issues.
				// Note: We are intentionally leaving out `enumMember` as it's usually pascal-case or upper-snake-case.
				selector: ['function', 'classProperty', 'objectLiteralProperty', 'parameterProperty', 'classMethod', 'objectLiteralMethod', 'typeMethod', 'accessor'],
				format: [
					'strictCamelCase',
				],
				// We allow double underscope because of GraphQL type names and some React names.
				leadingUnderscore: 'allowSingleOrDouble',
				trailingUnderscore: 'allow',
				// Ignore `{'Retry-After': retryAfter}` type properties.
				filter: {
					regex: '[- ]',
					match: false,
				},
			},
			// MOD: Variable separately to allow for UPPER_CASE const
			{
				selector: ['variable'],
				modifiers: ['const'],
				format: ['strictCamelCase', 'UPPER_CASE'],
			},
			{
				selector: ['variable'],
				format: [
					'strictCamelCase',
				],
				// We allow double underscope because of GraphQL type names and some React names.
				leadingUnderscore: 'allowSingleOrDouble',
				trailingUnderscore: 'allow',
			},
			{
				selector: 'typeLike',
				format: [
					// MOD: Allow for OBS
					'PascalCase',
				],
			},
			{
				selector: 'variable',
				types: [
					'boolean',
				],
				format: [
					'StrictPascalCase',
				],
				prefix: [
					'is',
					'has',
					'can',
					'should',
					'will',
					'did',
				],
			},
			{
				// Interface name should not be prefixed with `I`.
				selector: 'interface',
				filter: /^(?!I)[A-Z]/.source,
				format: [
					// MOD: Allow for OBS
					'PascalCase',
				],
			},
			{
				// Type parameter name should either be `T` or a descriptive name.
				selector: 'typeParameter',
				filter: /^T$|^[A-Z][a-zA-Z]+$/.source,
				format: [
					'StrictPascalCase',
				],
			},
			// Allow these in non-camel-case when quoted.
			{
				selector: [
					'classProperty',
					'objectLiteralProperty',
				],
				format: null,
				modifiers: [
					'requiresQuotes',
				],
			},
		],
		'capitalized-comments': 'off',
		'jsdoc/check-tag-names': ['warn', {
			definedTags: ['category', 'complexity', 'defaultValue', 'initialVersion', 'restrictions', 'rpcVersion'],
		}],
		'@typescript-eslint/consistent-type-definitions': 'off',
		// Better handled by typescript
		'jsdoc/require-param-type': 'off',
		'jsdoc/require-returns-type': 'off',
		'jsdoc/valid-types': 'off',
	},
	settings: {
		jsdoc: {
			ignorePrivate: true,
		},
	},
	overrides: [
		{
			files: ['tests/**/*.{js,ts}'],
			extends: [
				'plugin:ava/recommended',
			],
			rules: {
				'jsdoc/require-jsdoc': 'off',
			},
		},
	],
};