@dhzh/eslint-config 1.22.0 → 1.23.0

package/dist/cli/index.cjs

@@ -23,12 +23,12 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 ));
 
 // src/cli/index.ts
-var p5 = __toESM(require("@clack/prompts"), 1);
-var import_ansis5 = __toESM(require("ansis"), 1);
+var p6 = __toESM(require("@clack/prompts"), 1);
+var import_ansis6 = __toESM(require("ansis"), 1);
 var import_cac = require("cac");
 
 // package.json
-var version = "1.22.0";
+var version = "1.23.0";
 var package_default = {
   name: "@dhzh/eslint-config",
   type: "module",
@@ -153,15 +153,37 @@ var package_default = {
 };
 
 // src/cli/run.ts
-var p4 = __toESM(require("@clack/prompts"), 1);
-var import_ansis4 = __toESM(require("ansis"), 1);
+var p5 = __toESM(require("@clack/prompts"), 1);
+var import_ansis5 = __toESM(require("ansis"), 1);
 
-// src/cli/stages/update-eslint-config.ts
+// src/cli/stages/update-package-json.ts
 var import_promises = __toESM(require("fs/promises"), 1);
 var import_node_path = __toESM(require("path"), 1);
 var import_node_process = __toESM(require("process"), 1);
-var import_ansis = __toESM(require("ansis"), 1);
 var p = __toESM(require("@clack/prompts"), 1);
+var import_ansis = __toESM(require("ansis"), 1);
+async function updatePackageJson() {
+  const cwd = import_node_process.default.cwd();
+  const pathPackageJSON = import_node_path.default.join(cwd, "package.json");
+  p.log.step(import_ansis.default.cyan`Bumping @dhzh/eslint-config to v${version}`);
+  const pkgContent = await import_promises.default.readFile(pathPackageJSON, "utf8");
+  const pkg = JSON.parse(pkgContent);
+  pkg.devDependencies ??= {};
+  pkg.devDependencies["@dhzh/eslint-config"] = `^${version}`;
+  pkg.devDependencies.eslint ??= package_default.devDependencies.eslint;
+  pkg.scripts ??= {};
+  pkg.scripts.lint = "eslint .";
+  pkg.scripts["lint-fix"] = "eslint --fix .";
+  await import_promises.default.writeFile(pathPackageJSON, JSON.stringify(pkg, null, 2));
+  p.log.success(import_ansis.default.green`Changes wrote to package.json`);
+}
+
+// src/cli/stages/update-eslint-config.ts
+var import_promises2 = __toESM(require("fs/promises"), 1);
+var import_node_path2 = __toESM(require("path"), 1);
+var import_node_process2 = __toESM(require("process"), 1);
+var import_ansis2 = __toESM(require("ansis"), 1);
+var p2 = __toESM(require("@clack/prompts"), 1);
 
 // src/cli/constants.ts
 var vscodeSettingsString = `
@@ -282,67 +304,64 @@ export default defineConfig(${options.hasNest ? `{
   },
 }` : ""});
 `;
