xo.config.ts

/**
 * @file XO Flat config file.
 */

import importPlugin from 'eslint-plugin-import';
import jsdoc from 'eslint-plugin-jsdoc';
import tseslint from 'typescript-eslint';

const xoConfig = [
	{
		prettier: true,
	},
	jsdoc.configs['flat/recommended'],
	tseslint.configs.recommended,
	{
		// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
		plugins: {jsdoc, import: importPlugin},
		rules: {
			'sort-imports': [
				'error',
				{
					ignoreCase: false,
					ignoreDeclarationSort: true,
					ignoreMemberSort: false,
					memberSyntaxSortOrder: ['none', 'all', 'multiple', 'single'],
					allowSeparatedGroups: false,
				},
			],
			'n/no-extraneous-import': 'off',
			'import-x/no-extraneous-dependencies': 'off',
			'import/no-named-as-default': 'off',
			// eslint-disable-next-line @typescript-eslint/naming-convention
			'import/extensions': 'off',
			// eslint-disable-next-line @typescript-eslint/naming-convention
			'import/order': [
				'error',
				{
					groups: ['builtin', 'external', 'parent', 'sibling', 'index'],
					alphabetize: {
						order: 'asc',
						caseInsensitive: true,
					},
					warnOnUnassignedImports: true,
					'newlines-between': 'never',
				},
			],
			'no-console': ['error', {allow: ['warn', 'error']}],
			'no-warning-comments': [
				'warn',
				{
					terms: ['fixme', 'xxx'],
				},
			],
			'jsdoc/require-file-overview': 'error',
			'jsdoc/require-description': 'error',
			'jsdoc/no-bad-blocks': 'error',
			'jsdoc/no-blank-blocks': 'error',
			'jsdoc/no-blank-block-descriptions': 'error',
			'jsdoc/check-syntax': 'error',
			'jsdoc/require-asterisk-prefix': 'error',
			'jsdoc/require-description-complete-sentence': 'error',
			'jsdoc/require-hyphen-before-param-description': ['error', 'never'],
		},
	},
	{
		files: ['{libs,components}/*/src/**/*.js'],
		rules: {
			camelcase: 'off',
			'jsdoc/require-file-overview': 'off',
			'jsdoc/require-description': 'off',
			'jsdoc/require-jsdoc': 'off',
		},
	},
];

export default xoConfig;