@wordpress/eslint-plugin/configs/recommended.js

ESLint plugin for WordPress development.

/**
 * External dependencies
 */
const { cosmiconfigSync } = require( 'cosmiconfig' );

/**
 * Internal dependencies
 */
const { isPackageInstalled } = require( '../utils' );
const recommendedWithFormattingConfig = require( './recommended-with-formatting' );

const config = [ ...recommendedWithFormattingConfig ];

if ( isPackageInstalled( 'prettier' ) ) {
	const eslintPluginPrettier = require( 'eslint-plugin-prettier' );
	const eslintConfigPrettier = require( 'eslint-config-prettier' );

	const { config: localPrettierConfig } =
		cosmiconfigSync( 'prettier' ).search() || {};
	const defaultPrettierConfig = require( '@wordpress/prettier-config' );
	const prettierConfig = { ...defaultPrettierConfig, ...localPrettierConfig };

	config.push( eslintConfigPrettier, {
		plugins: {
			prettier: eslintPluginPrettier,
		},
		rules: {
			...eslintConfigPrettier.rules,
			'prettier/prettier': [ 'error', prettierConfig ],
			// Prettier _disables_ this rule, but we want it!
			// See https://github.com/prettier/eslint-config-prettier?tab=readme-ov-file#curly
			// > This rule requires certain options.
			// > …
			// > If you like this rule, it can be used just fine with Prettier as long as you don't use the "multi-line" or "multi-or-nest" option.
			curly: [ 'error', 'all' ],
		},
	} );
}

if ( isPackageInstalled( 'typescript' ) ) {
	const tseslint = require( 'typescript-eslint' );

	config.push(
		tseslint.configs.eslintRecommended,
		{
			settings: {
				'import/resolver': {
					typescript: {
						extensions: [ '.js', '.jsx', '.ts', '.tsx' ],
					},
				},
			},
			ignores: [ '**/*.d.ts' ],
		},
		{
			files: [ '**/*.ts', '**/*.tsx' ],
			languageOptions: {
				parser: tseslint.parser,
			},
			plugins: {
				'@typescript-eslint': tseslint.plugin,
			},
			rules: {
				'no-duplicate-imports': 'off',
				'import/no-duplicates': 'error',
				// Don't require redundant JSDoc types in TypeScript files.
				'jsdoc/require-param-type': 'off',
				'jsdoc/require-returns-type': 'off',
				// Use eslint for unused variable and parameter detection.
				// This overlaps with TypeScript noUnusedLocals and noUnusedParameters settings.
				// TypeScript may only run on a subset of files. Prefer eslint which is more
				// likely to run on the entire codebase.
				'no-unused-vars': 'off',
				'@typescript-eslint/no-unused-vars': [
					'error',
					{ ignoreRestSiblings: true },
				],
				// no-shadow doesn't work correctly in TS, so let's use a TS-dedicated version instead.
				'no-shadow': 'off',
				'@typescript-eslint/no-shadow': 'error',
				'@typescript-eslint/method-signature-style': 'error',
				// TypeScript already checks for these types of issues, so don't
				// waste time checking them again.
				// See: https://typescript-eslint.io/troubleshooting/typed-linting/performance/
				'import/no-unresolved': 'off',
				'import/default': 'off',
				'import/named': 'off',
			},
		}
	);
}

module.exports = config;