@eienjs/eslint-config 1.2.2 → 1.4.0

package/dist/configs/nuxt.js

@@ -0,0 +1,137 @@
+import { GLOB_EXTS, GLOB_SRC, GLOB_VUE } from "../globs.js";
+import { ensurePackages, interopDefault } from "../utils.js";
+import { join } from "pathe";
+
+//#region src/configs/nuxt.ts
+async function nuxt(options = {}) {
+	const { overrides = {}, dirs = {}, version = 4, stylistic = true } = options;
+	const { sortConfigKeys = Boolean(stylistic) } = options;
+	await ensurePackages(["@nuxt/eslint-plugin"]);
+	const pluginNuxt = await interopDefault(import("@nuxt/eslint-plugin"));
+	dirs.root = dirs.root ?? [version === 4 ? "./app" : "."];
+	dirs.src = dirs.src ?? dirs.root;
+	dirs.pages = dirs.pages ?? dirs.src.map((src) => `${src}/pages`);
+	dirs.layouts = dirs.layouts ?? dirs.src.map((src) => `${src}/layouts`);
+	dirs.components = dirs.components ?? dirs.src.map((src) => `${src}/components`);
+	dirs.composables = dirs.composables ?? dirs.src.map((src) => `${src}/composables`);
+	dirs.plugins = dirs.plugins ?? dirs.src.map((src) => `${src}/plugins`);
+	dirs.modules = dirs.modules ?? dirs.src.map((src) => `${src}/modules`);
+	dirs.middleware = dirs.middleware ?? dirs.src.map((src) => `${src}/middleware`);
+	dirs.servers = dirs.servers ?? dirs.src.map((src) => `${src}/servers`);
+	dirs.utils = dirs.utils ?? dirs.src.map((src) => `${src}/utils`);
+	dirs.componentsPrefixed = dirs.componentsPrefixed ?? [];
+	const fileSingleRoot = [
+		...dirs.layouts.map((layoutsDir) => join(layoutsDir, `**/*.${GLOB_EXTS}`)),
+		...dirs.pages.map((pagesDir) => join(pagesDir, `**/*.${GLOB_EXTS}`)),
+		...dirs.components.map((componentsDir) => join(componentsDir, `**/*.server.${GLOB_EXTS}`))
+	].toSorted();
+	const INLINE_ELEMENTS = [
+		"a",
+		"abbr",
+		"audio",
+		"b",
+		"bdi",
+		"bdo",
+		"canvas",
+		"cite",
+		"code",
+		"data",
+		"del",
+		"dfn",
+		"em",
+		"i",
+		"iframe",
+		"ins",
+		"kbd",
+		"label",
+		"map",
+		"mark",
+		"noscript",
+		"object",
+		"output",
+		"picture",
+		"q",
+		"ruby",
+		"s",
+		"samp",
+		"small",
+		"span",
+		"strong",
+		"sub",
+		"sup",
+		"svg",
+		"time",
+		"u",
+		"var",
+		"video"
+	];
+	return [
+		{
+			name: "eienjs/nuxt/setup",
+			plugins: { nuxt: pluginNuxt },
+			languageOptions: { globals: { $fetch: "readonly" } }
+		},
+		...fileSingleRoot.length > 0 ? [{
+			files: fileSingleRoot,
+			name: "eienjs/nuxt/vue/single-root",
+			rules: { "vue/no-multiple-template-root": "error" }
+		}] : [],
+		{
+			name: "eienjs/nuxt/rules",
+			rules: {
+				"nuxt/prefer-import-meta": "error",
+				...overrides
+			}
+		},
+		{
+			files: dirs.utils.map((utilsDir) => join(utilsDir, GLOB_SRC)),
+			name: "eienjs/nuxt/utils-disables",
+			rules: { "@typescript-eslint/explicit-module-boundary-types": "off" }
+		},
+		...sortConfigKeys ? [{
+			files: ["**/nuxt.config.?([cm])[jt]s?(x)"],
+			name: "eienjs/nuxt/sort-config",
+			rules: { "nuxt/nuxt-config-keys-order": "error" }
+		}] : [],
+		...stylistic ? [{
+			files: [GLOB_VUE],
+			name: "eienjs/nuxt/vue/rules",
+			rules: {
+				"vue/multiline-html-element-content-newline": ["error", {
+					ignoreWhenEmpty: true,
+					ignores: [
+						"pre",
+						"textarea",
+						"router-link",
+						"RouterLink",
+						"nuxt-link",
+						"NuxtLink",
+						"u-link",
+						"ULink",
+						...INLINE_ELEMENTS
+					],
+					allowEmptyLines: false
+				}],
+				"vue/singleline-html-element-content-newline": ["error", {
+					ignoreWhenNoAttributes: true,
+					ignoreWhenEmpty: true,
+					ignores: [
+						"pre",
+						"textarea",
+						"router-link",
+						"RouterLink",
+						"nuxt-link",
+						"NuxtLink",
+						"u-link",
+						"ULink",
+						...INLINE_ELEMENTS
+					],
+					externalIgnores: []
+				}]
+			}
+		}] : []
+	];
+}
+
+//#endregion
+export { nuxt };

