@dhzh/eslint-config 1.26.0 → 1.27.1

package/dist/cli/index.mjs

@@ -0,0 +1,269 @@
+import process from "node:process";
+import * as p from "@clack/prompts";
+import c, { green } from "ansis";
+import { cac } from "cac";
+import fsp from "node:fs/promises";
+import path from "node:path";
+import fs from "node:fs";
+//#region package.json
+var version = "1.27.1";
+var devDependencies = {
+	"@eslint/config-inspector": "^2.0.0",
+	"@prettier/plugin-xml": "^3.4.2",
+	"@types/eslint-plugin-tailwindcss": "^3.17.0",
+	"@types/node": "^24.12.2",
+	"@typescript-eslint/types": "^8.59.0",
+	"bumpp": "^11.0.1",
+	"bundle-require": "^5.1.0",
+	"eslint": "^10.2.1",
+	"eslint-typegen": "^2.3.1",
+	"lint-staged": "^16.4.0",
+	"simple-git-hooks": "^2.13.1",
+	"tailwindcss": "^4.2.4",
+	"tsdown": "^0.21.10",
+	"tsx": "^4.21.0",
+	"typescript": "^6.0.3"
+};
+//#endregion
+//#region src/cli/stages/update-package-json.ts
+async function ensureScript(scripts, name, command) {
+	if (scripts[name] == null) {
+		scripts[name] = command;
+		return;
+	}
+	if (scripts[name] === command) return;
+	const shouldOverride = await p.confirm({
+		message: `Script "${name}" already exists as "${String(scripts[name])}". Replace it with "${command}"?`,
+		initialValue: true
+	});
+	if (p.isCancel(shouldOverride)) {
+		p.cancel("Operation cancelled");
+		throw new Error("Operation cancelled");
+	}
+	if (shouldOverride) scripts[name] = command;
+}
+async function updatePackageJson() {
+	const cwd = process.cwd();
+	const pathPackageJSON = path.join(cwd, "package.json");
+	p.log.step(c.cyan`Bumping @dhzh/eslint-config to v${version}`);
+	const pkgContent = await fsp.readFile(pathPackageJSON, "utf8");
+	const pkg = JSON.parse(pkgContent);
+	pkg.devDependencies ??= {};
+	pkg.devDependencies["@dhzh/eslint-config"] = `^${version}`;
+	pkg.devDependencies.eslint ??= devDependencies.eslint;
+	pkg.scripts ??= {};
+	await ensureScript(pkg.scripts, "lint", "eslint");
+	await ensureScript(pkg.scripts, "lint-fix", "eslint --fix .");
+	await fsp.writeFile(pathPackageJSON, JSON.stringify(pkg, null, 2));
+	p.log.success(c.green`Changes wrote to package.json`);
+}
+//#endregion
+//#region src/cli/constants.ts
+const vscodeSettingsString = `
+  // Entry
+  "eslint.format.enable": true,
+  "eslint.ignoreUntitled": true,
+  "eslint.enable": true,
+
+  // Disable the default formatter, use eslint instead
+  "prettier.enable": false,
+
+  // Auto fix
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": "explicit",
+    "source.organizeImports": "never"
+  },
+
+  // Silent the stylistic rules in you IDE, but still auto fix them
+  // "eslint.rules.customizations": [
+  //   { "rule": "style/*", "severity": "off", "fixable": true },
+  //   { "rule": "format/*", "severity": "off", "fixable": true },
+  //   { "rule": "*-indent", "severity": "off", "fixable": true },
+  //   { "rule": "*-spacing", "severity": "off", "fixable": true },
+  //   { "rule": "*-spaces", "severity": "off", "fixable": true },
+  //   { "rule": "*-order", "severity": "off", "fixable": true },
+  //   { "rule": "*-dangle", "severity": "off", "fixable": true },
+  //   { "rule": "*-newline", "severity": "off", "fixable": true },
+  //   { "rule": "*quotes", "severity": "off", "fixable": true },
+  //   { "rule": "*semi", "severity": "off", "fixable": true }
+  // ],
+
+  // Enable eslint for all supported languages
+  "eslint.validate": [
+    "javascript",
+    "javascriptreact",
+    "typescript",
+    "typescriptreact",
+    "html",
+    "json",
+    "json5",
+    "jsonc",
+    "yaml",
+    "toml",
+    "xml",
+    "css",
+    "less",
+    "scss",
+    "pcss",
+    "postcss",
+    "gql",
+    "graphql",
+    "vue"
+  ],
+
+  // Enable eslint as the default formatter
+  "[javascript]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  },
+  "[javascriptreact]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  },
+  "[typescript]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  },
+  "[typescriptreact]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  },
+  "[html]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  },
+  "[json]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  },
+  "[jsonc]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  },
+  "[yaml]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  },
+  "[toml]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  },
+  "[xml]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  },
+  "[css]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  },
+  "[less]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  },
+  "[scss]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  },
+  "[pcss]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  },
+  "[postcss]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  },
+  "[gql]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  },
+  "[graphql]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  },
+  "[vue]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  }
+`;
+const eslintConfigContent = (options) => `import { defineConfig } from '@dhzh/eslint-config';
+
+export default defineConfig(${options.hasNest ? `{
+  configs: {
+    json: {
+      packageJsonRequireType: false,
+    },
+  },
+}` : ""});
+`;
+const npmignoreString = `# If these files (ESLint flat config files) are not included in .npmignore,
+# they will be published, and importing devDependencies in published files will trigger \`n/no-unpublished-import\` errors.
+eslint.config.js
+eslint.config.mjs
+`;
+//#endregion
+//#region src/cli/stages/update-eslint-config.ts
+async function updateEslintConfig(options) {
+	const cwd = process.cwd();
+	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);
+	await fsp.writeFile(pathFlatConfig, eslintConfigContent(options));
+	p.log.success(c.green`Created ${configFileName}`);
+}
+//#endregion
+//#region src/cli/stages/update-npmignore.ts
+async function updateNpmignore() {
+	const cwd = process.cwd();
+	const npmignoreFileName = ".npmignore";
+	const npmignoreFilePath = path.join(cwd, npmignoreFileName);
+	let action = "Created";
+	try {
+		await fsp.access(npmignoreFilePath);
+		const trimmedContent = (await fsp.readFile(npmignoreFilePath, "utf8")).trimEnd();
+		await fsp.writeFile(npmignoreFilePath, `${trimmedContent}\n${npmignoreString}`);
+		action = "Updated";
+	} catch {
+		await fsp.writeFile(npmignoreFilePath, npmignoreString);
+	}
+	p.log.success(c.green`${action} ${npmignoreFileName}`);
+}
+//#endregion
+//#region src/cli/stages/update-vscode-settings.ts
+async function updateVscodeSettings() {
+	const cwd = process.cwd();
+	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) {
+	await updatePackageJson();
+	await updateEslintConfig(options);
+	await updateNpmignore();
+	await updateVscodeSettings();
+	p.log.success(c.green`Setup completed`);
+	p.outro(`Now you can update the dependencies by run ${c.blue("pnpm i")} and run ${c.blue("eslint --fix")}\n`);
+}
+//#endregion
+//#region src/cli/index.ts
+const cli = cac("@dhzh/eslint-config");
+cli.command("", "Run the initialization or migration").action(async () => {
+	console.log("\n");
+	p.intro(`${c.green`@dhzh/eslint-config `}${c.dim`v${version}`}`);
+	const options = { hasNest: false };
+	const hasNest = await p.confirm({
+		message: "Is NestJS a part of the current project?",
+		initialValue: false
+	});
+	if (p.isCancel(hasNest)) {
+		p.cancel("Operation cancelled");
+		throw new Error("Operation cancelled");
+	} else options.hasNest = hasNest;
+	try {
+		await run(options);
+	} catch (error) {
+		p.log.error(c.inverse.red(" Failed to migrate "));
+		p.log.error(c.red`✘ ${String(error)}`);
+		throw error;
+	}
+});
+cli.help();
+cli.version(version);
+cli.parse();
+//#endregion
+export {};