@eienjs/eslint-config 1.2.2 → 1.3.0

package/dist/cli/constants.js

@@ -0,0 +1,74 @@
+import c from "ansis";
+
+//#region src/cli/constants.ts
+const vscodeSettingsString = `
+  // Disable the default formatter, use eslint instead
+  "prettier.enable": false,
+  "editor.formatOnSave": false,
+  "eslint.format.enable": true,
+  "editor.defaultFormatter": "dbaeumer.vscode-eslint",
+
+  // Auto fix
+  "editor.codeActionsOnSave": {
+    "source.organizeImports": "never"
+  },
+
+  "eslint.runtime": "node",
+
+  // Enable eslint for all supported languages
+  "eslint.validate": [
+    "javascript",
+    "typescript",
+    "vue",
+    "html",
+    "markdown",
+    "json",
+    "json5",
+    "jsonc",
+    "yaml",
+    "toml",
+    "xml",
+    "astro",
+    "css",
+    "less",
+    "scss",
+    "pcss",
+    "postcss"
+  ],
+`;
+const frameworkOptions = [
+	{
+		label: c.green("Vue"),
+		value: "vue"
+	},
+	{
+		label: c.magenta("Astro"),
+		value: "astro"
+	},
+	{
+		label: c.blueBright("AdonisJS"),
+		value: "adonisjs"
+	},
+	{
+		label: c.greenBright("Nuxt"),
+		value: "nuxt"
+	}
+];
+const frameworks = frameworkOptions.map(({ value }) => value);
+const extraOptions = [{
+	hint: "Use external formatters (Prettier) to format files that ESLint cannot handle yet (.css, .html, etc)",
+	label: c.red("Formatter"),
+	value: "formatter"
+}];
+const extra = extraOptions.map(({ value }) => value);
+const dependenciesMap = {
+	astro: ["eslint-plugin-astro", "astro-eslint-parser"],
+	formatter: ["eslint-plugin-format"],
+	formatterAstro: ["prettier-plugin-astro"],
+	vue: [],
+	adonisjs: ["@adonisjs/eslint-plugin"],
+	nuxt: ["@nuxt/eslint-plugin"]
+};
+
+//#endregion
+export { dependenciesMap, extra, extraOptions, frameworkOptions, frameworks, vscodeSettingsString };

package/dist/cli/constants_generated.js

@@ -0,0 +1,13 @@
+//#region src/cli/constants_generated.ts
+const versionsMap = {
+	"@adonisjs/eslint-plugin": "^2.0.1",
+	"@nuxt/eslint-plugin": "^1.9.0",
+	"astro-eslint-parser": "^1.2.2",
+	"eslint": "^9.36.0",
+	"eslint-plugin-astro": "^1.3.1",
+	"eslint-plugin-format": "^1.0.2",
+	"prettier-plugin-astro": "^0.14.1"
+};
+
+//#endregion
+export { versionsMap };

package/dist/cli/index.d.ts

@@ -1 +1 @@
-export {};
+export { };

package/dist/cli/index.js

@@ -1,275 +1,10 @@
+import { version } from "../package.js";
+import { run } from "./run.js";
 import process from "node:process";
 import * as p from "@clack/prompts";
-import c, { green } from "ansis";
+import c from "ansis";
 import { cac } from "cac";
-import fs from "node:fs";
-import path from "node:path";
-import fsp from "node:fs/promises";
-import parse from "parse-gitignore";
-import { execSync } from "node:child_process";
 
