@solvro/config 1.0.2 → 1.0.4

package/dist/eslint-config/cli.cjs

@@ -0,0 +1,538 @@
+"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 __esm = (fn, res) => function __init() {
+  return fn && (res = (0, fn[__getOwnPropNames(fn)[0]])(fn = 0)), res;
+};
+var __commonJS = (cb, mod) => function __require() {
+  return mod || (0, cb[__getOwnPropNames(cb)[0]])((mod = { exports: {} }).exports, mod), mod.exports;
+};
+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);
+
+// node_modules/tsup/assets/cjs_shims.js
+var init_cjs_shims = __esm({
+  "node_modules/tsup/assets/cjs_shims.js"() {
+    "use strict";
+  }
+});
+
+// node_modules/picocolors/picocolors.js
+var require_picocolors = __commonJS({
+  "node_modules/picocolors/picocolors.js"(exports2, module2) {
+    "use strict";
+    init_cjs_shims();
+    var p6 = process || {};
+    var argv = p6.argv || [];
+    var env = p6.env || {};
+    var isColorSupported = !(!!env.NO_COLOR || argv.includes("--no-color")) && (!!env.FORCE_COLOR || argv.includes("--color") || p6.platform === "win32" || (p6.stdout || {}).isTTY && env.TERM !== "dumb" || !!env.CI);
+    var formatter = (open, close, replace = open) => (input) => {
+      let string = "" + input, index = string.indexOf(close, open.length);
+      return ~index ? open + replaceClose(string, close, replace, index) + close : open + string + close;
+    };
+    var replaceClose = (string, close, replace, index) => {
+      let result = "", cursor = 0;
+      do {
+        result += string.substring(cursor, index) + replace;
+        cursor = index + close.length;
+        index = string.indexOf(close, cursor);
+      } while (~index);
+      return result + string.substring(cursor);
+    };
+    var createColors = (enabled = isColorSupported) => {
+      let f = enabled ? formatter : () => String;
+      return {
+        isColorSupported: enabled,
+        reset: f("\x1B[0m", "\x1B[0m"),
+        bold: f("\x1B[1m", "\x1B[22m", "\x1B[22m\x1B[1m"),
+        dim: f("\x1B[2m", "\x1B[22m", "\x1B[22m\x1B[2m"),
+        italic: f("\x1B[3m", "\x1B[23m"),
+        underline: f("\x1B[4m", "\x1B[24m"),
+        inverse: f("\x1B[7m", "\x1B[27m"),
+        hidden: f("\x1B[8m", "\x1B[28m"),
+        strikethrough: f("\x1B[9m", "\x1B[29m"),
+        black: f("\x1B[30m", "\x1B[39m"),
+        red: f("\x1B[31m", "\x1B[39m"),
+        green: f("\x1B[32m", "\x1B[39m"),
+        yellow: f("\x1B[33m", "\x1B[39m"),
+        blue: f("\x1B[34m", "\x1B[39m"),
+        magenta: f("\x1B[35m", "\x1B[39m"),
+        cyan: f("\x1B[36m", "\x1B[39m"),
+        white: f("\x1B[37m", "\x1B[39m"),
+        gray: f("\x1B[90m", "\x1B[39m"),
+        bgBlack: f("\x1B[40m", "\x1B[49m"),
+        bgRed: f("\x1B[41m", "\x1B[49m"),
+        bgGreen: f("\x1B[42m", "\x1B[49m"),
+        bgYellow: f("\x1B[43m", "\x1B[49m"),
+        bgBlue: f("\x1B[44m", "\x1B[49m"),
+        bgMagenta: f("\x1B[45m", "\x1B[49m"),
+        bgCyan: f("\x1B[46m", "\x1B[49m"),
+        bgWhite: f("\x1B[47m", "\x1B[49m"),
+        blackBright: f("\x1B[90m", "\x1B[39m"),
+        redBright: f("\x1B[91m", "\x1B[39m"),
+        greenBright: f("\x1B[92m", "\x1B[39m"),
+        yellowBright: f("\x1B[93m", "\x1B[39m"),
+        blueBright: f("\x1B[94m", "\x1B[39m"),
+        magentaBright: f("\x1B[95m", "\x1B[39m"),
+        cyanBright: f("\x1B[96m", "\x1B[39m"),
+        whiteBright: f("\x1B[97m", "\x1B[39m"),
+        bgBlackBright: f("\x1B[100m", "\x1B[49m"),
+        bgRedBright: f("\x1B[101m", "\x1B[49m"),
+        bgGreenBright: f("\x1B[102m", "\x1B[49m"),
+        bgYellowBright: f("\x1B[103m", "\x1B[49m"),
+        bgBlueBright: f("\x1B[104m", "\x1B[49m"),
+        bgMagentaBright: f("\x1B[105m", "\x1B[49m"),
+        bgCyanBright: f("\x1B[106m", "\x1B[49m"),
+        bgWhiteBright: f("\x1B[107m", "\x1B[49m")
+      };
+    };
+    module2.exports = createColors();
+    module2.exports.createColors = createColors;
+  }
+});
+
+// eslint-config/cli.ts
+var cli_exports = {};
+module.exports = __toCommonJS(cli_exports);
+init_cjs_shims();
+
+// eslint-config/cli/index.ts
+init_cjs_shims();
+var p5 = __toESM(require("@clack/prompts"), 1);
+var import_node_process5 = __toESM(require("process"), 1);
+var import_picocolors6 = __toESM(require_picocolors(), 1);
+var import_yargs = __toESM(require("yargs"), 1);
+var import_helpers = require("yargs/helpers");
+
+// eslint-config/cli/constants.ts
+init_cjs_shims();
+var import_picocolors = __toESM(require_picocolors(), 1);
+
+// package.json
+var package_default = {
+  name: "@solvro/config",
+  version: "1.0.3",
+  description: "Solvro's engineering style guide",
+  keywords: [
+    "eslint-config"
+  ],
+  homepage: "https://github.com/Solvro/lib-web-solvro-config#readme",
+  bugs: {
+    url: "https://github.com/Solvro/lib-web-solvro-config/issues"
+  },
+  repository: {
+    type: "git",
+    url: "git+https://github.com/Solvro/lib-web-solvro-config.git"
+  },
+  license: "MPL-2.0",
+  type: "module",
+  exports: {
+    "./eslint": {
+      import: "./dist/eslint-config/index.js",
+      require: "./dist/eslint-config/index.cjs",
+      types: "./dist/eslint-config/index.d.ts"
+    },
+    "./prettier": {
+      import: "./dist/prettier-config/index.js",
+      require: "./dist/prettier-config/index.cjs",
+      types: "./dist/prettier-config/index.d.ts"
+    }
+  },
+  bin: {
+    config: "bin/index.js"
+  },
+  files: [
+    "bin",
+    "dist"
+  ],
+  scripts: {
+    build: "npm run typegen && tsup --format esm,cjs --clean --dts",
+    dev: "npx @eslint/config-inspector --config eslint.config.ts",
+    format: "prettier --check .",
+    lint: "eslint --flag unstable_ts_config .",
+    prepare: "husky",
+    prepublish: "npm run build",
+    release: "semantic-release",
+    test: 'echo "Error: no test specified" && exit 1',
+    typecheck: "tsc --noEmit",
+    typegen: "tsx ./scripts/typegen.ts"
+  },
+  "lint-staged": {
+    "*": "prettier -w --ignore-unknown"
+  },
+  prettier: "./dist/prettier-config/index.js",
+  dependencies: {
+    "@antfu/install-pkg": "^0.5.0",
+    "@clack/prompts": "^0.8.2",
+    "@eslint-community/eslint-plugin-eslint-comments": "^4.4.1",
+    "@eslint/markdown": "^6.2.1",
+    "@rushstack/eslint-patch": "^1.10.4",
+    "@trivago/prettier-plugin-sort-imports": "^4.3.0",
+    "@typescript-eslint/eslint-plugin": "^8.16.0",
+    "@typescript-eslint/parser": "^8.16.0",
+    "@vitest/eslint-plugin": "^1.1.12",
+    "eslint-config-flat-gitignore": "^0.3.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-flat-config-utils": "^0.4.0",
+    "eslint-import-resolver-alias": "^1.1.2",
+    "eslint-import-resolver-typescript": "^3.6.3",
+    "eslint-merge-processors": "^0.1.0",
+    "eslint-plugin-antfu": "^2.7.0",
+    "eslint-plugin-command": "^0.2.6",
+    "eslint-plugin-import": "^2.31.0",
+    "eslint-plugin-jest": "^28.9.0",
+    "eslint-plugin-jsdoc": "^50.6.0",
+    "eslint-plugin-jsx-a11y": "^6.10.2",
+    "eslint-plugin-n": "^17.14.0",
+    "eslint-plugin-no-only-tests": "^3.3.0",
+    "eslint-plugin-perfectionist": "^4.1.2",
+    "eslint-plugin-playwright": "^2.1.0",
+    "eslint-plugin-react": "^7.37.2",
+    "eslint-plugin-react-hooks": "^5.0.0",
+    "eslint-plugin-regexp": "^2.7.0",
+    "eslint-plugin-testing-library": "^7.0.0",
+    "eslint-plugin-tsdoc": "^0.4.0",
+    "eslint-plugin-unicorn": "^56.0.1",
+    "eslint-plugin-unused-imports": "^4.1.4",
+    globals: "^15.12.0",
+    "parse-gitignore": "^2.0.0",
+    "prettier-plugin-packagejson": "^2.5.6",
+    "prettier-plugin-tailwindcss": "^0.6.9",
+    yargs: "^17.7.2"
+  },
+  devDependencies: {
+    "@commitlint/cli": "^19.6.0",
+    "@commitlint/config-conventional": "^19.6.0",
+    "@eslint-react/eslint-plugin": "^1.17.1",
+    "@eslint/config-inspector": "^0.5.6",
+    "@semantic-release/git": "^10.0.1",
+    "@types/yargs": "^17.0.33",
+    eslint: "^9.15.0",
+    "eslint-plugin-format": "^0.1.2",
+    "eslint-plugin-react-hooks": "^5.0.0",
+    "eslint-plugin-react-refresh": "^0.4.14",
+    "eslint-typegen": "^0.3.2",
+    husky: "^9.1.7",
+    jiti: "^2.4.1",
+    "lint-staged": "^15.2.10",
+    prettier: "^3.4.1",
+    "semantic-release": "^24.2.0",
+    tsup: "^8.3.5",
+    tsx: "^4.19.2",
+    typescript: "^5.7.2"
+  },
+  peerDependencies: {
+    "@next/eslint-plugin-next": ">=12.3.0 <16.0.0-0",
+    eslint: ">=9.0.0 <10",
+    prettier: ">=3.0.0 <4",
+    typescript: ">=4.8.0 <6"
+  },
+  peerDependenciesMeta: {
+    "@eslint-react/eslint-plugin": {
+      optional: true
+    },
+    "@unocss/eslint-plugin": {
+      optional: true
+    },
+    "eslint-plugin-react-hooks": {
+      optional: true
+    },
+    "eslint-plugin-react-refresh": {
+      optional: true
+    }
+  },
+  packageManager: "npm@10.9.1",
+  engines: {
+    node: ">=20"
+  },
+  publishConfig: {
+    access: "public"
+  }
+};
+
+// eslint-config/cli/constants.ts
+var vscodeSettingsString = `
+  "prettier.enable": true,
+  "editor.formatOnSave": true,
+`;
+var frameworkOptions = [
+  {
+    label: import_picocolors.default.cyan("React"),
+    value: "react"
+  }
+];
+var frameworks = frameworkOptions.map(
+  ({ value }) => value
+);
+var dependenciesMap = {
+  react: [
+    "@eslint-react/eslint-plugin",
+    "eslint-plugin-react-hooks",
+    "eslint-plugin-react-refresh"
+  ]
+};
+
+// eslint-config/cli/run.ts
+init_cjs_shims();
+var p4 = __toESM(require("@clack/prompts"), 1);
+var import_node_fs3 = __toESM(require("fs"), 1);
+var import_node_path4 = __toESM(require("path"), 1);
+var import_node_process4 = __toESM(require("process"), 1);
+var import_picocolors5 = __toESM(require_picocolors(), 1);
+
+// eslint-config/cli/stages/update-eslint-files.ts
+init_cjs_shims();
+var p = __toESM(require("@clack/prompts"), 1);
+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_parse_gitignore = __toESM(require("parse-gitignore"), 1);
+var import_picocolors2 = __toESM(require_picocolors(), 1);
+
+// eslint-config/cli/utils.ts
+init_cjs_shims();
+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 {
+    return false;
+  }
+}
+function getEslintConfigContent(mainConfig, additionalConfigs) {
+  return `
+import solvro from '@solvro/config'
+
+export default solvro({
+${mainConfig}
+}${additionalConfigs?.map((config) => `,{
+${config}
+}`)})
+`.trimStart();
+}
+
+// eslint-config/cli/stages/update-eslint-files.ts
+async function updateEslintFiles(result) {
+  const cwd = import_node_process.default.cwd();
+  const pathESLintIgnore = import_node_path.default.join(cwd, ".eslintignore");
+  const pathPackageJSON = import_node_path.default.join(cwd, "package.json");
+  const pkgContent = await import_promises.default.readFile(pathPackageJSON, "utf-8");
+  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);
+  const eslintIgnores = [];
+  if (import_node_fs.default.existsSync(pathESLintIgnore)) {
+    p.log.step(import_picocolors2.default.cyan(`Migrating existing .eslintignore`));
+    const content = await import_promises.default.readFile(pathESLintIgnore, "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}`)
+        );
+    }
+  }
+  const configLines = [];
+  if (eslintIgnores.length)
+    configLines.push(`ignores: ${JSON.stringify(eslintIgnores)},`);
+  for (const framework of result.frameworks)
+    configLines.push(`${framework}: true,`);
+  const mainConfig = configLines.map((i) => `  ${i}`).join("\n");
+  const additionalConfig = [];
+  const eslintConfigContent = getEslintConfigContent(
+    mainConfig,
+    additionalConfig
+  );
+  await import_promises.default.writeFile(pathFlatConfig, eslintConfigContent);
+  p.log.success(import_picocolors2.default.green(`Created ${configFileName}`));
+  const files = import_node_fs.default.readdirSync(cwd);
+  const legacyConfig = [];
+  files.forEach((file) => {
+    if (/eslint|prettier/.test(file) && !/eslint\.config\./.test(file))
+      legacyConfig.push(file);
+  });
+  if (legacyConfig.length)
+    p.note(
+      `${import_picocolors2.default.dim(legacyConfig.join(", "))}`,
+      "You can now remove those files manually"
+    );
+}
+
+// eslint-config/cli/stages/update-package-json.ts
+init_cjs_shims();
+var p2 = __toESM(require("@clack/prompts"), 1);
+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_picocolors3 = __toESM(require_picocolors(), 1);
+async function updatePackageJson(result) {
+  const cwd = import_node_process2.default.cwd();
+  const pathPackageJSON = import_node_path2.default.join(cwd, "package.json");
+  p2.log.step(import_picocolors3.default.cyan(`Bumping @solvro/config to v${package_default.version}`));
+  const pkgContent = await import_promises2.default.readFile(pathPackageJSON, "utf-8");
+  const pkg = JSON.parse(pkgContent);
+  pkg.devDependencies ??= {};
+  pkg.devDependencies["@solvro/config"] = `^${package_default.version}`;
+  pkg.devDependencies.eslint ??= package_default.devDependencies.eslint.replace("npm:eslint-ts-patch@", "").replace(/-\d+$/, "");
+  const addedPackages = [];
+  for (const framework of result.frameworks) {
+    const deps = dependenciesMap[framework];
+    if (deps) {
+      deps.forEach((f) => {
+        pkg.devDependencies[f] = package_default.devDependencies[f];
+        addedPackages.push(f);
+      });
+    }
+  }
+  if (addedPackages.length)
+    p2.note(`${import_picocolors3.default.dim(addedPackages.join(", "))}`, "Added packages");
+  await import_promises2.default.writeFile(pathPackageJSON, JSON.stringify(pkg, null, 2));
+  p2.log.success(import_picocolors3.default.green(`Changes wrote to package.json`));
+}
+
+// eslint-config/cli/stages/update-vscode-settings.ts
+init_cjs_shims();
+var p3 = __toESM(require("@clack/prompts"), 1);
+var import_node_fs2 = __toESM(require("fs"), 1);
+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_picocolors4 = __toESM(require_picocolors(), 1);
+async function updateVscodeSettings(result) {
+  const cwd = import_node_process3.default.cwd();
+  if (!result.updateVscodeSettings) return;
+  const dotVscodePath = import_node_path3.default.join(cwd, ".vscode");
+  const settingsPath = import_node_path3.default.join(dotVscodePath, "settings.json");
+  if (!import_node_fs2.default.existsSync(dotVscodePath))
+    await import_promises3.default.mkdir(dotVscodePath, { recursive: true });
+  if (!import_node_fs2.default.existsSync(settingsPath)) {
+    await import_promises3.default.writeFile(settingsPath, `{${vscodeSettingsString}}
+`, "utf-8");
+    p3.log.success(import_picocolors4.default.green(`Created .vscode/settings.json`));
+  } else {
+    let settingsContent = await import_promises3.default.readFile(settingsPath, "utf8");
+    settingsContent = settingsContent.trim().replace(/\s*\}$/, "");
+    settingsContent += settingsContent.endsWith(",") || settingsContent.endsWith("{") ? "" : ",";
+    settingsContent += `${vscodeSettingsString}}
+`;
+    await import_promises3.default.writeFile(settingsPath, settingsContent, "utf-8");
+    p3.log.success(import_picocolors4.default.green(`Updated .vscode/settings.json`));
+  }
+}
+
+// eslint-config/cli/run.ts
+async function run(options = {}) {
+  const argSkipPrompt = !!import_node_process4.default.env.SKIP_PROMPT || options.yes;
+  const argTemplate = options.frameworks?.map(
+    (m) => m.trim()
+  );
+  if (import_node_fs3.default.existsSync(import_node_path4.default.join(import_node_process4.default.cwd(), "eslint.config.js"))) {
+    p4.log.warn(
+      import_picocolors5.default.yellow(`eslint.config.js already exists, migration wizard exited.`)
+    );
+    return import_node_process4.default.exit(1);
+  }
+  let result = {
+    frameworks: argTemplate ?? [],
+    uncommittedConfirmed: false,
+    updateVscodeSettings: true
+  };
+  if (!argSkipPrompt) {
+    result = await p4.group(
+      {
+        uncommittedConfirmed: () => {
+          if (argSkipPrompt || isGitClean()) return Promise.resolve(true);
+          return p4.confirm({
+            initialValue: false,
+            message: "There are uncommitted changes in the current repository, are you sure to continue?"
+          });
+        },
+        frameworks: ({ results }) => {
+          const isArgTemplateValid = typeof argTemplate === "string" && !!frameworks.includes(argTemplate);
+          if (!results.uncommittedConfirmed || isArgTemplateValid) return;
+          const message = !isArgTemplateValid && argTemplate ? `"${argTemplate}" isn't a valid template. Please choose from below: ` : "Select a framework:";
+          return p4.multiselect({
+            message: import_picocolors5.default.reset(message),
+            options: frameworkOptions,
+            required: false
+          });
+        },
+        updateVscodeSettings: ({ results }) => {
+          if (!results.uncommittedConfirmed) return;
+          return p4.confirm({
+            initialValue: true,
+            message: "Update .vscode/settings.json for better VS Code experience?"
+          });
+        }
+      },
+      {
+        onCancel: () => {
+          p4.cancel("Operation cancelled.");
+          import_node_process4.default.exit(0);
+        }
+      }
+    );
+    if (!result.uncommittedConfirmed) return import_node_process4.default.exit(1);
+  }
+  await updatePackageJson(result);
+  await updateEslintFiles(result);
+  await updateVscodeSettings(result);
+  p4.log.success(import_picocolors5.default.green(`Setup completed`));
+  p4.outro(
+    `Now you can update the dependencies by run ${import_picocolors5.default.blue("pnpm install")} and run ${import_picocolors5.default.blue("eslint . --fix")}
+`
+  );
+}
+
+// eslint-config/cli/index.ts
+function header() {
+  console.log("\n");
+  p5.intro(`${import_picocolors6.default.green(`@solvro/config `)}${import_picocolors6.default.dim(`v${package_default.version}`)}`);
+}
+var instance = (0, import_yargs.default)((0, import_helpers.hideBin)(import_node_process5.default.argv)).scriptName("@solvro/config").usage("").command(
+  "*",
+  "Run the initialization or migration",
+  (args) => args.option("yes", {
+    alias: "y",
+    description: "Skip prompts and use default values",
+    type: "boolean"
+  }).option("template", {
+    alias: "t",
+    description: "Use the framework template for optimal customization: react",
+    type: "string"
+  }).help(),
+  async (args) => {
+    header();
+    try {
+      await run(args);
+    } catch (error) {
+      p5.log.error(import_picocolors6.default.inverse(import_picocolors6.default.red(" Failed to migrate ")));
+      p5.log.error(import_picocolors6.default.red(`\u2718 ${String(error)}`));
+      import_node_process5.default.exit(1);
+    }
+  }
+).showHelpOnFail(false).alias("h", "help").version("version", package_default.version).alias("v", "version");
+instance.help().argv;

package/dist/eslint-config/cli.d.cts

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

package/dist/eslint-config/cli.d.ts

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