@eienjs/eslint-config 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,85 @@
+import { Awaitable, ConfigNames, OptionsComponentExts, OptionsConfig, OptionsFiles, OptionsFormatters, OptionsHasTypeScript, OptionsIsInEditor, OptionsOverrides, OptionsRegExp, OptionsStylistic, OptionsTypeScriptParserOptions, OptionsTypeScriptWithTypes, OptionsTypescript, OptionsVue, RuleOptions, Rules, StylisticConfig, TypedFlatConfigItem } from "./types-BDuTVdZ8.js";
+import { FlatConfigComposer } from "eslint-flat-config-utils";
+import { Linter } from "eslint";
+
+//#region src/factory.d.ts
+declare const defaultPluginRenaming: {
+  'import-lite': string;
+  vitest: string;
+  yml: string;
+};
+declare function eienjs(options?: OptionsConfig & Omit<TypedFlatConfigItem, 'files'>): FlatConfigComposer<TypedFlatConfigItem, ConfigNames>;
+type ResolvedOptions<T> = T extends boolean ? never : NonNullable<T>;
+declare function resolveSubOptions<K extends keyof OptionsConfig>(options: OptionsConfig, key: K): ResolvedOptions<OptionsConfig[K]>;
+declare function getOverrides<K extends keyof OptionsConfig>(options: OptionsConfig, key: K): Partial<Linter.RulesRecord & RuleOptions>;
+//#endregion
+//#region src/globs.d.ts
+declare const GLOB_SRC_EXT = "?([cm])[jt]s?(x)";
+declare const GLOB_SRC = "**/*.?([cm])[jt]s?(x)";
+declare const GLOB_JS = "**/*.?([cm])js";
+declare const GLOB_JSX = "**/*.?([cm])jsx";
+declare const GLOB_TS = "**/*.?([cm])ts";
+declare const GLOB_TSX = "**/*.?([cm])tsx";
+declare const GLOB_STYLE = "**/*.{c,le,sc}ss";
+declare const GLOB_CSS = "**/*.css";
+declare const GLOB_POSTCSS = "**/*.{p,post}css";
+declare const GLOB_LESS = "**/*.less";
+declare const GLOB_SCSS = "**/*.scss";
+declare const GLOB_JSON = "**/*.json";
+declare const GLOB_JSON5 = "**/*.json5";
+declare const GLOB_JSONC = "**/*.jsonc";
+declare const GLOB_MARKDOWN = "**/*.md";
+declare const GLOB_MARKDOWN_IN_MARKDOWN = "**/*.md/*.md";
+declare const GLOB_VUE = "**/*.vue";
+declare const GLOB_YAML = "**/*.y?(a)ml";
+declare const GLOB_TOML = "**/*.toml";
+declare const GLOB_XML = "**/*.xml";
+declare const GLOB_SVG = "**/*.svg";
+declare const GLOB_HTML = "**/*.htm?(l)";
+declare const GLOB_ASTRO = "**/*.astro";
+declare const GLOB_ASTRO_TS = "**/*.astro/*.ts";
+declare const GLOB_MARKDOWN_CODE = "**/*.md/**/*.?([cm])[jt]s?(x)";
+declare const GLOB_TESTS: string[];
+declare const GLOB_ALL_SRC: string[];
+declare const GLOB_EXCLUDE: string[];
+//#endregion
+//#region src/utils.d.ts
+declare const parserPlain: {
+  meta: {
+    name: string;
+  };
+  parseForESLint: (code: string) => {
+    ast: {
+      body: never[];
+      comments: never[];
+      loc: {
+        end: number;
+        start: number;
+      };
+      range: number[];
+      tokens: never[];
+      type: string;
+    };
+    scopeManager: null;
+    services: {
+      isPlain: boolean;
+    };
+    visitorKeys: {
+      Program: never[];
+    };
+  };
+};
+/**
+ * Combine array and non-array configs into a single array.
+ */
+declare function combine(...configs: Awaitable<TypedFlatConfigItem | TypedFlatConfigItem[]>[]): Promise<TypedFlatConfigItem[]>;
+declare function toArray<T>(value: T | T[]): T[];
+declare function interopDefault<T>(m: Awaitable<T>): Promise<T extends {
+  default: infer U;
+} ? U : T>;
+declare function isPackageInScope(name: string): boolean;
+declare function ensurePackages(packages: (string | undefined)[]): Promise<void>;
+declare function isInEditorEnv(): boolean;
+declare function isInGitHooksOrLintStaged(): boolean;
+//#endregion
+export { Awaitable, ConfigNames, GLOB_ALL_SRC, GLOB_ASTRO, GLOB_ASTRO_TS, GLOB_CSS, GLOB_EXCLUDE, GLOB_HTML, GLOB_JS, GLOB_JSON, GLOB_JSON5, GLOB_JSONC, GLOB_JSX, GLOB_LESS, GLOB_MARKDOWN, GLOB_MARKDOWN_CODE, GLOB_MARKDOWN_IN_MARKDOWN, GLOB_POSTCSS, GLOB_SCSS, GLOB_SRC, GLOB_SRC_EXT, GLOB_STYLE, GLOB_SVG, GLOB_TESTS, GLOB_TOML, GLOB_TS, GLOB_TSX, GLOB_VUE, GLOB_XML, GLOB_YAML, OptionsComponentExts, OptionsConfig, OptionsFiles, OptionsFormatters, OptionsHasTypeScript, OptionsIsInEditor, OptionsOverrides, OptionsRegExp, OptionsStylistic, OptionsTypeScriptParserOptions, OptionsTypeScriptWithTypes, OptionsTypescript, OptionsVue, ResolvedOptions, Rules, StylisticConfig, TypedFlatConfigItem, combine, eienjs as default, defaultPluginRenaming, eienjs, ensurePackages, getOverrides, interopDefault, isInEditorEnv, isInGitHooksOrLintStaged, isPackageInScope, parserPlain, resolveSubOptions, toArray };

