@dhzh/eslint-config 1.27.0 → 2.0.0

package/README.md

@@ -29,6 +29,7 @@ I use ESLint to format and lint my code:
 ## Usage
 
 > Requires ESLint v9.5.0+
+> This package is ESM-only.
 
 ### Starter Wizard
 

package/bin/index.js

@@ -1,2 +1,2 @@
 #!/usr/bin/env node
-import '../dist/cli/index.js';
+import '../dist/cli/index.mjs';

package/dist/cli/index.mjs

@@ -6,7 +6,7 @@ import fsp from "node:fs/promises";
 import path from "node:path";
 import fs from "node:fs";
 //#region package.json
-var version = "1.27.0";
+var version = "2.0.0";
 var devDependencies = {
 	"@eslint/config-inspector": "^2.0.0",
 	"@prettier/plugin-xml": "^3.4.2",
@@ -26,6 +26,22 @@ var devDependencies = {
 };
 //#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");
@@ -36,8 +52,8 @@ async function updatePackageJson() {
 	pkg.devDependencies["@dhzh/eslint-config"] = `^${version}`;
 	pkg.devDependencies.eslint ??= devDependencies.eslint;
 	pkg.scripts ??= {};
-	pkg.scripts.lint = "eslint .";
-	pkg.scripts["lint-fix"] = "eslint --fix .";
+	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`);
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@dhzh/eslint-config",
   "type": "module",
-  "version": "1.27.0",
+  "version": "2.0.0",
   "description": "tinywaves's ESLint config",
   "author": {
     "name": "Lyle Zheng",
@@ -23,12 +23,13 @@
   "sideEffects": false,
   "exports": {
     ".": {
-      "import": "./dist/index.js",
-      "require": "./dist/index.cjs"
+      "types": "./dist/index.d.mts",
+      "import": "./dist/index.mjs"
     }
   },
-  "main": "./dist/index.js",
-  "types": "./dist/index.d.ts",
+  "main": "./dist/index.mjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.mts",
   "bin": "./bin/index.js",
   "files": [
     "bin",

package/dist/chunk-CKQMccvm.cjs

@@ -1,28 +0,0 @@
-//#region \0rolldown/runtime.js
-var __create = Object.create;
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getProtoOf = Object.getPrototypeOf;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __copyProps = (to, from, except, desc) => {
-	if (from && typeof from === "object" || typeof from === "function") for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
-		key = keys[i];
-		if (!__hasOwnProp.call(to, key) && key !== except) __defProp(to, key, {
-			get: ((k) => from[k]).bind(null, key),
-			enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
-		});
-	}
-	return to;
-};
-var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", {
-	value: mod,
-	enumerable: true
-}) : target, mod));
-//#endregion
-Object.defineProperty(exports, "__toESM", {
-	enumerable: true,
-	get: function() {
-		return __toESM;
-	}
-});

package/dist/cli/index.cjs

@@ -1,259 +0,0 @@
-const require_chunk = require("../chunk-CKQMccvm.cjs");
-let node_process = require("node:process");
-node_process = require_chunk.__toESM(node_process, 1);
-let _clack_prompts = require("@clack/prompts");
-_clack_prompts = require_chunk.__toESM(_clack_prompts, 1);
-let ansis = require("ansis");
-ansis = require_chunk.__toESM(ansis, 1);
-let cac = require("cac");
-let node_fs_promises = require("node:fs/promises");
-node_fs_promises = require_chunk.__toESM(node_fs_promises, 1);
-let node_path = require("node:path");
-node_path = require_chunk.__toESM(node_path, 1);
-let node_fs = require("node:fs");
-node_fs = require_chunk.__toESM(node_fs, 1);
-//#region package.json
-var version = "1.27.0";
-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 updatePackageJson() {
-	const cwd = node_process.default.cwd();
-	const pathPackageJSON = node_path.default.join(cwd, "package.json");
-	_clack_prompts.log.step(ansis.default.cyan`Bumping @dhzh/eslint-config to v${version}`);
-	const pkgContent = await node_fs_promises.default.readFile(pathPackageJSON, "utf8");
-	const pkg = JSON.parse(pkgContent);
-	pkg.devDependencies ??= {};
-	pkg.devDependencies["@dhzh/eslint-config"] = `^${version}`;
-	pkg.devDependencies.eslint ??= devDependencies.eslint;
-	pkg.scripts ??= {};
-	pkg.scripts.lint = "eslint .";
-	pkg.scripts["lint-fix"] = "eslint --fix .";
-	await node_fs_promises.default.writeFile(pathPackageJSON, JSON.stringify(pkg, null, 2));
-	_clack_prompts.log.success(ansis.default.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 = node_process.default.cwd();
-	const pathPackageJSON = node_path.default.join(cwd, "package.json");
-	const pkgContent = await node_fs_promises.default.readFile(pathPackageJSON, "utf8");
-	const configFileName = JSON.parse(pkgContent).type === "module" ? "eslint.config.js" : "eslint.config.mjs";
-	const pathFlatConfig = node_path.default.join(cwd, configFileName);
-	await node_fs_promises.default.writeFile(pathFlatConfig, eslintConfigContent(options));
-	_clack_prompts.log.success(ansis.default.green`Created ${configFileName}`);
-}
-//#endregion
-//#region src/cli/stages/update-npmignore.ts
-async function updateNpmignore() {
-	const cwd = node_process.default.cwd();
-	const npmignoreFileName = ".npmignore";
-	const npmignoreFilePath = node_path.default.join(cwd, npmignoreFileName);
-	let action = "Created";
-	try {
-		await node_fs_promises.default.access(npmignoreFilePath);
-		const trimmedContent = (await node_fs_promises.default.readFile(npmignoreFilePath, "utf8")).trimEnd();
-		await node_fs_promises.default.writeFile(npmignoreFilePath, `${trimmedContent}\n${npmignoreString}`);
-		action = "Updated";
-	} catch {
-		await node_fs_promises.default.writeFile(npmignoreFilePath, npmignoreString);
-	}
-	_clack_prompts.log.success(ansis.default.green`${action} ${npmignoreFileName}`);
-}
-//#endregion
-//#region src/cli/stages/update-vscode-settings.ts
-async function updateVscodeSettings() {
-	const cwd = node_process.default.cwd();
-	const dotVscodePath = node_path.default.join(cwd, ".vscode");
-	const settingsPath = node_path.default.join(dotVscodePath, "settings.json");
-	if (!node_fs.default.existsSync(dotVscodePath)) await node_fs_promises.default.mkdir(dotVscodePath, { recursive: true });
-	if (node_fs.default.existsSync(settingsPath)) {
-		let settingsContent = await node_fs_promises.default.readFile(settingsPath, "utf8");
-		settingsContent = settingsContent.trim().replace(/\s*\}$/, "");
-		settingsContent += settingsContent.endsWith(",") || settingsContent.endsWith("{") ? "" : ",";
-		settingsContent += `${vscodeSettingsString}}\n`;
-		await node_fs_promises.default.writeFile(settingsPath, settingsContent, "utf8");
-		_clack_prompts.log.success(ansis.green`Updated .vscode/settings.json`);
-	} else {
-		await node_fs_promises.default.writeFile(settingsPath, `{${vscodeSettingsString}}\n`, "utf8");
-		_clack_prompts.log.success(ansis.green`Created .vscode/settings.json`);
-	}
-}
-//#endregion
-//#region src/cli/run.ts
-async function run(options) {
-	await updatePackageJson();
-	await updateEslintConfig(options);
-	await updateNpmignore();
-	await updateVscodeSettings();
-	_clack_prompts.log.success(ansis.default.green`Setup completed`);
-	_clack_prompts.outro(`Now you can update the dependencies by run ${ansis.default.blue("pnpm i")} and run ${ansis.default.blue("eslint --fix")}\n`);
-}
-//#endregion
-//#region src/cli/index.ts
-const cli = (0, cac.cac)("@dhzh/eslint-config");
-cli.command("", "Run the initialization or migration").action(async () => {
-	console.log("\n");
-	_clack_prompts.intro(`${ansis.default.green`@dhzh/eslint-config `}${ansis.default.dim`v${version}`}`);
-	const options = { hasNest: false };
-	const hasNest = await _clack_prompts.confirm({
-		message: "Is NestJS a part of the current project?",
-		initialValue: false
-	});
-	if (_clack_prompts.isCancel(hasNest)) {
-		_clack_prompts.cancel("Operation cancelled");
-		throw new Error("Operation cancelled");
-	} else options.hasNest = hasNest;
-	try {
-		await run(options);
-	} catch (error) {
-		_clack_prompts.log.error(ansis.default.inverse.red(" Failed to migrate "));
-		_clack_prompts.log.error(ansis.default.red`✘ ${String(error)}`);
-		throw error;
-	}
-});
-cli.help();
-cli.version(version);
-cli.parse();
-//#endregion

package/dist/cli/index.d.cts

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