@coderwyd/eslint-config 1.1.0-beta.3 → 1.1.0

package/README.md

@@ -76,8 +76,8 @@ Add the following settings to your `.vscode/settings.json`:
 
   // Auto fix
   "editor.codeActionsOnSave": {
-    "source.fixAll.eslint": true,
-    "source.organizeImports": false
+    "source.fixAll": "explicit",
+    "source.organizeImports": "never"
   },
 
   // Silent the stylistic rules in you IDE, but still auto fix them
@@ -187,7 +187,7 @@ import {
   typescript,
   unicorn,
   vue,
-  yml,
+  yaml,
 } from '@coderwyd/eslint-config'
 
 export default [
@@ -204,7 +204,7 @@ export default [
   ...stylistic(),
   ...vue(),
   ...jsonc(),
-  ...yml(),
+  ...yaml(),
   ...markdown(),
 ]
 ```

package/bin/index.js

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+
+import '../dist/cli.js'

package/dist/cli.cjs

@@ -0,0 +1,268 @@
+"use strict";
+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 (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/cli.ts
+var cli_exports = {};
+module.exports = __toCommonJS(cli_exports);
+
+// src/cli/index.ts
+var import_node_process2 = __toESM(require("process"), 1);
+var import_picocolors3 = __toESM(require("picocolors"), 1);
+var import_helpers = require("yargs/helpers");
+var import_yargs = __toESM(require("yargs"), 1);
+
+// src/cli/run.ts
+var import_node_fs = __toESM(require("fs"), 1);
+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_prompts = __toESM(require("prompts"), 1);
+var import_picocolors2 = __toESM(require("picocolors"), 1);
+var import_parse_gitignore = __toESM(require("parse-gitignore"), 1);
+
+// src/cli/constants.ts
+var import_picocolors = __toESM(require("picocolors"), 1);
+
+// package.json
+var version = "1.1.0";
+var devDependencies = {
+  "@antfu/ni": "^0.21.10",
+  "@stylistic/eslint-plugin-migrate": "^1.4.0",
+  "@types/eslint": "^8.44.7",
+  "@types/fs-extra": "^11.0.4",
+  "@types/node": "^20.9.4",
+  "@types/prompts": "^2.4.9",
+  "@types/yargs": "^17.0.32",
+  "@unocss/eslint-plugin": "^0.57.7",
+  bumpp: "^9.2.0",
+  eslint: "^8.54.0",
+  "eslint-flat-config-viewer": "^0.1.3",
+  "eslint-plugin-react": "^7.33.2",
+  "eslint-plugin-react-hooks": "^4.6.0",
+  "eslint-plugin-react-refresh": "^0.4.4",
+  esno: "^4.0.0",
+  execa: "^8.0.1",
+  "fast-glob": "^3.3.2",
+  "fs-extra": "^11.1.1",
+  "lint-staged": "^15.1.0",
+  rimraf: "^5.0.5",
+  "simple-git-hooks": "^2.9.0",
+  tsup: "^8.0.1",
+  typescript: "^5.3.2",
+  vitest: "^0.34.6"
+};
+
+// src/cli/constants.ts
+var ARROW = import_picocolors.default.cyan("\u2192");
+var CHECK = import_picocolors.default.green("\u2714");
+var CROSS = import_picocolors.default.red("\u2718");
+var WARN = import_picocolors.default.yellow("\u2139");
+var eslintVersion = devDependencies.eslint;
+var vscodeSettingsString = `
+  // Enable the ESlint flat config support
+  "eslint.experimental.useFlatConfig": true,
+
+  // Disable the default formatter, use eslint instead
+  "prettier.enable": false,
+  "editor.formatOnSave": 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" },
+    { "rule": "*-indent", "severity": "off" },
+    { "rule": "*-spacing", "severity": "off" },
+    { "rule": "*-spaces", "severity": "off" },
+    { "rule": "*-order", "severity": "off" },
+    { "rule": "*-dangle", "severity": "off" },
+    { "rule": "*-newline", "severity": "off" },
+    { "rule": "*quotes", "severity": "off" },
+    { "rule": "*semi", "severity": "off" }
+  ],
+
+  // Enable eslint for all supported languages
+  "eslint.validate": [
+    "javascript",
+    "javascriptreact",
+    "typescript",
+    "typescriptreact",
+    "vue",
+    "html",
+    "markdown",
+    "json",
+    "jsonc",
+    "yaml"
+  ]
+`;
+
+// src/cli/utils.ts
+var import_node_child_process = require("child_process");
+function isGitClean() {
+  try {
+    (0, import_node_child_process.execSync)("git diff-index --quiet HEAD --");
+    return true;
+  } catch (error) {
+    return false;
+  }
+}
+
+// src/cli/run.ts
+async function run(options = {}) {
+  const SKIP_PROMPT = !!import_node_process.default.env.SKIP_PROMPT || options.yes;
+  const SKIP_GIT_CHECK = !!import_node_process.default.env.SKIP_GIT_CHECK;
+  const cwd = import_node_process.default.cwd();
+  const pathFlatConfig = import_node_path.default.join(cwd, "eslint.config.js");
+  const pathPackageJSON = import_node_path.default.join(cwd, "package.json");
+  const pathESLintIngore = import_node_path.default.join(cwd, ".eslintignore");
+  if (import_node_fs.default.existsSync(pathFlatConfig)) {
+    console.log(import_picocolors2.default.yellow(`${WARN} eslint.config.js already exists, migration wizard exited.`));
+    return;
+  }
+  if (!SKIP_GIT_CHECK && !isGitClean())
+    throw new Error("There are uncommitted changes in the current repository, please commit them and try again");
+  console.log(import_picocolors2.default.cyan(`${ARROW} bumping @coderwyd/eslint-config to v${version}`));
+  const pkgContent = await import_promises.default.readFile(pathPackageJSON, "utf-8");
+  const pkg = JSON.parse(pkgContent);
+  pkg.devDependencies ?? (pkg.devDependencies = {});
+  pkg.devDependencies["@coderwyd/eslint-config"] = `^${version}`;
+  if (!pkg.devDependencies.eslint)
+    pkg.devDependencies.eslint = eslintVersion;
+  await import_promises.default.writeFile(pathPackageJSON, JSON.stringify(pkg, null, 2));
+  console.log(import_picocolors2.default.green(`${CHECK} changes wrote to package.json`));
+  const eslintIgnores = [];
+  if (import_node_fs.default.existsSync(pathESLintIngore)) {
+    console.log(import_picocolors2.default.cyan(`${ARROW} migrating existing .eslintignore`));
+    const content = await import_promises.default.readFile(pathESLintIngore, "utf-8");
+    const parsed = (0, import_parse_gitignore.default)(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}`));
+    }
+  }
+  let eslintConfigContent = "";
+  const coderwydConfig = `${eslintIgnores.length ? `ignores: ${JSON.stringify(eslintIgnores)}` : ""}`;
+  if (pkg.type === "module") {
+    eslintConfigContent = `
+import coderwyd from '@coderwyd/eslint-config'
+
+export default coderwyd({
+${coderwydConfig}
+})
+`.trimStart();
+  } else {
+    eslintConfigContent = `
+const coderwyd = require('@coderwyd/eslint-config').default
+
+module.exports = coderwyd({
+${coderwydConfig}
+})
+`.trimStart();
+  }
+  await import_promises.default.writeFile(pathFlatConfig, eslintConfigContent);
+  console.log(import_picocolors2.default.green(`${CHECK} created eslint.config.js`));
+  const files = import_node_fs.default.readdirSync(cwd);
+  const legacyConfig = [];
+  files.forEach((file) => {
+    if (file.includes("eslint") || file.includes("prettier"))
+      legacyConfig.push(file);
+  });
+  if (legacyConfig.length) {
+    console.log(`${WARN} you can now remove those files manually:`);
+    console.log(`   ${import_picocolors2.default.dim(legacyConfig.join(", "))}`);
+  }
+  let promptResult = {
+    updateVscodeSettings: true
+  };
+  if (!SKIP_PROMPT) {
+    try {
+      promptResult = await (0, import_prompts.default)({
+        initial: true,
+        message: "Update .vscode/settings.json for better VS Code experience?",
+        name: "updateVscodeSettings",
+        type: "confirm"
+      }, {
+        onCancel: () => {
+          throw new Error(`Cancelled`);
+        }
+      });
+    } catch (cancelled) {
+      console.log(cancelled.message);
+      return;
+    }
+  }
+  if (promptResult?.updateVscodeSettings ?? true) {
+    const dotVscodePath = import_node_path.default.join(cwd, ".vscode");
+    const settingsPath = import_node_path.default.join(dotVscodePath, "settings.json");
+    if (!import_node_fs.default.existsSync(dotVscodePath))
+      await import_promises.default.mkdir(dotVscodePath, { recursive: true });
+    if (!import_node_fs.default.existsSync(settingsPath)) {
+      await import_promises.default.writeFile(settingsPath, `{${vscodeSettingsString}}
+`, "utf-8");
+      console.log(import_picocolors2.default.green(`${CHECK} created .vscode/settings.json`));
+    } else {
+      let settingsContent = await import_promises.default.readFile(settingsPath, "utf8");
+      settingsContent = settingsContent.trim().replace(/\s*}$/, "");
+      settingsContent += settingsContent.endsWith(",") || settingsContent.endsWith("{") ? "" : ",";
+      settingsContent += `${vscodeSettingsString}}
+`;
+      await import_promises.default.writeFile(settingsPath, settingsContent, "utf-8");
+      console.log(import_picocolors2.default.green(`${CHECK} updated .vscode/settings.json`));
+    }
+  }
+  console.log(import_picocolors2.default.green(`${CHECK} migration completed`));
+  console.log(`Now you can update the dependencies and run ${import_picocolors2.default.blue("eslint . --fix")}
+`);
+}
+
+// src/cli/index.ts
+function header() {
+  console.log(`
+${import_picocolors3.default.green(`@coderwyd/eslint-config `)}${import_picocolors3.default.dim(`v${version}`)}`);
+}
+var instance = (0, import_yargs.default)((0, import_helpers.hideBin)(import_node_process2.default.argv)).scriptName("@coderwyd/eslint-config").usage("").command(
+  "*",
+  "Run the initialization or migration",
+  (args) => args.option("yes", { alias: "y", description: "Skip prompts and use default values", type: "boolean" }).help(),
+  async (args) => {
+    header();
+    console.log();
+    try {
+      await run(args);
+    } catch (error) {
+      console.error(import_picocolors3.default.inverse(import_picocolors3.default.red(" Failed to migrate ")));
+      console.error(import_picocolors3.default.red(`${CROSS} ${String(error)}`));
+      import_node_process2.default.exit(1);
+    }
+  }
+).showHelpOnFail(false).alias("h", "help").version("version", version).alias("v", "version");
+instance.help().argv;