package/dist/index.js

@@ -0,0 +1,125 @@
+import { GLOB_ALL_SRC, GLOB_ASTRO, GLOB_ASTRO_TS, GLOB_CSS, GLOB_EXCLUDE, GLOB_HTML, GLOB_JS, GLOB_JSON, GLOB_JSON5, GLOB_JSONC, GLOB_JSX, GLOB_LESS, GLOB_MARKDOWN, GLOB_MARKDOWN_CODE, GLOB_MARKDOWN_IN_MARKDOWN, GLOB_POSTCSS, GLOB_SCSS, GLOB_SRC, GLOB_SRC_EXT, GLOB_STYLE, GLOB_SVG, GLOB_TESTS, GLOB_TOML, GLOB_TS, GLOB_TSX, GLOB_VUE, GLOB_XML, GLOB_YAML, astro, combine, command, comments, disables, ensurePackages, formatters, ignores, imports, interopDefault, isInEditorEnv, isInGitHooksOrLintStaged, isPackageInScope, javascript, jsdoc, jsonc, markdown, node, parserPlain, perfectionist, pnpm, regexp, sortPackageJson, sortTsconfig, stylistic, test, toArray, toml, typescript, unicorn, vue, yaml } from "./configs-B_fhQhgr.js";
+import { FlatConfigComposer } from "eslint-flat-config-utils";
+import { isPackageExists } from "local-pkg";
+
+//#region src/factory.ts
+const flatConfigProps = [
+	"name",
+	"languageOptions",
+	"linterOptions",
+	"processor",
+	"plugins",
+	"rules",
+	"settings"
+];
+const VuePackages = [
+	"vue",
+	"nuxt",
+	"vitepress",
+	"@slidev/cli"
+];
+const defaultPluginRenaming = {
+	"import-lite": "import",
+	"vitest": "test",
+	"yml": "yaml"
+};
+function eienjs(options = {}) {
+	const { astro: enableAstro = false, componentExts = [], gitignore: enableGitignore = true, imports: enableImports = true, pnpm: enableCatalogs = false, regexp: enableRegexp = true, typescript: enableTypeScript = isPackageExists("typescript"), unicorn: enableUnicorn = true, vue: enableVue = VuePackages.some((i) => isPackageExists(i)) } = options;
+	let { isInEditor } = options;
+	if (isInEditor == null) {
+		isInEditor = isInEditorEnv();
+		if (isInEditor) console.info("[@eienjs/eslint-config] Detected running in editor, some rules are disabled.");
+	}
+	const stylisticOptions = options.stylistic === false ? false : typeof options.stylistic === "object" ? options.stylistic : {};
+	const configs = [];
+	if (enableGitignore) if (typeof enableGitignore === "boolean") configs.push(interopDefault(import("eslint-config-flat-gitignore")).then((r) => [r({
+		name: "eienjs/gitignore",
+		strict: false
+	})]));
+	else configs.push(interopDefault(import("eslint-config-flat-gitignore")).then((r) => [r({
+		name: "eienjs/gitignore",
+		...enableGitignore
+	})]));
+	const typescriptOptions = resolveSubOptions(options, "typescript");
+	configs.push(ignores(options.ignores), javascript({
+		isInEditor,
+		overrides: getOverrides(options, "javascript")
+	}), comments(), node(), jsdoc({ stylistic: stylisticOptions }), imports({ stylistic: stylisticOptions }), command(), perfectionist());
+	if (enableImports) configs.push(imports(enableImports === true ? { stylistic: stylisticOptions } : {
+		stylistic: stylisticOptions,
+		...enableImports
+	}));
+	if (enableUnicorn) configs.push(unicorn(enableUnicorn === true ? {} : enableUnicorn));
+	if (enableVue) componentExts.push("vue");
+	if (enableTypeScript) configs.push(typescript({
+		...typescriptOptions,
+		componentExts,
+		overrides: getOverrides(options, "typescript")
+	}));
+	if (stylisticOptions) configs.push(stylistic({
+		...stylisticOptions,
+		overrides: getOverrides(options, "stylistic")
+	}));
+	if (enableRegexp) configs.push(regexp(typeof enableRegexp === "boolean" ? {} : enableRegexp));
+	if (options.test ?? true) configs.push(test({
+		isInEditor,
+		overrides: getOverrides(options, "test")
+	}));
+	if (enableVue) configs.push(vue({
+		...resolveSubOptions(options, "vue"),
+		overrides: getOverrides(options, "vue"),
+		stylistic: stylisticOptions,
+		typescript: Boolean(enableTypeScript)
+	}));
+	if (enableAstro) configs.push(astro({
+		overrides: getOverrides(options, "astro"),
+		stylistic: stylisticOptions
+	}));
+	if (options.jsonc ?? true) configs.push(jsonc({
+		overrides: getOverrides(options, "jsonc"),
+		stylistic: stylisticOptions
+	}), sortPackageJson(), sortTsconfig());
+	if (enableCatalogs) configs.push(pnpm());
+	if (options.yaml ?? true) configs.push(yaml({
+		overrides: getOverrides(options, "yaml"),
+		stylistic: stylisticOptions
+	}));
+	if (options.toml ?? true) configs.push(toml({
+		overrides: getOverrides(options, "toml"),
+		stylistic: stylisticOptions
+	}));
+	if (options.markdown ?? true) configs.push(markdown({
+		componentExts,
+		overrides: getOverrides(options, "markdown")
+	}));
+	if (options.formatters) configs.push(formatters(options.formatters, typeof stylisticOptions === "boolean" ? {} : stylisticOptions));
+	configs.push(disables());
+	if ("files" in options) throw new Error("[@eienjs/eslint-config] The first argument should not contain the \"files\" property as the options are supposed to be global. Place it in the second or later config instead.");
+	const fusedConfig = flatConfigProps.reduce((acc, key) => {
+		if (key in options) acc[key] = options[key];
+		return acc;
+	}, {});
+	if (Object.keys(fusedConfig).length > 0) configs.push([fusedConfig]);
+	let composer = new FlatConfigComposer();
+	composer = composer.append(...configs).renamePlugins(defaultPluginRenaming);
+	if (isInEditor) composer = composer.disableRulesFix([
+		"unused-imports/no-unused-imports",
+		"test/no-only-tests",
+		"prefer-const"
+	], { builtinRules: () => import(["eslint", "use-at-your-own-risk"].join("/")).then((r) => r.builtinRules) });
+	return composer;
+}
+function resolveSubOptions(options, key) {
+	return typeof options[key] === "boolean" ? {} : options[key] || {};
+}
+function getOverrides(options, key) {
+	const sub = resolveSubOptions(options, key);
+	return { ..."overrides" in sub ? sub.overrides : {} };
+}
+
+//#endregion
+//#region src/index.ts
+var src_default = eienjs;
+
+//#endregion
+export { GLOB_ALL_SRC, GLOB_ASTRO, GLOB_ASTRO_TS, GLOB_CSS, GLOB_EXCLUDE, GLOB_HTML, GLOB_JS, GLOB_JSON, GLOB_JSON5, GLOB_JSONC, GLOB_JSX, GLOB_LESS, GLOB_MARKDOWN, GLOB_MARKDOWN_CODE, GLOB_MARKDOWN_IN_MARKDOWN, GLOB_POSTCSS, GLOB_SCSS, GLOB_SRC, GLOB_SRC_EXT, GLOB_STYLE, GLOB_SVG, GLOB_TESTS, GLOB_TOML, GLOB_TS, GLOB_TSX, GLOB_VUE, GLOB_XML, GLOB_YAML, combine, src_default as default, defaultPluginRenaming, eienjs, ensurePackages, getOverrides, interopDefault, isInEditorEnv, isInGitHooksOrLintStaged, isPackageInScope, parserPlain, resolveSubOptions, toArray };