package/dist/configs/perfectionist.d.ts

@@ -0,0 +1,12 @@
+import { TypedFlatConfigItem } from "../types.js";
+
+//#region src/configs/perfectionist.d.ts
+
+/**
+ * Perfectionist plugin for props and items sorting.
+ *
+ * @see https://github.com/azat-io/eslint-plugin-perfectionist
+ */
+declare function perfectionist(): TypedFlatConfigItem[];
+//#endregion
+export { perfectionist };

package/dist/configs/perfectionist.js

@@ -0,0 +1,56 @@
+import { pluginPerfectionist } from "../plugins.js";
+
+//#region src/configs/perfectionist.ts
+/**
+* Perfectionist plugin for props and items sorting.
+*
+* @see https://github.com/azat-io/eslint-plugin-perfectionist
+*/
+function perfectionist() {
+	return [{
+		name: "eienjs/perfectionist/setup",
+		plugins: { perfectionist: pluginPerfectionist },
+		rules: {
+			"perfectionist/sort-exports": ["error", {
+				order: "asc",
+				type: "natural"
+			}],
+			"perfectionist/sort-imports": ["error", {
+				groups: [
+					"type",
+					[
+						"parent-type",
+						"sibling-type",
+						"index-type",
+						"internal-type"
+					],
+					"builtin",
+					"external",
+					"internal",
+					[
+						"parent",
+						"sibling",
+						"index"
+					],
+					"side-effect",
+					"object",
+					"unknown"
+				],
+				newlinesBetween: "ignore",
+				order: "asc",
+				type: "natural"
+			}],
+			"perfectionist/sort-named-exports": ["error", {
+				order: "asc",
+				type: "natural"
+			}],
+			"perfectionist/sort-named-imports": ["error", {
+				order: "asc",
+				type: "natural"
+			}]
+		}
+	}];
+}
+
+//#endregion
+export { perfectionist };

package/dist/configs/pnpm.d.ts

@@ -0,0 +1,6 @@
+import { TypedFlatConfigItem } from "../types.js";
+
+//#region src/configs/pnpm.d.ts
+declare function pnpm(): Promise<TypedFlatConfigItem[]>;
+//#endregion
+export { pnpm };

package/dist/configs/pnpm.js

@@ -0,0 +1,33 @@
+import { interopDefault } from "../utils.js";
+
+//#region src/configs/pnpm.ts
+async function pnpm() {
+	const [pluginPnpm, yamlParser, jsoncParser] = await Promise.all([
+		interopDefault(import("eslint-plugin-pnpm")),
+		interopDefault(import("yaml-eslint-parser")),
+		interopDefault(import("jsonc-eslint-parser"))
+	]);
+	return [{
+		files: ["package.json", "**/package.json"],
+		languageOptions: { parser: jsoncParser },
+		name: "eienjs/pnpm/package-json",
+		plugins: { pnpm: pluginPnpm },
+		rules: {
+			"pnpm/json-enforce-catalog": "error",
+			"pnpm/json-prefer-workspace-settings": "error",
+			"pnpm/json-valid-catalog": "error"
+		}
+	}, {
+		files: ["pnpm-workspace.yaml"],
+		languageOptions: { parser: yamlParser },
+		name: "eienjs/pnpm/pnpm-workspace-yaml",
+		plugins: { pnpm: pluginPnpm },
+		rules: {
+			"pnpm/yaml-no-duplicate-catalog-item": "error",
+			"pnpm/yaml-no-unused-catalog-item": "error"
+		}
+	}];
+}
+
+//#endregion
+export { pnpm };

package/dist/configs/regexp.d.ts