+var 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
+`;
 
 // src/cli/stages/update-eslint-config.ts
 async function updateEslintConfig(options) {
-  const cwd = import_node_process.default.cwd();
-  const pathPackageJSON = import_node_path.default.join(cwd, "package.json");
-  const pkgContent = await import_promises.default.readFile(pathPackageJSON, "utf8");
-  const pkg = JSON.parse(pkgContent);
-  const configFileName = pkg.type === "module" ? "eslint.config.js" : "eslint.config.mjs";
-  const pathFlatConfig = import_node_path.default.join(cwd, configFileName);
-  await import_promises.default.writeFile(pathFlatConfig, eslintConfigContent(options));
-  p.log.success(import_ansis.default.green`Created ${configFileName}`);
-}
-
-// src/cli/stages/update-package-json.ts
-var import_promises2 = __toESM(require("fs/promises"), 1);
-var import_node_path2 = __toESM(require("path"), 1);
-var import_node_process2 = __toESM(require("process"), 1);
-var p2 = __toESM(require("@clack/prompts"), 1);
-var import_ansis2 = __toESM(require("ansis"), 1);
-async function updatePackageJson() {
   const cwd = import_node_process2.default.cwd();
   const pathPackageJSON = import_node_path2.default.join(cwd, "package.json");
-  p2.log.step(import_ansis2.default.cyan`Bumping @dhzh/eslint-config to v${version}`);
   const pkgContent = await import_promises2.default.readFile(pathPackageJSON, "utf8");
   const pkg = JSON.parse(pkgContent);
-  pkg.devDependencies ??= {};
-  pkg.devDependencies["@dhzh/eslint-config"] = `^${version}`;
-  pkg.devDependencies.eslint ??= package_default.devDependencies.eslint;
-  pkg.scripts ??= {};
-  pkg.scripts.lint = "eslint .";
-  pkg.scripts["lint-fix"] = "eslint --fix .";
-  await import_promises2.default.writeFile(pathPackageJSON, JSON.stringify(pkg, null, 2));
-  p2.log.success(import_ansis2.default.green`Changes wrote to package.json`);
+  const configFileName = pkg.type === "module" ? "eslint.config.js" : "eslint.config.mjs";
+  const pathFlatConfig = import_node_path2.default.join(cwd, configFileName);
+  await import_promises2.default.writeFile(pathFlatConfig, eslintConfigContent(options));
+  p2.log.success(import_ansis2.default.green`Created ${configFileName}`);
 }
 
-// src/cli/stages/update-vscode-settings.ts
-var import_node_fs = __toESM(require("fs"), 1);
+// src/cli/stages/update-npmignore.ts
 var import_promises3 = __toESM(require("fs/promises"), 1);
 var import_node_path3 = __toESM(require("path"), 1);
 var import_node_process3 = __toESM(require("process"), 1);
-var import_ansis3 = require("ansis");
+var import_ansis3 = __toESM(require("ansis"), 1);
 var p3 = __toESM(require("@clack/prompts"), 1);
-async function updateVscodeSettings() {
+async function updateNpmignore() {
   const cwd = import_node_process3.default.cwd();
-  const dotVscodePath = import_node_path3.default.join(cwd, ".vscode");
-  const settingsPath = import_node_path3.default.join(dotVscodePath, "settings.json");
+  const npmignoreFileName = ".npmignore";
+  const npmignoreFilePath = import_node_path3.default.join(cwd, npmignoreFileName);
+  await import_promises3.default.writeFile(npmignoreFilePath, npmignoreString);
+  p3.log.success(import_ansis3.default.green`Created ${npmignoreFileName}`);
+}
+
+// src/cli/stages/update-vscode-settings.ts
+var import_node_fs = __toESM(require("fs"), 1);
+var import_promises4 = __toESM(require("fs/promises"), 1);
+var import_node_path4 = __toESM(require("path"), 1);
+var import_node_process4 = __toESM(require("process"), 1);
+var import_ansis4 = require("ansis");
+var p4 = __toESM(require("@clack/prompts"), 1);
+async function updateVscodeSettings() {
+  const cwd = import_node_process4.default.cwd();
+  const dotVscodePath = import_node_path4.default.join(cwd, ".vscode");
+  const settingsPath = import_node_path4.default.join(dotVscodePath, "settings.json");
   if (!import_node_fs.default.existsSync(dotVscodePath)) {
-    await import_promises3.default.mkdir(dotVscodePath, { recursive: true });
+    await import_promises4.default.mkdir(dotVscodePath, { recursive: true });
   }
   if (import_node_fs.default.existsSync(settingsPath)) {
-    let settingsContent = await import_promises3.default.readFile(settingsPath, "utf8");
+    let settingsContent = await import_promises4.default.readFile(settingsPath, "utf8");
     settingsContent = settingsContent.trim().replace(/\s*\}$/, "");
     settingsContent += settingsContent.endsWith(",") || settingsContent.endsWith("{") ? "" : ",";
     settingsContent += `${vscodeSettingsString}}
 `;
-    await import_promises3.default.writeFile(settingsPath, settingsContent, "utf8");
-    p3.log.success(import_ansis3.green`Updated .vscode/settings.json`);
+    await import_promises4.default.writeFile(settingsPath, settingsContent, "utf8");
+    p4.log.success(import_ansis4.green`Updated .vscode/settings.json`);
   } else {
-    await import_promises3.default.writeFile(settingsPath, `{${vscodeSettingsString}}
+    await import_promises4.default.writeFile(settingsPath, `{${vscodeSettingsString}}
 `, "utf8");
-    p3.log.success(import_ansis3.green`Created .vscode/settings.json`);
+    p4.log.success(import_ansis4.green`Created .vscode/settings.json`);
   }
 }
 