package/dist/cli.d.cts

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

package/dist/cli.d.ts

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

package/dist/cli.js

@@ -0,0 +1,239 @@
+// src/cli/index.ts
+import process2 from "process";
+import c3 from "picocolors";
+import { hideBin } from "yargs/helpers";
+import yargs from "yargs";
+
+// src/cli/run.ts
+import fs from "fs";
+import fsp from "fs/promises";
+import path from "path";
+import process from "process";
+import prompts from "prompts";
+import c2 from "picocolors";
+import parse from "parse-gitignore";
+
+// src/cli/constants.ts
+import c from "picocolors";
+
+// package.json
+var version = "1.1.0";
+var devDependencies = {
+  "@antfu/ni": "^0.21.10",
+  "@stylistic/eslint-plugin-migrate": "^1.4.0",
+  "@types/eslint": "^8.44.7",
+  "@types/fs-extra": "^11.0.4",
+  "@types/node": "^20.9.4",
+  "@types/prompts": "^2.4.9",
+  "@types/yargs": "^17.0.32",
+  "@unocss/eslint-plugin": "^0.57.7",
+  bumpp: "^9.2.0",
+  eslint: "^8.54.0",
+  "eslint-flat-config-viewer": "^0.1.3",
+  "eslint-plugin-react": "^7.33.2",
+  "eslint-plugin-react-hooks": "^4.6.0",
+  "eslint-plugin-react-refresh": "^0.4.4",
+  esno: "^4.0.0",
+  execa: "^8.0.1",
+  "fast-glob": "^3.3.2",
+  "fs-extra": "^11.1.1",
+  "lint-staged": "^15.1.0",
+  rimraf: "^5.0.5",
+  "simple-git-hooks": "^2.9.0",
+  tsup: "^8.0.1",
+  typescript: "^5.3.2",
+  vitest: "^0.34.6"
+};
+
+// src/cli/constants.ts
+var ARROW = c.cyan("\u2192");
+var CHECK = c.green("\u2714");
+var CROSS = c.red("\u2718");
+var WARN = c.yellow("\u2139");
+var eslintVersion = devDependencies.eslint;
+var vscodeSettingsString = `
+  // Enable the ESlint flat config support
+  "eslint.experimental.useFlatConfig": true,
+
+  // Disable the default formatter, use eslint instead
+  "prettier.enable": false,
+  "editor.formatOnSave": 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" },
+    { "rule": "*-indent", "severity": "off" },
+    { "rule": "*-spacing", "severity": "off" },
+    { "rule": "*-spaces", "severity": "off" },
+    { "rule": "*-order", "severity": "off" },
+    { "rule": "*-dangle", "severity": "off" },
+    { "rule": "*-newline", "severity": "off" },
+    { "rule": "*quotes", "severity": "off" },
+    { "rule": "*semi", "severity": "off" }
+  ],
+
+  // Enable eslint for all supported languages
+  "eslint.validate": [
+    "javascript",
+    "javascriptreact",
+    "typescript",
+    "typescriptreact",
+    "vue",
+    "html",
+    "markdown",
+    "json",
+    "jsonc",
+    "yaml"
+  ]
+`;
+
+// src/cli/utils.ts
+import { execSync } from "child_process";
+function isGitClean() {
+  try {
+    execSync("git diff-index --quiet HEAD --");
+    return true;
+  } catch (error) {
+    return false;
+  }
+}
+
+// src/cli/run.ts
+async function run(options = {}) {
+  const SKIP_PROMPT = !!process.env.SKIP_PROMPT || options.yes;
+  const SKIP_GIT_CHECK = !!process.env.SKIP_GIT_CHECK;
+  const cwd = process.cwd();
+  const pathFlatConfig = path.join(cwd, "eslint.config.js");
+  const pathPackageJSON = path.join(cwd, "package.json");
+  const pathESLintIngore = path.join(cwd, ".eslintignore");
+  if (fs.existsSync(pathFlatConfig)) {
+    console.log(c2.yellow(`${WARN} eslint.config.js already exists, migration wizard exited.`));
+    return;
+  }
+  if (!SKIP_GIT_CHECK && !isGitClean())
+    throw new Error("There are uncommitted changes in the current repository, please commit them and try again");
+  console.log(c2.cyan(`${ARROW} bumping @coderwyd/eslint-config to v${version}`));
+  const pkgContent = await fsp.readFile(pathPackageJSON, "utf-8");
+  const pkg = JSON.parse(pkgContent);
+  pkg.devDependencies ?? (pkg.devDependencies = {});
+  pkg.devDependencies["@coderwyd/eslint-config"] = `^${version}`;
+  if (!pkg.devDependencies.eslint)
+    pkg.devDependencies.eslint = eslintVersion;
+  await fsp.writeFile(pathPackageJSON, JSON.stringify(pkg, null, 2));
+  console.log(c2.green(`${CHECK} changes wrote to package.json`));
+  const eslintIgnores = [];
+  if (fs.existsSync(pathESLintIngore)) {
+    console.log(c2.cyan(`${ARROW} migrating existing .eslintignore`));
+    const content = await fsp.readFile(pathESLintIngore, "utf-8");
+    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}`));
+    }
+  }
+  let eslintConfigContent = "";
+  const coderwydConfig = `${eslintIgnores.length ? `ignores: ${JSON.stringify(eslintIgnores)}` : ""}`;
+  if (pkg.type === "module") {
+    eslintConfigContent = `
+import coderwyd from '@coderwyd/eslint-config'
+
+export default coderwyd({
+${coderwydConfig}
+})
+`.trimStart();
+  } else {
+    eslintConfigContent = `
+const coderwyd = require('@coderwyd/eslint-config').default
+
+module.exports = coderwyd({
+${coderwydConfig}
+})
+`.trimStart();
+  }
+  await fsp.writeFile(pathFlatConfig, eslintConfigContent);
+  console.log(c2.green(`${CHECK} created eslint.config.js`));
+  const files = fs.readdirSync(cwd);
+  const legacyConfig = [];
+  files.forEach((file) => {
+    if (file.includes("eslint") || file.includes("prettier"))
+      legacyConfig.push(file);
+  });
+  if (legacyConfig.length) {
+    console.log(`${WARN} you can now remove those files manually:`);
+    console.log(`   ${c2.dim(legacyConfig.join(", "))}`);
+  }
+  let promptResult = {
+    updateVscodeSettings: true
+  };
+  if (!SKIP_PROMPT) {
+    try {
+      promptResult = await prompts({
+        initial: true,
+        message: "Update .vscode/settings.json for better VS Code experience?",
+        name: "updateVscodeSettings",
+        type: "confirm"
+      }, {
+        onCancel: () => {
+          throw new Error(`Cancelled`);
+        }
+      });
+    } catch (cancelled) {
+      console.log(cancelled.message);
+      return;
+    }
+  }
+  if (promptResult?.updateVscodeSettings ?? true) {
+    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)) {
+      await fsp.writeFile(settingsPath, `{${vscodeSettingsString}}
+`, "utf-8");
+      console.log(c2.green(`${CHECK} created .vscode/settings.json`));
+    } else {
+      let settingsContent = await fsp.readFile(settingsPath, "utf8");
+      settingsContent = settingsContent.trim().replace(/\s*}$/, "");
+      settingsContent += settingsContent.endsWith(",") || settingsContent.endsWith("{") ? "" : ",";
+      settingsContent += `${vscodeSettingsString}}
+`;
+      await fsp.writeFile(settingsPath, settingsContent, "utf-8");
+      console.log(c2.green(`${CHECK} updated .vscode/settings.json`));
+    }
+  }
+  console.log(c2.green(`${CHECK} migration completed`));
+  console.log(`Now you can update the dependencies and run ${c2.blue("eslint . --fix")}
+`);
+}
+
+// src/cli/index.ts
+function header() {
+  console.log(`
+${c3.green(`@coderwyd/eslint-config `)}${c3.dim(`v${version}`)}`);
+}
+var instance = yargs(hideBin(process2.argv)).scriptName("@coderwyd/eslint-config").usage("").command(
+  "*",
+  "Run the initialization or migration",
+  (args) => args.option("yes", { alias: "y", description: "Skip prompts and use default values", type: "boolean" }).help(),
+  async (args) => {
+    header();
+    console.log();
+    try {
+      await run(args);
+    } catch (error) {
+      console.error(c3.inverse(c3.red(" Failed to migrate ")));
+      console.error(c3.red(`${CROSS} ${String(error)}`));
+      process2.exit(1);
+    }
+  }
+).showHelpOnFail(false).alias("h", "help").version("version", version).alias("v", "version");
+instance.help().argv;