@@ -0,0 +1,6 @@
+import { OptionsOverrides, OptionsRegExp, TypedFlatConfigItem } from "../types.js";
+
+//#region src/configs/regexp.d.ts
+declare function regexp(options?: OptionsRegExp & OptionsOverrides): TypedFlatConfigItem[];
+//#endregion
+export { regexp };

package/dist/configs/regexp.js

@@ -0,0 +1,21 @@
+import { configs } from "eslint-plugin-regexp";
+
+//#region src/configs/regexp.ts
+function regexp(options = {}) {
+	const config = configs["flat/recommended"];
+	const rules = { ...config.rules };
+	if (options.level === "warn") {
+		for (const key in rules) if (rules[key] === "error") rules[key] = "warn";
+	}
+	return [{
+		...config,
+		name: "eienjs/regexp/rules",
+		rules: {
+			...rules,
+			...options.overrides
+		}
+	}];
+}
+
+//#endregion
+export { regexp };

package/dist/configs/sort.d.ts

@@ -0,0 +1,18 @@
+import { TypedFlatConfigItem } from "../types.js";
+
+//#region src/configs/sort.d.ts
+
+/**
+ * Sort package.json
+ *
+ * Requires `jsonc` config
+ */
+declare function sortPackageJson(): TypedFlatConfigItem[];
+/**
+ * Sort tsconfig.json
+ *
+ * Requires `jsonc` config
+ */
+declare function sortTsconfig(): TypedFlatConfigItem[];
+//#endregion
+export { sortPackageJson, sortTsconfig };

package/dist/configs/sort.js