@@ -350,9 +369,10 @@ async function updateVscodeSettings() {
 async function run(options) {
   await updatePackageJson();
   await updateEslintConfig(options);
+  await updateNpmignore();
   await updateVscodeSettings();
-  p4.log.success(import_ansis4.default.green`Setup completed`);
-  p4.outro(`Now you can update the dependencies by run ${import_ansis4.default.blue("pnpm i")} and run ${import_ansis4.default.blue("eslint --fix")}
+  p5.log.success(import_ansis5.default.green`Setup completed`);
+  p5.outro(`Now you can update the dependencies by run ${import_ansis5.default.blue("pnpm i")} and run ${import_ansis5.default.blue("eslint --fix")}
 `);
 }
 
@@ -360,16 +380,16 @@ async function run(options) {
 var cli = (0, import_cac.cac)("@dhzh/eslint-config");
 cli.command("", "Run the initialization or migration").action(async () => {
   console.log("\n");
-  p5.intro(`${import_ansis5.default.green`@dhzh/eslint-config `}${import_ansis5.default.dim`v${version}`}`);
+  p6.intro(`${import_ansis6.default.green`@dhzh/eslint-config `}${import_ansis6.default.dim`v${version}`}`);
   const options = {
     hasNest: false
   };
-  const hasNest = await p5.confirm({
+  const hasNest = await p6.confirm({
     message: "Is NestJS a part of the current project?",
     initialValue: false
   });
-  if (p5.isCancel(hasNest)) {
-    p5.cancel("Operation cancelled");
+  if (p6.isCancel(hasNest)) {
+    p6.cancel("Operation cancelled");
     throw new Error("Operation cancelled");
   } else {
     options.hasNest = hasNest;
@@ -377,8 +397,8 @@ cli.command("", "Run the initialization or migration").action(async () => {
   try {
     await run(options);
   } catch (error) {
-    p5.log.error(import_ansis5.default.inverse.red(" Failed to migrate "));
-    p5.log.error(import_ansis5.default.red`✘ ${String(error)}`);
+    p6.log.error(import_ansis6.default.inverse.red(" Failed to migrate "));
+    p6.log.error(import_ansis6.default.red`✘ ${String(error)}`);
     throw error;
   }
 });

package/dist/cli/index.js

@@ -1,10 +1,10 @@
 // src/cli/index.ts
-import * as p5 from "@clack/prompts";
-import c4 from "ansis";
+import * as p6 from "@clack/prompts";
+import c5 from "ansis";
 import { cac } from "cac";
 
 // package.json
-var version = "1.22.0";
+var version = "1.23.0";
 var package_default = {
   name: "@dhzh/eslint-config",
   type: "module",
@@ -129,15 +129,37 @@ var package_default = {
 };
 
 // src/cli/run.ts
-import * as p4 from "@clack/prompts";
-import c3 from "ansis";
+import * as p5 from "@clack/prompts";
+import c4 from "ansis";
 
-// src/cli/stages/update-eslint-config.ts
+// src/cli/stages/update-package-json.ts
 import fsp from "fs/promises";
 import path from "path";
 import process from "process";
-import c from "ansis";
 import * as p from "@clack/prompts";
+import c from "ansis";
+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 ??= package_default.devDependencies.eslint;
+  pkg.scripts ??= {};
+  pkg.scripts.lint = "eslint .";
+  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`);
+}
+
+// src/cli/stages/update-eslint-config.ts
+import fsp2 from "fs/promises";
+import path2 from "path";
+import process2 from "process";
+import c2 from "ansis";
+import * as p2 from "@clack/prompts";
 
 // src/cli/constants.ts
 var vscodeSettingsString = `
@@ -258,67 +280,64 @@ export default defineConfig(${options.hasNest ? `{
   },
 }` : ""});
 `;
+var 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
+`;
 
 // 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 pkg = JSON.parse(pkgContent);
-  const configFileName = pkg.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}`);
-}
-
-// src/cli/stages/update-package-json.ts
-import fsp2 from "fs/promises";
-import path2 from "path";
-import process2 from "process";
-import * as p2 from "@clack/prompts";
-import c2 from "ansis";
-async function updatePackageJson() {
   const cwd = process2.cwd();
   const pathPackageJSON = path2.join(cwd, "package.json");
-  p2.log.step(c2.cyan`Bumping @dhzh/eslint-config to v${version}`);
   const pkgContent = await fsp2.readFile(pathPackageJSON, "utf8");
   const pkg = JSON.parse(pkgContent);
-  pkg.devDependencies ??= {};
-  pkg.devDependencies["@dhzh/eslint-config"] = `^${version}`;
-  pkg.devDependencies.eslint ??= package_default.devDependencies.eslint;
-  pkg.scripts ??= {};
-  pkg.scripts.lint = "eslint .";
-  pkg.scripts["lint-fix"] = "eslint --fix .";
-  await fsp2.writeFile(pathPackageJSON, JSON.stringify(pkg, null, 2));
-  p2.log.success(c2.green`Changes wrote to package.json`);
+  const configFileName = pkg.type === "module" ? "eslint.config.js" : "eslint.config.mjs";
+  const pathFlatConfig = path2.join(cwd, configFileName);
+  await fsp2.writeFile(pathFlatConfig, eslintConfigContent(options));
+  p2.log.success(c2.green`Created ${configFileName}`);
 }
 
