common.ts

import eslintPluginStylistic from "@stylistic/eslint-plugin";
import eslintPluginStylisticJsx from "@stylistic/eslint-plugin-jsx";
import eslintPluginStylisticTs from "@stylistic/eslint-plugin-ts";
import type { TSESLint } from "@typescript-eslint/utils";
import eslintPluginImport from "eslint-plugin-import-x";
import eslintPluginJsdoc from "eslint-plugin-jsdoc";
// @ts-expect-error eslint-plugin-promise is not typed
import eslintPluginPromise from "eslint-plugin-promise";
import eslintPluginUnicorn from "eslint-plugin-unicorn";
import globals from "globals";

const rules: TSESLint.FlatConfig.Rules = {
	"accessor-pairs": 0,
	"array-callback-return": 2,
	"arrow-body-style": [2, "as-needed"],
	"block-scoped-var": 2,
	camelcase: 0,
	"capitalized-comments": 0,
	"class-methods-use-this": 0,
	complexity: 0,
	"consistent-return": 2,
	"consistent-this": [2, "self"],
	"constructor-super": 2,
	curly: 2,
	"default-case": 2,
	"default-case-last": 2,
	"default-param-last": 2,
	"dot-notation": 2,
	eqeqeq: 2,
	"for-direction": 2,
	"func-name-matching": 2,
	"func-names": [2, "as-needed"],
	"func-style": [
		2,
		"declaration",
		{
			allowArrowFunctions: true,
		},
	],
	"getter-return": 2,
	"grouped-accessor-pairs": [2, "getBeforeSet"],
	"guard-for-in": 2,
	"id-denylist": 0,
	"id-length": [
		2,
		{
			exceptions: ["_", "$", "a", "b", "x", "y"],
			min: 2,
		},
	],
	"id-match": 0,
	"import-x/default": 0,
	"import-x/dynamic-import-chunkname": 0,
	"import-x/export": 0,
	"import-x/exports-last": 0,
	"import-x/extensions": 0,
	"import-x/first": 2,
	"import-x/group-exports": 0,
	"import-x/max-dependencies": 0,
	"import-x/named": 0,
	"import-x/namespace": 0,
	"import-x/newline-after-import": 2,
	"import-x/no-absolute-path": 2,
	"import-x/no-amd": 2,
	"import-x/no-anonymous-default-export": 0,
	"import-x/no-commonjs": 0,
	"import-x/no-cycle": 0,
	"import-x/no-default-export": 0,
	"import-x/no-deprecated": 0,
	"import-x/no-duplicates": 2,
	"import-x/no-dynamic-require": 2,
	"import-x/no-extraneous-dependencies": [
		2,
		{
			devDependencies: true,
			optionalDependencies: true,
			peerDependencies: true,
		},
	],
	"import-x/no-import-module-exports": 0,
	"import-x/no-internal-modules": 0,
	"import-x/no-mutable-exports": 2,
	"import-x/no-named-as-default": 0,
	"import-x/no-named-as-default-member": 0,
	"import-x/no-named-default": 0,
	"import-x/no-named-export": 0,
	"import-x/no-namespace": 0,
	"import-x/no-nodejs-modules": 0,
	"import-x/no-relative-packages": 0,
	"import-x/no-relative-parent-imports": 0,
	"import-x/no-restricted-paths": 0,
	"import-x/no-self-import": 2,
	"import-x/no-unassigned-import": 0,
	"import-x/no-unresolved": 0,
	"import-x/no-unused-modules": 0,
	"import-x/no-useless-path-segments": 2,
	"import-x/no-webpack-loader-syntax": 2,
	"import-x/order": [
		2,
		{
			alphabetize: {
				caseInsensitive: false,
				order: "asc",
			},
			groups: ["builtin", "external", "internal", "parent", "sibling", "index"],
			"newlines-between": "never",
		},
	],
	"import-x/prefer-default-export": 0,
	"import-x/unambiguous": 0,
	"init-declarations": 0,
	"jsdoc/check-access": 2,
	"jsdoc/check-alignment": 2,
	"jsdoc/check-examples": 0,
	"jsdoc/check-indentation": 0,
	"jsdoc/check-line-alignment": 0,
	"jsdoc/check-param-names": 2,
	"jsdoc/check-property-names": 2,
	"jsdoc/check-syntax": 2,
	"jsdoc/check-tag-names": 2,
	"jsdoc/check-types": 2,
	"jsdoc/check-values": 2,
	"jsdoc/empty-tags": 2,
	"jsdoc/implements-on-classes": 2,
	"jsdoc/match-description": 0,
	"jsdoc/match-name": 0,
	"jsdoc/multiline-blocks": [
		2,
		{
			noMultilineBlocks: false,
			noSingleLineBlocks: true,
		},
	],
	"jsdoc/no-bad-blocks": 2,
	"jsdoc/no-blank-blocks": 2,
	"jsdoc/no-blank-block-descriptions": 2,
	"jsdoc/no-defaults": 2,
	"jsdoc/no-missing-syntax": 0,
	"jsdoc/no-multi-asterisks": 2,
	"jsdoc/no-restricted-syntax": 0,
	"jsdoc/no-types": 0,
	"jsdoc/no-undefined-types": 2,
	"jsdoc/require-asterisk-prefix": 2,
	"jsdoc/require-description": 0,
	"jsdoc/require-description-complete-sentence": 0,
	"jsdoc/require-example": 0,
	"jsdoc/require-file-overview": 0,
	"jsdoc/require-hyphen-before-param-description": 0,
	"jsdoc/require-jsdoc": 0,
	"jsdoc/require-param": 0,
	"jsdoc/require-param-description": 0,
	"jsdoc/require-param-name": 2,
	"jsdoc/require-param-type": 0,
	"jsdoc/require-property": 2,
	"jsdoc/require-property-description": 2,
	"jsdoc/require-property-name": 2,
	"jsdoc/require-property-type": 2,
	"jsdoc/require-returns": 0,
	"jsdoc/require-returns-check": 0,
	"jsdoc/require-returns-description": 0,
	"jsdoc/require-returns-type": 0,
	"jsdoc/require-throws": 0,
	"jsdoc/require-yields": 0,
	"jsdoc/require-yields-check": 0,
	"jsdoc/tag-lines": [
		2,
		"never",
		{
			startLines: 1,
		},
	],
	"jsdoc/valid-types": 2,
	"max-classes-per-file": 0,
	"max-depth": 0,
	"max-lines": 0,
	"max-lines-per-function": 0,
	"max-nested-callbacks": 0,
	"max-params": 0,
	"max-statements": 0,
	"new-cap": 0,
	"no-alert": 2,
	"no-array-constructor": 2,
	"no-async-promise-executor": 2,
	"no-await-in-loop": 0,
	"no-bitwise": 0,
	"no-caller": 2,
	"no-case-declarations": 2,
	"no-class-assign": 2,
	"no-compare-neg-zero": 2,
	"no-cond-assign": 2,
	"no-console": 0,
	"no-const-assign": 2,
	"no-constant-condition": 0,
	"no-constructor-return": 2,
	"no-continue": 0,
	"no-control-regex": 2,
	"no-debugger": 2,
	"no-delete-var": 2,
	"no-div-regex": 0,
	"no-dupe-args": 2,
	"no-dupe-class-members": 2,
	"no-dupe-else-if": 2,
	"no-dupe-keys": 2,
	"no-duplicate-case": 2,
	"no-duplicate-imports": 0,
	"no-else-return": 0,
	"no-empty": 0,
	"no-empty-character-class": 2,
	"no-empty-pattern": 2,
	"no-eq-null": 2,
	"no-eval": 2,
	"no-ex-assign": 2,
	"no-extend-native": 2,
	"no-extra-bind": 2,
	"no-extra-boolean-cast": 2,
	"no-extra-label": 2,
	"no-fallthrough": 2,
	"no-func-assign": 2,
	"no-global-assign": 2,
	"no-implicit-coercion": 2,
	"no-implicit-globals": 2,
	"no-implied-eval": 2,
	"no-import-assign": 2,
	"no-inline-comments": 2,
	"no-inner-declarations": 2,
	"no-invalid-regexp": 2,
	"no-invalid-this": 0,
	"no-irregular-whitespace": 2,
	"no-iterator": 2,
	"no-label-var": 2,
	"no-labels": 2,
	"no-lone-blocks": 2,
	"no-lonely-if": 2,
	"no-loop-func": 2,
	"no-loss-of-precision": 2,
	"no-magic-numbers": 0,
	"no-misleading-character-class": 2,
	"no-multi-assign": 2,
	"no-multi-str": 2,
	"no-negated-condition": 2,
	"no-nested-ternary": 0,
	"no-new": 0,
	"no-new-func": 2,
	"no-new-object": 2,
	"no-new-symbol": 2,
	"no-new-wrappers": 2,
	"no-nonoctal-decimal-escape": 2,
	"no-obj-calls": 2,
	"no-octal": 2,
	"no-octal-escape": 2,
	"no-param-reassign": [
		2,
		{
			props: false,
		},
	],
	"no-plusplus": 0,
	"no-promise-executor-return": 2,
	"no-proto": 2,
	"no-prototype-builtins": 2,
	"no-redeclare": [
		2,
		{
			builtinGlobals: true,
		},
	],
	"no-regex-spaces": 2,
	"no-restricted-exports": 0,
	"no-restricted-globals": 0,
	"no-restricted-imports": 0,
	"no-restricted-properties": 0,
	"no-restricted-syntax": 0,
	"no-return-assign": 2,
	"no-return-await": 2,
	"no-script-url": 2,
	"no-self-assign": 2,
	"no-self-compare": 2,
	"no-sequences": 2,
	"no-setter-return": 2,
	"no-shadow": [
		2,
		{
			builtinGlobals: false,
			hoist: "all",
		},
	],
	"no-shadow-restricted-names": 2,
	"no-sparse-arrays": 0,
	"no-template-curly-in-string": 2,
	"no-ternary": 0,
	"no-this-before-super": 2,
	"no-throw-literal": 2,
	"no-undef": 2,
	"no-undef-init": 2,
	"no-undefined": 0,
	"no-underscore-dangle": 0,
	"no-unexpected-multiline": 2,
	"no-unmodified-loop-condition": 2,
	"no-unneeded-ternary": 2,
	"no-unreachable": 0,
	"no-unreachable-loop": 2,
	"no-unsafe-finally": 2,
	"no-unsafe-negation": 2,
	"no-unsafe-optional-chaining": 2,
	"no-unused-expressions": 2,
	"no-unused-labels": 2,
	"no-unused-private-class-members": 0,
	"no-unused-vars": 2,
	"no-use-before-define": [
		2,
		{
			classes: true,
			functions: false,
			variables: true,
		},
	],
	"no-useless-backreference": 2,
	"no-useless-call": 2,
	"no-useless-catch": 2,
	"no-useless-computed-key": 2,
	"no-useless-concat": 2,
	"no-useless-constructor": 2,
	"no-useless-escape": 2,
	"no-useless-rename": [
		2,
		{
			ignoreDestructuring: false,
			ignoreExport: false,
			ignoreImport: false,
		},
	],
	"no-useless-return": 2,
	"no-var": 2,
	"no-void": 0,
	"no-warning-comments": [
		1,
		{
			location: "start",
			terms: ["todo", "@todo"],
		},
	],
	"no-with": 2,
	"object-shorthand": [2, "always"],
	"one-var": [2, "never"],
	"operator-assignment": [2, "always"],
	"prefer-arrow-callback": 2,
	"prefer-const": 2,
	"prefer-destructuring": 0,
	"prefer-exponentiation-operator": 2,
	"prefer-named-capture-group": 1,
	"prefer-numeric-literals": 2,
	"prefer-object-has-own": 2,
	"prefer-object-spread": 2,
	"prefer-promise-reject-errors": 2,
	"prefer-regex-literals": [
		2,
		{
			disallowRedundantWrapping: true,
		},
	],
	"prefer-rest-params": 2,
	"prefer-spread": 2,
	"prefer-template": 0,
	"promise/param-names": 2,
	"promise/prefer-await-to-callbacks": 1,
	"promise/prefer-await-to-then": 2,
	"promise/valid-params": 2,
	radix: 2,
	"require-atomic-updates": 2,
	"require-await": 0,
	"require-unicode-regexp": 0,
	"require-yield": 2,
	"sort-imports": 0,
	"sort-keys": 0,
	"sort-vars": 2,
	strict: [2, "never"],
	"symbol-description": 2,
	"unicode-bom": [2, "never"],
	"unicorn/better-regex": 2,
	"unicorn/catch-error-name": [
		"error",
		{
			name: "error",
		},
	],
	"unicorn/consistent-destructuring": 0,
	"unicorn/consistent-function-scoping": 2,
	"unicorn/custom-error-definition": 0,
	"unicorn/empty-brace-spaces": 2,
	"unicorn/error-message": 2,
	"unicorn/escape-case": 2,
	"unicorn/expiring-todo-comments": [
		2,
		{
			allowWarningComments: true,
			ignoreDatesOnPullRequests: true,
			terms: ["TODO", "todo"],
		},
	],
	"unicorn/explicit-length-check": 0,
	"unicorn/filename-case": 0,
	"unicorn/import-style": 0,
	"unicorn/new-for-builtins": 2,
	"unicorn/no-abusive-eslint-disable": 2,
	"unicorn/no-array-callback-reference": 0,
	"unicorn/no-array-for-each": 1,
	"unicorn/no-array-method-this-argument": 2,
	"unicorn/no-array-push-push": 0,
	"unicorn/no-array-reduce": 0,
	"unicorn/no-await-expression-member": 0,
	"unicorn/no-console-spaces": 0,
	"unicorn/no-document-cookie": 2,
	"unicorn/no-empty-file": 2,
	"unicorn/no-for-loop": 2,
	"unicorn/no-hex-escape": 2,
	"unicorn/no-instanceof-array": 2,
	"unicorn/no-invalid-remove-event-listener": 2,
	"unicorn/no-keyword-prefix": 0,
	"unicorn/no-lonely-if": 2,
	"unicorn/no-nested-ternary": 0,
	"unicorn/no-new-array": 2,
	"unicorn/no-new-buffer": 2,
	"unicorn/no-null": 0,
	"unicorn/no-object-as-default-parameter": 2,
	"unicorn/no-process-exit": 0,
	"unicorn/no-static-only-class": 2,
	"unicorn/no-thenable": 2,
	"unicorn/no-this-assignment": 2,
	"unicorn/no-unnecessary-await": 2,
	"unicorn/no-unreadable-array-destructuring": 0,
	"unicorn/no-unreadable-iife": 2,
	"unicorn/no-unsafe-regex": 2,
	"unicorn/no-unused-properties": 2,
	"unicorn/no-useless-fallback-in-spread": 2,
	"unicorn/no-useless-length-check": 2,
	"unicorn/no-useless-promise-resolve-reject": 2,
	"unicorn/no-useless-spread": 2,
	"unicorn/no-useless-switch-case": 2,
	"unicorn/no-useless-undefined": 0,
	"unicorn/no-zero-fractions": 2,
	"unicorn/number-literal-case": 2,
	"unicorn/numeric-separators-style": [
		2,
		{
			hexadecimal: {
				onlyIfContainsSeparator: true,
			},
			binary: {
				onlyIfContainsSeparator: true,
			},
			octal: {
				onlyIfContainsSeparator: true,
			},
			number: {
				groupLength: 3,
				minimumDigits: 0,
			},
		},
	],
	"unicorn/prefer-add-event-listener": 0,
	"unicorn/prefer-array-find": 2,
	"unicorn/prefer-array-flat": 2,
	"unicorn/prefer-array-flat-map": 2,
	"unicorn/prefer-array-index-of": 2,
	"unicorn/prefer-array-some": 2,
	"unicorn/prefer-at": 0,
	"unicorn/prefer-code-point": 2,
	"unicorn/prefer-date-now": 2,
	"unicorn/prefer-default-parameters": 2,
	"unicorn/prefer-export-from": 2,
	"unicorn/prefer-includes": 2,
	"unicorn/prefer-json-parse-buffer": 0,
	"unicorn/prefer-math-trunc": 2,
	"unicorn/prefer-modern-math-apis": 2,
	"unicorn/prefer-native-coercion-functions": 2,
	"unicorn/prefer-negative-index": 0,
	"unicorn/prefer-number-properties": 2,
	"unicorn/prefer-object-from-entries": 2,
	"unicorn/prefer-optional-catch-binding": 2,
	"unicorn/prefer-prototype-methods": 0,
	"unicorn/prefer-query-selector": 2,
	"unicorn/prefer-reflect-apply": 2,
	"unicorn/prefer-regexp-test": 2,
	"unicorn/prefer-set-has": 0,
	"unicorn/prefer-spread": 0,
	"unicorn/prefer-string-replace-all": 2,
	"unicorn/prefer-string-slice": 2,
	"unicorn/prefer-string-starts-ends-with": 2,
	"unicorn/prefer-string-trim-start-end": 2,
	"unicorn/prefer-switch": 0,
	"unicorn/prefer-ternary": 0,
	"unicorn/prefer-top-level-await": 0,
	"unicorn/prefer-type-error": 2,
	"unicorn/prevent-abbreviations": 0,
	"unicorn/relative-url-style": [2, "never"],
	"unicorn/require-array-join-separator": 2,
	"unicorn/require-number-to-fixed-digits-argument": 2,
	"unicorn/require-post-message-target-origin": 2,
	"unicorn/string-content": 0,
	"unicorn/switch-case-braces": 0,
	"unicorn/template-indent": 2,
	"unicorn/text-encoding-identifier-case": 2,
	"unicorn/throw-new-error": 2,
	"use-isnan": 2,
	"valid-typeof": [
		2,
		{
			requireStringLiterals: true,
		},
	],
	"vars-on-top": 2,
	yoda: [2, "never"],

	// Stylistic
	"@stylistic/js/array-bracket-newline": [
		2,
		{
			multiline: true,
		},
	],
	"@stylistic/js/array-bracket-spacing": [2, "never"],
	"@stylistic/js/array-element-newline": [
		2,
		{
			multiline: true,
		},
	],
	"@stylistic/js/arrow-parens": [2, "always"],
	"@stylistic/js/arrow-spacing": [
		2,
		{
			after: true,
			before: true,
		},
	],
	"@stylistic/js/block-spacing": [2, "always"],
	"@stylistic/js/brace-style": [
		2,
		"1tbs",
		{
			allowSingleLine: false,
		},
	],
	"@stylistic/js/comma-dangle": [
		2,
		{
			arrays: "always-multiline",
			exports: "always-multiline",
			functions: "always-multiline",
			imports: "always-multiline",
			objects: "always-multiline",
		},
	],
	"@stylistic/js/comma-spacing": [
		2,
		{
			after: true,
			before: false,
		},
	],
	"@stylistic/js/comma-style": [2, "last"],
	"@stylistic/js/computed-property-spacing": [2, "never"],
	"@stylistic/js/dot-location": [2, "property"],
	"@stylistic/js/eol-last": 2,
	"@stylistic/js/func-call-spacing": [2, "never"],
	"@stylistic/js/function-call-argument-newline": [2, "consistent"],
	"@stylistic/js/function-paren-newline": [2, "consistent"],
	"@stylistic/js/generator-star-spacing": [
		2,
		{
			after: false,
			before: true,
		},
	],
	"@stylistic/js/implicit-arrow-linebreak": [2, "beside"],
	"@stylistic/js/indent": [2, "tab"],
	"@stylistic/js/jsx-quotes": [2, "prefer-single"],
	"@stylistic/js/key-spacing": [
		2,
		{
			afterColon: true,
			beforeColon: false,
		},
	],
	"@stylistic/js/keyword-spacing": [
		2,
		{
			after: true,
			before: true,
		},
	],
	"@stylistic/js/line-comment-position": [
		2,
		{
			position: "above",
		},
	],
	"@stylistic/js/linebreak-style": [2, "unix"],
	"@stylistic/js/lines-around-comment": 0,
	"@stylistic/js/lines-between-class-members": [2, "always"],
	"@stylistic/js/max-len": 0,
	"@stylistic/js/max-statements-per-line": [
		2,
		{
			max: 1,
		},
	],
	"@stylistic/js/multiline-comment-style": 0,
	"@stylistic/js/multiline-ternary": 0,
	"@stylistic/js/new-parens": 2,
	"@stylistic/js/newline-per-chained-call": 0,
	"@stylistic/js/no-confusing-arrow": 0,
	"@stylistic/js/no-extra-parens": 2,
	"@stylistic/js/no-extra-semi": 2,
	"@stylistic/js/no-floating-decimal": 2,
	"@stylistic/js/no-mixed-operators": 0,
	"@stylistic/js/no-mixed-spaces-and-tabs": 2,
	"@stylistic/js/no-multi-spaces": 2,
	"@stylistic/js/no-multiple-empty-lines": [
		2,
		{
			max: 1,
			maxBOF: 0,
			maxEOF: 1,
		},
	],
	"@stylistic/js/no-tabs": [
		2,
		{
			allowIndentationTabs: true,
		},
	],
	"@stylistic/js/no-trailing-spaces": 2,
	"@stylistic/js/no-whitespace-before-property": 2,
	"@stylistic/js/nonblock-statement-body-position": [2, "below"],
	"@stylistic/js/object-curly-newline": [
		2,
		{
			multiline: true,
		},
	],
	"@stylistic/js/object-curly-spacing": [2, "always"],
	"@stylistic/js/object-property-newline": [
		2,
		{
			allowAllPropertiesOnSameLine: false,
		},
	],
	"@stylistic/js/one-var-declaration-per-line": 2,
	"@stylistic/js/operator-linebreak": [2, "after"],
	"@stylistic/js/padded-blocks": [2, "never"],
	"@stylistic/js/padding-line-between-statements": [
		2,
		{
			blankLine: "always",
			next: "*",
			prev: "multiline-block-like",
		},
	],
	"@stylistic/js/quote-props": [
		2,
		"as-needed",
		{
			numbers: true,
		},
	],
	"@stylistic/js/quotes": [2, "double"],
	"@stylistic/js/rest-spread-spacing": [2, "never"],
	"@stylistic/js/semi": [2, "always"],
	"@stylistic/js/semi-spacing": [
		2,
		{
			after: true,
			before: false,
		},
	],
	"@stylistic/js/semi-style": [2, "last"],
	"@stylistic/js/space-before-blocks": [2, "always"],
	"@stylistic/js/space-before-function-paren": [
		2,
		{
			anonymous: "always",
			asyncArrow: "always",
			named: "never",
		},
	],
	"@stylistic/js/space-in-parens": [2, "never"],
	"@stylistic/js/space-infix-ops": [
		2,
		{
			int32Hint: true,
		},
	],
	"@stylistic/js/space-unary-ops": [
		2,
		{
			nonwords: false,
			words: true,
		},
	],
	"@stylistic/js/spaced-comment": [
		2,
		"always",
		{
			markers: ["/"],
		},
	],
	"@stylistic/js/switch-colon-spacing": [
		2,
		{
			after: true,
			before: false,
		},
	],
	"@stylistic/js/template-curly-spacing": [2, "never"],
	"@stylistic/js/template-tag-spacing": [2, "never"],
	"@stylistic/js/wrap-iife": [2, "inside"],
	"@stylistic/js/wrap-regex": 0,
	"@stylistic/js/yield-star-spacing": [
		2,
		{
			after: true,
			before: false,
		},
	],
};

const settings: TSESLint.FlatConfig.Settings = {
	"import-x/extensions": [".js"],
	"import-x/resolver": {
		node: {
			extensions: [".js"],
		},
	},
};

const config: TSESLint.FlatConfig.ConfigArray = [
	{
		linterOptions: {
			reportUnusedDisableDirectives: true,
		},
		languageOptions: {
			ecmaVersion: "latest",
			sourceType: "module",
			globals: globals.builtin,
			parserOptions: {
				requireConfigFile: false,
				ecmaFeatures: {
					globalReturn: false,
					impliedStrict: true,
				},
			},
		},
		plugins: {
			"import-x": eslintPluginImport,
			jsdoc: eslintPluginJsdoc,
			unicorn: eslintPluginUnicorn,
			promise: eslintPluginPromise,
			"@stylistic/js": eslintPluginStylistic,
			"@stylistic/jsx": eslintPluginStylisticJsx,
			"@stylistic/ts": eslintPluginStylisticTs,
		},
		rules,
		settings,
	},
];

export default config;