@@ -0,0 +1,239 @@
+//#region src/configs/sort.ts
+/**
+* Sort package.json
+*
+* Requires `jsonc` config
+*/
+function sortPackageJson() {
+	return [{
+		files: ["**/package.json"],
+		name: "eienjs/sort/package-json",
+		rules: {
+			"jsonc/sort-array-values": ["error", {
+				order: { type: "asc" },
+				pathPattern: "^files$"
+			}],
+			"jsonc/sort-keys": [
+				"error",
+				{
+					order: [
+						"publisher",
+						"name",
+						"displayName",
+						"type",
+						"version",
+						"private",
+						"packageManager",
+						"description",
+						"author",
+						"contributors",
+						"license",
+						"funding",
+						"homepage",
+						"repository",
+						"bugs",
+						"keywords",
+						"categories",
+						"sideEffects",
+						"imports",
+						"exports",
+						"main",
+						"module",
+						"unpkg",
+						"jsdelivr",
+						"types",
+						"typesVersions",
+						"bin",
+						"icon",
+						"files",
+						"engines",
+						"activationEvents",
+						"contributes",
+						"scripts",
+						"peerDependencies",
+						"peerDependenciesMeta",
+						"dependencies",
+						"optionalDependencies",
+						"devDependencies",
+						"pnpm",
+						"overrides",
+						"resolutions",
+						"husky",
+						"simple-git-hooks",
+						"lint-staged",
+						"eslintConfig",
+						"commitlint",
+						"publishConfig",
+						"auto-changelog",
+						"np"
+					],
+					pathPattern: "^$"
+				},
+				{
+					order: { type: "asc" },
+					pathPattern: "^(?:dev|peer|optional|bundled)?[Dd]ependencies(Meta)?$"
+				},
+				{
+					order: { type: "asc" },
+					pathPattern: "^(?:resolutions|overrides|pnpm.overrides)$"
+				},
+				{
+					order: { type: "asc" },
+					pathPattern: String.raw`^workspaces\.catalog$`
+				},
+				{
+					order: { type: "asc" },
+					pathPattern: String.raw`^workspaces\.catalogs\.[^.]+$`
+				},
+				{
+					order: [
+						"types",
+						"import",
+						"require",
+						"default"
+					],
+					pathPattern: "^exports.*$"
+				},
+				{
+					order: [
+						"pre-commit",
+						"prepare-commit-msg",
+						"commit-msg",
+						"post-commit",
+						"pre-rebase",
+						"post-rewrite",
+						"post-checkout",
+						"post-merge",
+						"pre-push",
+						"pre-auto-gc"
+					],
+					pathPattern: "^(?:gitHooks|husky|simple-git-hooks)$"
+				}
+			]
+		}
+	}];
+}
+/**
+* Sort tsconfig.json
+*
+* Requires `jsonc` config
+*/
+function sortTsconfig() {
+	return [{
+		files: ["**/[jt]sconfig.json", "**/[jt]sconfig.*.json"],
+		name: "eienjs/sort/tsconfig-json",
+		rules: { "jsonc/sort-keys": [
+			"error",
+			{
+				order: [
+					"extends",
+					"compilerOptions",
+					"references",
+					"files",
+					"include",
+					"exclude"
+				],
+				pathPattern: "^$"
+			},
+			{
+				order: [
+					"incremental",
+					"composite",
+					"tsBuildInfoFile",
+					"disableSourceOfProjectReferenceRedirect",
+					"disableSolutionSearching",
+					"disableReferencedProjectLoad",
+					"target",
+					"jsx",
+					"jsxFactory",
+					"jsxFragmentFactory",
+					"jsxImportSource",
+					"lib",
+					"moduleDetection",
+					"noLib",
+					"reactNamespace",
+					"useDefineForClassFields",
+					"emitDecoratorMetadata",
+					"experimentalDecorators",
+					"libReplacement",
+					"baseUrl",
+					"rootDir",
+					"rootDirs",
+					"customConditions",
+					"module",
+					"moduleResolution",
+					"moduleSuffixes",
+					"noResolve",
+					"paths",
+					"resolveJsonModule",
+					"resolvePackageJsonExports",
+					"resolvePackageJsonImports",
+					"typeRoots",
+					"types",
+					"allowArbitraryExtensions",
+					"allowImportingTsExtensions",
+					"allowUmdGlobalAccess",
+					"allowJs",
+					"checkJs",
+					"maxNodeModuleJsDepth",
+					"strict",
+					"strictBindCallApply",
+					"strictFunctionTypes",
+					"strictNullChecks",
+					"strictPropertyInitialization",
+					"allowUnreachableCode",
+					"allowUnusedLabels",
+					"alwaysStrict",
+					"exactOptionalPropertyTypes",
+					"noFallthroughCasesInSwitch",
+					"noImplicitAny",
+					"noImplicitOverride",
+					"noImplicitReturns",
+					"noImplicitThis",
+					"noPropertyAccessFromIndexSignature",
+					"noUncheckedIndexedAccess",
+					"noUnusedLocals",
+					"noUnusedParameters",
+					"useUnknownInCatchVariables",
+					"declaration",
+					"declarationDir",
+					"declarationMap",
+					"downlevelIteration",
+					"emitBOM",
+					"emitDeclarationOnly",
+					"importHelpers",
+					"importsNotUsedAsValues",
+					"inlineSourceMap",
+					"inlineSources",
+					"mapRoot",
+					"newLine",
+					"noEmit",
+					"noEmitHelpers",
+					"noEmitOnError",
+					"outDir",
+					"outFile",
+					"preserveConstEnums",
+					"preserveValueImports",
+					"removeComments",
+					"sourceMap",
+					"sourceRoot",
+					"stripInternal",
+					"allowSyntheticDefaultImports",
+					"esModuleInterop",
+					"forceConsistentCasingInFileNames",
+					"isolatedDeclarations",
+					"isolatedModules",
+					"preserveSymlinks",
+					"verbatimModuleSyntax",
+					"erasableSyntaxOnly",
+					"skipDefaultLibCheck",
+					"skipLibCheck"
+				],
+				pathPattern: "^compilerOptions$"
+			}
+		] }
+	}];
+}
+
+//#endregion
+export { sortPackageJson, sortTsconfig };

package/dist/configs/stylistic.d.ts

@@ -0,0 +1,8 @@
+import { OptionsOverrides, StylisticConfig, TypedFlatConfigItem } from "../types.js";
+
+//#region src/configs/stylistic.d.ts
+declare const StylisticConfigDefaults: StylisticConfig;
+interface StylisticOptions extends StylisticConfig, OptionsOverrides {}
+declare function stylistic(options?: StylisticOptions): Promise<TypedFlatConfigItem[]>;
+//#endregion
+export { StylisticConfigDefaults, StylisticOptions, stylistic };

package/dist/configs/stylistic.js