-//#region package.json
-var version = "1.2.2";
-
-//#endregion
-//#region src/cli/constants.ts
-const vscodeSettingsString = `
-  // Disable the default formatter, use eslint instead
-  "prettier.enable": false,
-  "editor.formatOnSave": false,
-  "eslint.format.enable": true,
-  "editor.defaultFormatter": "dbaeumer.vscode-eslint",
-
-  // Auto fix
-  "editor.codeActionsOnSave": {
-    "source.organizeImports": "never"
-  },
-
-  "eslint.runtime": "node",
-
-  // Enable eslint for all supported languages
-  "eslint.validate": [
-    "javascript",
-    "typescript",
-    "vue",
-    "html",
-    "markdown",
-    "json",
-    "json5",
-    "jsonc",
-    "yaml",
-    "toml",
-    "xml",
-    "astro",
-    "css",
-    "less",
-    "scss",
-    "pcss",
-    "postcss"
-  ],
-`;
-const frameworkOptions = [
-	{
-		label: c.green("Vue"),
-		value: "vue"
-	},
-	{
-		label: c.magenta("Astro"),
-		value: "astro"
-	},
-	{
-		label: c.blueBright("AdonisJS"),
-		value: "adonisjs"
-	},
-	{
-		label: c.greenBright("Nuxt"),
-		value: "nuxt"
-	}
-];
-const frameworks = frameworkOptions.map(({ value }) => value);
-const extraOptions = [{
-	hint: "Use external formatters (Prettier) to format files that ESLint cannot handle yet (.css, .html, etc)",
-	label: c.red("Formatter"),
-	value: "formatter"
-}];
-const extra = extraOptions.map(({ value }) => value);
-const dependenciesMap = {
-	astro: ["eslint-plugin-astro", "astro-eslint-parser"],
-	formatter: ["eslint-plugin-format"],
-	formatterAstro: ["prettier-plugin-astro"],
-	vue: [],
-	adonisjs: ["@adonisjs/eslint-plugin"],
-	nuxt: ["@nuxt/eslint-plugin"]
-};
-
-//#endregion
-//#region src/cli/utils.ts
-function isGitClean() {
-	try {
-		execSync("git diff-index --quiet HEAD --");
-		return true;
-	} catch {
-		return false;
-	}
-}
-function getEslintConfigContent(mainConfig) {
-	return `
-import eienjs from '@eienjs/eslint-config';
-
-export default eienjs({
-${mainConfig}
-});
-`.trimStart();
-}
-
-//#endregion
-//#region src/cli/stages/update_eslint_files.ts
-async function updateEslintFiles(result) {
-	const cwd = process.cwd();
-	const pathESLintIgnore = path.join(cwd, ".eslintignore");
-	const pathPackageJSON = path.join(cwd, "package.json");
-	const pkgContent = await fsp.readFile(pathPackageJSON, "utf8");
-	const pkg = JSON.parse(pkgContent);
-	const configFileName = pkg.type === "module" ? "eslint.config.js" : "eslint.config.mjs";
-	const pathFlatConfig = path.join(cwd, configFileName);
-	const eslintIgnores = [];
-	if (fs.existsSync(pathESLintIgnore)) {
-		p.log.step(c.cyan`Migrating existing .eslintignore`);
-		const content = await fsp.readFile(pathESLintIgnore, "utf8");
-		const parsed = parse(content);
-		const globs = parsed.globs();
-		for (const glob of globs) if (glob.type === "ignore") eslintIgnores.push(...glob.patterns);
-		else if (glob.type === "unignore") eslintIgnores.push(...glob.patterns.map((pattern) => `!${pattern}`));
-	}
-	const configLines = [];
-	if (eslintIgnores.length > 0) configLines.push(`ignores: ${JSON.stringify(eslintIgnores)},`);
-	if (result.extra.includes("formatter")) configLines.push("formatters: true,");
-	for (const framework of result.frameworks) configLines.push(`${framework}: true,`);
-	const mainConfig = configLines.map((i) => `  ${i}`).join("\n");
-	const eslintConfigContent = getEslintConfigContent(mainConfig);
-	await fsp.writeFile(pathFlatConfig, eslintConfigContent);
-	p.log.success(c.green`Created ${configFileName}`);
-	const files = fs.readdirSync(cwd);
-	const legacyConfig = [];
-	for (const file of files) if (/eslint|prettier/.test(file) && !file.includes("eslint.config.")) legacyConfig.push(file);
-	if (legacyConfig.length > 0) p.note(c.dim(legacyConfig.join(", ")), "You can now remove those files manually");
-}
-
-//#endregion
-//#region src/cli/constants_generated.ts
-const versionsMap = {
-	"@adonisjs/eslint-plugin": "^2.0.1",
-	"@nuxt/eslint-plugin": "^1.8.0",
-	"astro-eslint-parser": "^1.2.2",
-	"eslint": "^9.32.0",
-	"eslint-plugin-astro": "^1.3.1",
-	"eslint-plugin-format": "^1.0.1",
-	"prettier-plugin-astro": "^0.14.1"
-};
-
-//#endregion
-//#region src/cli/stages/update_package_json.ts
-async function updatePackageJson(result) {
-	const cwd = process.cwd();
-	const pathPackageJSON = path.join(cwd, "package.json");
-	p.log.step(c.cyan`Bumping @eienjs/eslint-config to v${version}`);
-	const pkgContent = await fsp.readFile(pathPackageJSON, "utf8");
-	const pkg = JSON.parse(pkgContent);
-	pkg.devDependencies = pkg.devDependencies ?? {};
-	pkg.devDependencies["@eienjs/eslint-config"] = `^${version}`;
-	pkg.devDependencies.eslint = pkg.devDependencies.eslint ?? versionsMap.eslint;
-	const addedPackages = [];
-	if (result.extra.length > 0) {
-		const extraPackages = result.extra;
-		for (const item of extraPackages) switch (item) {
-			case "formatter":
-				for (const f of [...dependenciesMap.formatter, ...result.frameworks.includes("astro") ? dependenciesMap.formatterAstro : []]) {
-					if (!f) continue;
-					pkg.devDependencies[f] = versionsMap[f];
-					addedPackages.push(f);
-				}
-				break;
-		}
-	}
-	for (const framework of result.frameworks) {
-		const deps = dependenciesMap[framework];
-		if (deps.length > 0) for (const f of deps) {
-			pkg.devDependencies[f] = versionsMap[f];
-			addedPackages.push(f);
-		}
-	}
-	if (addedPackages.length > 0) p.note(c.dim(addedPackages.join(", ")), "Added packages");
-	await fsp.writeFile(pathPackageJSON, JSON.stringify(pkg, null, 2));
-	p.log.success(c.green`Changes wrote to package.json`);
-}
-
-//#endregion
-//#region src/cli/stages/update_vscode_settings.ts
-async function updateVscodeSettings(result) {
-	const cwd = process.cwd();
-	if (!result.updateVscodeSettings) return;
-	const dotVscodePath = path.join(cwd, ".vscode");
-	const settingsPath = path.join(dotVscodePath, "settings.json");
-	if (!fs.existsSync(dotVscodePath)) await fsp.mkdir(dotVscodePath, { recursive: true });
-	if (fs.existsSync(settingsPath)) {
-		let settingsContent = await fsp.readFile(settingsPath, "utf8");
-		settingsContent = settingsContent.trim().replace(/\s*\}$/, "");
-		settingsContent += settingsContent.endsWith(",") || settingsContent.endsWith("{") ? "" : ",";
-		settingsContent += `${vscodeSettingsString}}\n`;
-		await fsp.writeFile(settingsPath, settingsContent, "utf8");
-		p.log.success(green`Updated .vscode/settings.json`);
-	} else {
-		await fsp.writeFile(settingsPath, `{${vscodeSettingsString}}\n`, "utf8");
-		p.log.success(green`Created .vscode/settings.json`);
-	}
-}
-
-//#endregion
-//#region src/cli/run.ts
-async function run(options = {}) {
-	const argSkipPrompt = Boolean(process.env.SKIP_PROMPT) || options.yes;
-	const argTemplate = options.frameworks?.map((m) => m.trim()).filter(Boolean);
-	const argExtra = options.extra?.map((m) => m.trim()).filter(Boolean);
-	if (fs.existsSync(path.join(process.cwd(), "eslint.config.js"))) {
-		p.log.warn(c.yellow`eslint.config.js already exists, migration wizard exited.`);
-		return process.exit(1);
-	}
-	let result = {
-		extra: argExtra ?? [],
-		frameworks: argTemplate ?? [],
-		uncommittedConfirmed: false,
-		updateVscodeSettings: true
-	};
-	if (!argSkipPrompt) {
-		result = await p.group({
-			uncommittedConfirmed: async () => {
-				if (isGitClean()) return true;
-				return p.confirm({
-					initialValue: false,
-					message: "There are uncommitted changes in the current repository, are you sure to continue?"
-				});
-			},
-			frameworks: async ({ results }) => {
-				const isArgTemplateValid = typeof argTemplate === "string" && frameworks.includes(argTemplate);
-				if (!results.uncommittedConfirmed || isArgTemplateValid) return;
-				const message = argTemplate ? `"${argTemplate.toString()}" isn't a valid template. Please choose from below: ` : "Select a framework:";
-				return p.multiselect({
-					message: c.reset(message),
-					options: frameworkOptions,
-					required: false
-				});
-			},
-			extra: async ({ results }) => {
-				const isArgExtraValid = argExtra?.length && argExtra.filter((element) => !extra.includes(element)).length === 0;
-				if (!results.uncommittedConfirmed || isArgExtraValid) return;
-				const message = argExtra ? `"${argExtra.toString()}" isn't a valid extra util. Please choose from below: ` : "Select a extra utils:";
-				return p.multiselect({
-					message: c.reset(message),
-					options: extraOptions,
-					required: false
-				});
-			},
-			updateVscodeSettings: async ({ results }) => {
-				if (!results.uncommittedConfirmed) return;
-				return p.confirm({
-					initialValue: true,
-					message: "Update .vscode/settings.json for better VS Code experience?"
-				});
-			}
-		}, { onCancel: () => {
-			p.cancel("Operation cancelled.");
-			process.exit(0);
-		} });
-		if (!result.uncommittedConfirmed) return process.exit(1);
-	}
-	await updatePackageJson(result);
-	await updateEslintFiles(result);
-	await updateVscodeSettings(result);
-	p.log.success(c.green`Setup completed`);
-	p.outro(`Now you can update the dependencies by run ${c.blue("pnpm install")} and run ${c.blue("eslint --fix")}\n`);
-}
-
-//#endregion
 //#region src/cli/index.ts
 function header() {
 	console.log("\n");

package/dist/cli/run.js

@@ -0,0 +1,77 @@
+import { extra, extraOptions, frameworkOptions, frameworks } from "./constants.js";
+import { isGitClean } from "./utils.js";
+import { updateEslintFiles } from "./stages/update_eslint_files.js";
+import { updatePackageJson } from "./stages/update_package_json.js";
+import { updateVscodeSettings } from "./stages/update_vscode_settings.js";
+import process from "node:process";
+import * as p from "@clack/prompts";
+import c from "ansis";
+import fs from "node:fs";
+import path from "node:path";
+
+//#region src/cli/run.ts
+async function run(options = {}) {
+	const argSkipPrompt = Boolean(process.env.SKIP_PROMPT) || options.yes;
+	const argTemplate = options.frameworks?.map((m) => m.trim()).filter(Boolean);
+	const argExtra = options.extra?.map((m) => m.trim()).filter(Boolean);
+	if (fs.existsSync(path.join(process.cwd(), "eslint.config.js"))) {
+		p.log.warn(c.yellow`eslint.config.js already exists, migration wizard exited.`);
+		return process.exit(1);
+	}
+	let result = {
+		extra: argExtra ?? [],
+		frameworks: argTemplate ?? [],
+		uncommittedConfirmed: false,
+		updateVscodeSettings: true
+	};
+	if (!argSkipPrompt) {
+		result = await p.group({
+			uncommittedConfirmed: async () => {
+				if (isGitClean()) return true;
+				return p.confirm({
+					initialValue: false,
+					message: "There are uncommitted changes in the current repository, are you sure to continue?"
+				});
+			},
+			frameworks: async ({ results }) => {
+				const isArgTemplateValid = typeof argTemplate === "string" && frameworks.includes(argTemplate);
+				if (!results.uncommittedConfirmed || isArgTemplateValid) return;
+				const message = argTemplate ? `"${argTemplate.toString()}" isn't a valid template. Please choose from below: ` : "Select a framework:";
+				return p.multiselect({
+					message: c.reset(message),
+					options: frameworkOptions,
+					required: false
+				});
+			},
+			extra: async ({ results }) => {
+				const isArgExtraValid = argExtra?.length && argExtra.filter((element) => !extra.includes(element)).length === 0;
+				if (!results.uncommittedConfirmed || isArgExtraValid) return;
+				const message = argExtra ? `"${argExtra.toString()}" isn't a valid extra util. Please choose from below: ` : "Select a extra utils:";
+				return p.multiselect({
+					message: c.reset(message),
+					options: extraOptions,
+					required: false
+				});
+			},
+			updateVscodeSettings: async ({ results }) => {
+				if (!results.uncommittedConfirmed) return;
+				return p.confirm({
+					initialValue: true,
+					message: "Update .vscode/settings.json for better VS Code experience?"
+				});
+			}
+		}, { onCancel: () => {
+			p.cancel("Operation cancelled.");
+			process.exit(0);
+		} });
+		if (!result.uncommittedConfirmed) return process.exit(1);
+	}
+	await updatePackageJson(result);
+	await updateEslintFiles(result);
+	await updateVscodeSettings(result);
+	p.log.success(c.green`Setup completed`);
+	p.outro(`Now you can update the dependencies by run ${c.blue("pnpm install")} and run ${c.blue("eslint --fix")}\n`);
+}
+
+//#endregion
+export { run };

package/dist/cli/stages/update_eslint_files.js

@@ -0,0 +1,41 @@
+import { getEslintConfigContent } from "../utils.js";
+import process from "node:process";
+import * as p from "@clack/prompts";
+import c from "ansis";
+import fs from "node:fs";
+import path from "node:path";
+import fsp from "node:fs/promises";
+import parse from "parse-gitignore";
+
+//#region src/cli/stages/update_eslint_files.ts
+async function updateEslintFiles(result) {
+	const cwd = process.cwd();
+	const pathESLintIgnore = path.join(cwd, ".eslintignore");
+	const pathPackageJSON = path.join(cwd, "package.json");
+	const pkgContent = await fsp.readFile(pathPackageJSON, "utf8");
+	const configFileName = JSON.parse(pkgContent).type === "module" ? "eslint.config.js" : "eslint.config.mjs";
+	const pathFlatConfig = path.join(cwd, configFileName);
+	const eslintIgnores = [];
+	if (fs.existsSync(pathESLintIgnore)) {
+		p.log.step(c.cyan`Migrating existing .eslintignore`);
+		const content = await fsp.readFile(pathESLintIgnore, "utf8");
+		const globs = parse(content).globs();
+		for (const glob of globs) if (glob.type === "ignore") eslintIgnores.push(...glob.patterns);
+		else if (glob.type === "unignore") eslintIgnores.push(...glob.patterns.map((pattern) => `!${pattern}`));
+	}
+	const configLines = [];
+	if (eslintIgnores.length > 0) configLines.push(`ignores: ${JSON.stringify(eslintIgnores)},`);
+	if (result.extra.includes("formatter")) configLines.push("formatters: true,");
+	for (const framework of result.frameworks) configLines.push(`${framework}: true,`);
+	const mainConfig = configLines.map((i) => `  ${i}`).join("\n");
+	const eslintConfigContent = getEslintConfigContent(mainConfig);
+	await fsp.writeFile(pathFlatConfig, eslintConfigContent);
+	p.log.success(c.green`Created ${configFileName}`);
+	const files = fs.readdirSync(cwd);
+	const legacyConfig = [];
+	for (const file of files) if (/eslint|prettier/.test(file) && !file.includes("eslint.config.")) legacyConfig.push(file);
+	if (legacyConfig.length > 0) p.note(c.dim(legacyConfig.join(", ")), "You can now remove those files manually");
+}
+
+//#endregion
+export { updateEslintFiles };

package/dist/cli/stages/update_package_json.js

@@ -0,0 +1,46 @@
+import { version } from "../../package.js";
+import { dependenciesMap } from "../constants.js";
+import { versionsMap } from "../constants_generated.js";
+import process from "node:process";
+import * as p from "@clack/prompts";
+import c from "ansis";
+import path from "node:path";
+import fsp from "node:fs/promises";
+
+//#region src/cli/stages/update_package_json.ts
+async function updatePackageJson(result) {
+	const cwd = process.cwd();
+	const pathPackageJSON = path.join(cwd, "package.json");
+	p.log.step(c.cyan`Bumping @eienjs/eslint-config to v${version}`);
+	const pkgContent = await fsp.readFile(pathPackageJSON, "utf8");
+	const pkg = JSON.parse(pkgContent);
+	pkg.devDependencies = pkg.devDependencies ?? {};
+	pkg.devDependencies["@eienjs/eslint-config"] = `^${version}`;
+	pkg.devDependencies.eslint = pkg.devDependencies.eslint ?? versionsMap.eslint;
+	const addedPackages = [];
+	if (result.extra.length > 0) {
+		const extraPackages = result.extra;
+		for (const item of extraPackages) switch (item) {
+			case "formatter":
+				for (const f of [...dependenciesMap.formatter, ...result.frameworks.includes("astro") ? dependenciesMap.formatterAstro : []]) {
+					if (!f) continue;
+					pkg.devDependencies[f] = versionsMap[f];
+					addedPackages.push(f);
+				}
+				break;
+		}
+	}
+	for (const framework of result.frameworks) {
+		const deps = dependenciesMap[framework];
+		if (deps.length > 0) for (const f of deps) {
+			pkg.devDependencies[f] = versionsMap[f];
+			addedPackages.push(f);
+		}
+	}
+	if (addedPackages.length > 0) p.note(c.dim(addedPackages.join(", ")), "Added packages");
+	await fsp.writeFile(pathPackageJSON, JSON.stringify(pkg, null, 2));
+	p.log.success(c.green`Changes wrote to package.json`);
+}
+
+//#endregion
+export { updatePackageJson };

package/dist/cli/stages/update_vscode_settings.js

@@ -0,0 +1,30 @@
+import { vscodeSettingsString } from "../constants.js";
+import process from "node:process";
+import * as p from "@clack/prompts";
+import { green } from "ansis";
+import fs from "node:fs";
+import path from "node:path";
+import fsp from "node:fs/promises";
+
+//#region src/cli/stages/update_vscode_settings.ts
+async function updateVscodeSettings(result) {
+	const cwd = process.cwd();
+	if (!result.updateVscodeSettings) return;
+	const dotVscodePath = path.join(cwd, ".vscode");
+	const settingsPath = path.join(dotVscodePath, "settings.json");
+	if (!fs.existsSync(dotVscodePath)) await fsp.mkdir(dotVscodePath, { recursive: true });
+	if (fs.existsSync(settingsPath)) {
+		let settingsContent = await fsp.readFile(settingsPath, "utf8");
+		settingsContent = settingsContent.trim().replace(/\s*\}$/, "");
+		settingsContent += settingsContent.endsWith(",") || settingsContent.endsWith("{") ? "" : ",";
+		settingsContent += `${vscodeSettingsString}}\n`;
+		await fsp.writeFile(settingsPath, settingsContent, "utf8");
+		p.log.success(green`Updated .vscode/settings.json`);
+	} else {
+		await fsp.writeFile(settingsPath, `{${vscodeSettingsString}}\n`, "utf8");
+		p.log.success(green`Created .vscode/settings.json`);
+	}
+}
+
+//#endregion
+export { updateVscodeSettings };

package/dist/cli/utils.js

@@ -0,0 +1,23 @@
+import { execSync } from "node:child_process";
+
+//#region src/cli/utils.ts
+function isGitClean() {
+	try {
+		execSync("git diff-index --quiet HEAD --");
+		return true;
+	} catch {
+		return false;
+	}
+}
+function getEslintConfigContent(mainConfig) {
+	return `
+import eienjs from '@eienjs/eslint-config';
+
+export default eienjs({
+${mainConfig}
+});
+`.trimStart();
+}
+
+//#endregion
+export { getEslintConfigContent, isGitClean };

package/dist/configs/adonisjs.d.ts

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