-// src/cli/stages/update-vscode-settings.ts
-import fs from "fs";
+// src/cli/stages/update-npmignore.ts
 import fsp3 from "fs/promises";
 import path3 from "path";
 import process3 from "process";
-import { green } from "ansis";
+import c3 from "ansis";
 import * as p3 from "@clack/prompts";
-async function updateVscodeSettings() {
+async function updateNpmignore() {
   const cwd = process3.cwd();
-  const dotVscodePath = path3.join(cwd, ".vscode");
-  const settingsPath = path3.join(dotVscodePath, "settings.json");
+  const npmignoreFileName = ".npmignore";
+  const npmignoreFilePath = path3.join(cwd, npmignoreFileName);
+  await fsp3.writeFile(npmignoreFilePath, npmignoreString);
+  p3.log.success(c3.green`Created ${npmignoreFileName}`);
+}
+
+// src/cli/stages/update-vscode-settings.ts
+import fs from "fs";
+import fsp4 from "fs/promises";
+import path4 from "path";
+import process4 from "process";
+import { green } from "ansis";
+import * as p4 from "@clack/prompts";
+async function updateVscodeSettings() {
+  const cwd = process4.cwd();
+  const dotVscodePath = path4.join(cwd, ".vscode");
+  const settingsPath = path4.join(dotVscodePath, "settings.json");
   if (!fs.existsSync(dotVscodePath)) {
-    await fsp3.mkdir(dotVscodePath, { recursive: true });
+    await fsp4.mkdir(dotVscodePath, { recursive: true });
   }
   if (fs.existsSync(settingsPath)) {
-    let settingsContent = await fsp3.readFile(settingsPath, "utf8");
+    let settingsContent = await fsp4.readFile(settingsPath, "utf8");
     settingsContent = settingsContent.trim().replace(/\s*\}$/, "");
     settingsContent += settingsContent.endsWith(",") || settingsContent.endsWith("{") ? "" : ",";
     settingsContent += `${vscodeSettingsString}}
 `;
-    await fsp3.writeFile(settingsPath, settingsContent, "utf8");
-    p3.log.success(green`Updated .vscode/settings.json`);
+    await fsp4.writeFile(settingsPath, settingsContent, "utf8");
+    p4.log.success(green`Updated .vscode/settings.json`);
   } else {
-    await fsp3.writeFile(settingsPath, `{${vscodeSettingsString}}
+    await fsp4.writeFile(settingsPath, `{${vscodeSettingsString}}
 `, "utf8");
-    p3.log.success(green`Created .vscode/settings.json`);
+    p4.log.success(green`Created .vscode/settings.json`);
   }
 }
 
@@ -326,9 +345,10 @@ async function updateVscodeSettings() {
 async function run(options) {
   await updatePackageJson();
   await updateEslintConfig(options);
+  await updateNpmignore();
   await updateVscodeSettings();
-  p4.log.success(c3.green`Setup completed`);
-  p4.outro(`Now you can update the dependencies by run ${c3.blue("pnpm i")} and run ${c3.blue("eslint --fix")}
+  p5.log.success(c4.green`Setup completed`);
+  p5.outro(`Now you can update the dependencies by run ${c4.blue("pnpm i")} and run ${c4.blue("eslint --fix")}
 `);
 }
 
@@ -336,16 +356,16 @@ async function run(options) {
 var cli = cac("@dhzh/eslint-config");
 cli.command("", "Run the initialization or migration").action(async () => {
   console.log("\n");
-  p5.intro(`${c4.green`@dhzh/eslint-config `}${c4.dim`v${version}`}`);
+  p6.intro(`${c5.green`@dhzh/eslint-config `}${c5.dim`v${version}`}`);
   const options = {
     hasNest: false
   };
-  const hasNest = await p5.confirm({
+  const hasNest = await p6.confirm({
     message: "Is NestJS a part of the current project?",
     initialValue: false
   });
-  if (p5.isCancel(hasNest)) {
-    p5.cancel("Operation cancelled");
+  if (p6.isCancel(hasNest)) {
+    p6.cancel("Operation cancelled");
     throw new Error("Operation cancelled");
   } else {
     options.hasNest = hasNest;
@@ -353,8 +373,8 @@ cli.command("", "Run the initialization or migration").action(async () => {
   try {
     await run(options);
   } catch (error) {
-    p5.log.error(c4.inverse.red(" Failed to migrate "));
-    p5.log.error(c4.red`✘ ${String(error)}`);
+    p6.log.error(c5.inverse.red(" Failed to migrate "));
+    p6.log.error(c5.red`✘ ${String(error)}`);
     throw error;
   }
 });

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@dhzh/eslint-config",
   "type": "module",
-  "version": "1.22.0",
+  "version": "1.23.0",
   "description": "Lyle's ESLint config",
   "author": {
     "name": "Lyle Zheng",