@@ -0,0 +1,76 @@
+import { interopDefault } from "../utils.js";
+import { pluginAntfu } from "../plugins.js";
+
+//#region src/configs/stylistic.ts
+const StylisticConfigDefaults = {
+	indent: 2,
+	quotes: "single"
+};
+async function stylistic(options = {}) {
+	const { indent, overrides = {}, quotes, maxLineLength = 120 } = {
+		...StylisticConfigDefaults,
+		...options
+	};
+	const pluginStylistic = await interopDefault(import("@stylistic/eslint-plugin"));
+	const config = pluginStylistic.configs.customize({
+		indent,
+		quotes,
+		semi: true
+	});
+	return [{
+		name: "eienjs/stylistic/rules",
+		plugins: {
+			"antfu": pluginAntfu,
+			"@stylistic": pluginStylistic
+		},
+		rules: {
+			...config.rules,
+			"antfu/consistent-chaining": "error",
+			"antfu/consistent-list-newline": "error",
+			"@stylistic/arrow-parens": ["error", "always"],
+			"@stylistic/brace-style": [
+				"error",
+				"1tbs",
+				{ allowSingleLine: true }
+			],
+			"@stylistic/max-len": ["warn", {
+				code: maxLineLength,
+				ignoreComments: true
+			}],
+			"@stylistic/padding-line-between-statements": [
+				"error",
+				{
+					blankLine: "always",
+					prev: "*",
+					next: ["interface", "type"]
+				},
+				{
+					blankLine: "always",
+					next: "return",
+					prev: "*"
+				}
+			],
+			"@stylistic/lines-between-class-members": ["error", "always"],
+			"@stylistic/generator-star-spacing": ["error", {
+				after: true,
+				before: false
+			}],
+			"@stylistic/quote-props": ["error", "consistent"],
+			"@stylistic/quotes": [
+				"error",
+				quotes,
+				{ avoidEscape: true }
+			],
+			"@stylistic/semi": "error",
+			"@stylistic/comma-spacing": "error",
+			"@stylistic/yield-star-spacing": ["error", {
+				after: true,
+				before: false
+			}],
+			...overrides
+		}
+	}];
+}
+
+//#endregion
+export { StylisticConfigDefaults, stylistic };

package/dist/configs/test.d.ts

@@ -0,0 +1,6 @@
+import { OptionsFiles, OptionsIsInEditor, OptionsOverrides, TypedFlatConfigItem } from "../types.js";
+
+//#region src/configs/test.d.ts
+declare function test(options?: OptionsFiles & OptionsIsInEditor & OptionsOverrides): Promise<TypedFlatConfigItem[]>;
+//#endregion
+export { test };

package/dist/configs/test.js

@@ -0,0 +1,42 @@
+import { GLOB_TESTS } from "../globs.js";
+import { interopDefault } from "../utils.js";
+
+//#region src/configs/test.ts
+let _pluginTest;
+async function test(options = {}) {
+	const { files = GLOB_TESTS, isInEditor = false, overrides = {} } = options;
+	const [pluginVitest, pluginNoOnlyTests] = await Promise.all([interopDefault(import("@vitest/eslint-plugin")), interopDefault(import("eslint-plugin-no-only-tests"))]);
+	_pluginTest = _pluginTest || {
+		...pluginVitest,
+		rules: {
+			...pluginVitest.rules,
+			...pluginNoOnlyTests.rules
+		}
+	};
+	return [{
+		name: "eienjs/test/setup",
+		plugins: { test: _pluginTest }
+	}, {
+		files,
+		name: "eienjs/test/rules",
+		rules: {
+			"test/consistent-test-it": ["error", {
+				fn: "test",
+				withinDescribe: "test"
+			}],
+			"test/no-identical-title": "error",
+			"test/no-import-node-test": "error",
+			"test/no-only-tests": isInEditor ? "warn" : "error",
+			"test/prefer-hooks-in-order": "error",
+			"test/prefer-lowercase-title": "error",
+			"antfu/no-top-level-await": "off",
+			"no-unused-expressions": "off",
+			"n/prefer-global/process": "off",
+			"@typescript-eslint/explicit-function-return-type": "off",
+			...overrides
+		}
+	}];
+}
+
+//#endregion
+export { test };

package/dist/configs/toml.d.ts

@@ -0,0 +1,6 @@
+import { OptionsFiles, OptionsOverrides, OptionsStylistic, TypedFlatConfigItem } from "../types.js";
+
+//#region src/configs/toml.d.ts
+declare function toml(options?: OptionsOverrides & OptionsStylistic & OptionsFiles): Promise<TypedFlatConfigItem[]>;
+//#endregion
+export { toml };