@whoj/eslint-config 2.2.1 → 2.3.0

package/README.md

@@ -45,16 +45,16 @@ const compat = new FlatCompat();
 
 export default whoj(
   {
-    ignores: []
+    ignores: [],
   },
 
   // Legacy config
   ...compat.config({
     extends: [
-      'eslint:recommended'
+      'eslint:recommended',
       // Other extends...
-    ]
-  })
+    ],
+  }),
 
   // Other flat configs...
 );
@@ -152,31 +152,31 @@ You can configure each integration individually, for example:
 import whoj from '@whoj/eslint-config';
 
 export default whoj({
-// Type of the project. 'lib' for libraries, the default is 'app'
-  type: 'lib',
+  vue: true,
 
   // Enable stylistic formatting rules
   // stylistic: true,
 
-  // Or customize the stylistic rules
-  stylistic: {
-    indent: 2, // 4, or 'tab'
-    quotes: 'single' // or 'double'
-  },
-
-  // TypeScript and Vue are autodetected, you can also explicitly enable them:
-  typescript: true,
-  vue: true,
+  // Type of the project. 'lib' for libraries, the default is 'app'
+  type: 'lib',
 
+  yaml: false,
   // Disable jsonc and yaml support
   jsonc: false,
-  yaml: false,
 
+  // TypeScript and Vue are autodetected, you can also explicitly enable them:
+  typescript: true,
   // `.eslintignore` is no longer supported in Flat config, use `ignores` instead
   ignores: [
-    '**/fixtures'
+    '**/fixtures',
     // ...globs
-  ]
+  ],
+
+  // Or customize the stylistic rules
+  stylistic: {
+    indent: 2, // 4, or 'tab'
+    quotes: 'single', // or 'double'
+  },
 });
 ```
 
@@ -194,12 +194,12 @@ export default whoj(
   // From the second arguments they are ESLint Flat Configs
   // you can have multiple configs
   {
+    rules: {},
     files: ['**/*.ts'],
-    rules: {}
   },
   {
-    rules: {}
-  }
+    rules: {},
+  },
 );
 ```
 

package/dist/cli.js

@@ -1,28 +1,18 @@
-import {
-  init_esm_shims
-} from "./chunk-MKNYKNDN.js";
-
-// src/cli.ts
-init_esm_shims();
-
 // src/cli/index.ts
-init_esm_shims();
 import yargs from "yargs";
-import c6 from "picocolors";
-import process5 from "node:process";
-import * as p5 from "@clack/prompts";
+import c7 from "picocolors";
+import process6 from "node:process";
+import * as p6 from "@clack/prompts";
 import { hideBin } from "yargs/helpers";
 
 // src/cli/run.ts
-init_esm_shims();
-import fs3 from "node:fs";
-import c5 from "picocolors";
-import path4 from "node:path";
-import process4 from "node:process";
-import * as p4 from "@clack/prompts";
+import fs4 from "node:fs";
+import c6 from "picocolors";
+import path5 from "node:path";
+import process5 from "node:process";
+import * as p5 from "@clack/prompts";
 
 // src/cli/utils.ts
-init_esm_shims();
 import { execSync } from "node:child_process";
 function isGitClean() {
   try {
@@ -32,20 +22,29 @@ function isGitClean() {
     return false;
   }
 }
+function getJetbrainsEslintConfigContent(configFrom) {
+  return `
+import { whoj } from '@whoj/eslint-config';
+import _defaults from "${configFrom}";
+
+export default whoj({
+  isInEditor: true
+}).append(_defaults);
+`.trimStart();
+}
 function getEslintConfigContent(mainConfig, additionalConfigs) {
   return `
-import whoj from '@whoj/eslint-config'
+import whoj from '@whoj/eslint-config';
 
 export default whoj({
 ${mainConfig}
 }${additionalConfigs?.map((config) => `,{
 ${config}
-}`)})
+}`)});
 `.trimStart();
 }
 
 // src/cli/stages/update-eslint-files.ts
-init_esm_shims();
 import fs from "node:fs";
 import c from "picocolors";
 import path from "node:path";
@@ -96,10 +95,10 @@ async function updateEslintFiles(result) {
   });
   if (legacyConfig.length)
     p.note(`${c.dim(legacyConfig.join(", "))}`, "You can now remove those files manually");
+  return pathFlatConfig;
 }
 
 // src/cli/stages/update-package-json.ts
-init_esm_shims();
 import c3 from "picocolors";
 import path2 from "node:path";
 import fsp2 from "node:fs/promises";
@@ -107,14 +106,13 @@ import process2 from "node:process";
 import * as p2 from "@clack/prompts";
 
 // src/cli/constants.ts
-init_esm_shims();
 import c2 from "picocolors";
 
 // package.json
 var package_default = {
   name: "@whoj/eslint-config",
   type: "module",
-  version: "2.2.1",
+  version: "2.3.0",
   packageManager: "pnpm@10.2.1",
   description: "ESLint config",
   license: "MIT",
@@ -148,12 +146,16 @@ var package_default = {
     prepare: "simple-git-hooks"
   },
   peerDependencies: {
+    "@nuxt/eslint-config": "^1.0.1",
     "@prettier/plugin-xml": "^3.4.1",
     "@unocss/eslint-plugin": ">=0.50.0",
     eslint: "^9.19.0",
     "eslint-plugin-format": ">=0.1.0"
   },
   peerDependenciesMeta: {
+    "@nuxt/eslint-config": {
+      optional: true
+    },
     "@prettier/plugin-xml": {
       optional: true
     },
@@ -172,7 +174,6 @@ var package_default = {
     "@clack/prompts": "^0.9.1",
     "@eslint-community/eslint-plugin-eslint-comments": "^4.4.1",
     "@eslint/markdown": "^6.2.2",
-    "@nuxt/eslint-config": "^1.0.1",
     "@stylistic/eslint-plugin": "^3.0.1",
     "@typescript-eslint/eslint-plugin": "^8.22.0",
     "@typescript-eslint/parser": "^8.22.0",
@@ -195,6 +196,7 @@ var package_default = {
     "eslint-plugin-vue": "^9.32.0",
     "eslint-plugin-yml": "^1.16.0",
     "eslint-processor-vue-blocks": "^1.0.0",
+    "fast-xml-parser": "^4.5.1",
     globals: "^15.14.0",
     "jsonc-eslint-parser": "^2.4.0",
     "local-pkg": "^1.0.0",
@@ -209,6 +211,7 @@ var package_default = {
     "@antfu/ni": "^23.3.1",
     "@eslint-react/eslint-plugin": "^1.26.2",
     "@eslint/config-inspector": "^1.0.0",
+    "@nuxt/eslint-config": "^1.0.1",
     "@prettier/plugin-xml": "^3.4.1",
     "@stylistic/eslint-plugin-migrate": "^3.0.1",
     "@types/fs-extra": "^11.0.4",
@@ -235,7 +238,6 @@ var package_default = {
     "prettier-plugin-astro": "^0.14.1",
     "prettier-plugin-slidev": "^1.0.5",
     rimraf: "^6.0.1",
-    sass: "^1.84.0",
     "simple-git-hooks": "^2.11.1",
     svelte: "^5.19.9",
     "svelte-eslint-parser": "^0.43.0",
@@ -266,6 +268,15 @@ var package_default = {
 };
 
 // src/cli/constants.ts
+var jetbrainsSettingsObj = {
+  "?xml": { version: "1.0", encoding: "UTF-8" },
+  "project": { version: "4", component: {
+    "name": "EslintConfiguration",
+    "extra-options": { value: "--cache" },
+    "option": { value: "true", name: "fix-on-save" },
+    "custom-configuration-file": { used: "true", path: "$PROJECT_DIR$/eslint.config.js" }
+  } }
+};
 var vscodeSettingsString = `
   // Disable the default formatter, use eslint instead
   "prettier.enable": false,
@@ -319,64 +330,71 @@ var vscodeSettingsString = `
 `;
 var frameworkOptions = [
   {
-    label: c2.green("Vue"),
-    value: "vue"
+    value: "vue",
+    label: c2.green("Vue")
+  },
+  {
+    value: "nuxt",
+    label: c2.green("Nuxt")
   },
   {
-    label: c2.cyan("React"),
-    value: "react"
+    value: "react",
+    label: c2.cyan("React")
   },
   {
-    label: c2.red("Svelte"),
-    value: "svelte"
+    value: "svelte",
+    label: c2.red("Svelte")
   },
   {
-    label: c2.magenta("Astro"),
-    value: "astro"
+    value: "astro",
+    label: c2.magenta("Astro")
   },
   {
-    label: c2.cyan("Solid"),
-    value: "solid"
+    value: "solid",
+    label: c2.cyan("Solid")
   },
   {
-    label: c2.blue("Slidev"),
-    value: "slidev"
+    value: "slidev",
+    label: c2.blue("Slidev")
   }
 ];
 var frameworks = frameworkOptions.map(({ value }) => value);
 var extraOptions = [
   {
-    hint: "Use external formatters (Prettier and/or dprint) to format files that ESLint cannot handle yet (.css, .html, etc)",
+    value: "formatter",
     label: c2.red("Formatter"),
-    value: "formatter"
+    hint: "Use external formatters (Prettier and/or dprint) to format files that ESLint cannot handle yet (.css, .html, etc)"
   },
   {
-    label: c2.cyan("UnoCSS"),
-    value: "unocss"
+    value: "unocss",
+    label: c2.cyan("UnoCSS")
   }
 ];
 var extra = extraOptions.map(({ value }) => value);
 var dependenciesMap = {
-  astro: [
-    "eslint-plugin-astro",
-    "astro-eslint-parser"
+  vue: [],
+  nuxt: [
+    "@nuxt/eslint-config"
   ],
-  react: [
-    "@eslint-react/eslint-plugin",
-    "eslint-plugin-react-hooks",
-    "eslint-plugin-react-refresh"
+  solid: [
+    "eslint-plugin-solid"
   ],
   slidev: [
     "prettier-plugin-slidev"
   ],
-  solid: [
-    "eslint-plugin-solid"
+  astro: [
+    "eslint-plugin-astro",
+    "astro-eslint-parser"
   ],
   svelte: [
     "eslint-plugin-svelte",
     "svelte-eslint-parser"
   ],
-  vue: []
+  react: [
+    "@eslint-react/eslint-plugin",
+    "eslint-plugin-react-hooks",
+    "eslint-plugin-react-refresh"
+  ]
 };
 
 // src/cli/stages/update-package-json.ts
@@ -393,21 +411,21 @@ async function updatePackageJson(result) {
   if (result.extra.length) {
     result.extra.forEach((item) => {
       switch (item) {
-        case "formatter":
+        case "unocss":
           [
-            "eslint-plugin-format",
-            result.frameworks.includes("astro") ? "prettier-plugin-astro" : null
+            "@unocss/eslint-plugin"
           ].forEach((f) => {
-            if (!f)
-              return;
             pkg.devDependencies[f] = package_default.devDependencies[f];
             addedPackages.push(f);
           });
           break;
-        case "unocss":
+        case "formatter":
           [
-            "@unocss/eslint-plugin"
+            "eslint-plugin-format",
+            result.frameworks.includes("astro") ? "prettier-plugin-astro" : null
           ].forEach((f) => {
+            if (!f)
+              return;
             pkg.devDependencies[f] = package_default.devDependencies[f];
             addedPackages.push(f);
           });
@@ -430,58 +448,129 @@ async function updatePackageJson(result) {
   p2.log.success(c3.green("Changes wrote to package.json"));
 }
 
-// src/cli/stages/update-vscode-settings.ts
-init_esm_shims();
+// src/cli/stages/update-jetbrains-idea.ts
 import fs2 from "node:fs";
 import c4 from "picocolors";
 import path3 from "node:path";
 import fsp3 from "node:fs/promises";
 import process3 from "node:process";
 import * as p3 from "@clack/prompts";
-async function updateVscodeSettings(result) {
+import { deepMergeWithArray } from "@antfu/utils";
+import { XMLParser, XMLBuilder } from "fast-xml-parser";
+async function updateJetbrainsIdea(result, flatConfigPath) {
   const cwd = process3.cwd();
-  if (!result.updateVscodeSettings)
+  if (!result.updateJetbrainsIdea)
     return;
-  const dotVscodePath = path3.join(cwd, ".vscode");
-  const settingsPath = path3.join(dotVscodePath, "settings.json");
-  if (!fs2.existsSync(dotVscodePath))
-    await fsp3.mkdir(dotVscodePath, { recursive: true });
+  const dotIdeaPath = path3.join(cwd, ".idea/jsLinters");
+  const settingsPath = path3.join(dotIdeaPath, "eslint.xml");
+  const ideaFlatConfigPath = path3.join(dotIdeaPath, path3.basename(flatConfigPath));
+  const xmlParserOptions = {
+    attributeNamePrefix: "",
+    ignoreAttributes: false,
+    unpairedTags: [
+      "option",
+      "extra-options",
+      "work-dir-patterns",
+      "additional-rules-dir",
+      "custom-configuration-file"
+    ]
+  };
+  const xmlBuilderOptions = {
+    format: true,
+    ...xmlParserOptions,
+    suppressUnpairedNode: false,
+    suppressBooleanAttributes: false
+  };
+  const builder = new XMLBuilder(xmlBuilderOptions);
+  if (!fs2.existsSync(dotIdeaPath)) {
+    await fsp3.mkdir(dotIdeaPath, { recursive: true });
+  }
+  await fsp3.writeFile(
+    ideaFlatConfigPath,
+    getJetbrainsEslintConfigContent(flatConfigPath),
+    "utf8"
+  );
+  p3.log.success(c4.green(`Created ${path3.relative(cwd, ideaFlatConfigPath)}`));
+  const ideaSettingsObject = deepMergeWithArray(
+    jetbrainsSettingsObj,
+    {
+      project: {
+        component: {
+          "custom-configuration-file": {
+            used: "true",
+            path: `$PROJECT_DIR$/.idea/jsLinters/${path3.basename(flatConfigPath)}`
+          }
+        }
+      }
+    }
+  );
   if (!fs2.existsSync(settingsPath)) {
-    await fsp3.writeFile(settingsPath, `{${vscodeSettingsString}}
+    await fsp3.writeFile(settingsPath, builder.build(ideaSettingsObject), "utf8");
+    p3.log.success(c4.green("Created .idea/jsLinters/eslint.xml"));
+  } else {
+    const ideaSettingsContent = await fsp3.readFile(settingsPath, "utf8");
+    const parser = new XMLParser(xmlParserOptions);
+    const ideaXml = deepMergeWithArray(
+      parser.parse(ideaSettingsContent),
+      jetbrainsSettingsObj
+    );
+    await fsp3.writeFile(settingsPath, builder.build(ideaXml), "utf8");
+    p3.log.success(c4.green("Updated .idea/jsLinters/eslint.xml"));
+  }
+}
+
+// src/cli/stages/update-vscode-settings.ts
+import fs3 from "node:fs";
+import c5 from "picocolors";
+import path4 from "node:path";
+import fsp4 from "node:fs/promises";
+import process4 from "node:process";
+import * as p4 from "@clack/prompts";
+async function updateVscodeSettings(result) {
+  const cwd = process4.cwd();
+  if (!result.updateVscodeSettings)
+    return;
+  const dotVscodePath = path4.join(cwd, ".vscode");
+  const settingsPath = path4.join(dotVscodePath, "settings.json");
+  if (!fs3.existsSync(dotVscodePath))
+    await fsp4.mkdir(dotVscodePath, { recursive: true });
+  if (!fs3.existsSync(settingsPath)) {
+    await fsp4.writeFile(settingsPath, `{${vscodeSettingsString}}
 `, "utf-8");
-    p3.log.success(c4.green("Created .vscode/settings.json"));
+    p4.log.success(c5.green("Created .vscode/settings.json"));
   } else {
-    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, "utf-8");
-    p3.log.success(c4.green("Updated .vscode/settings.json"));
+    await fsp4.writeFile(settingsPath, settingsContent, "utf-8");
+    p4.log.success(c5.green("Updated .vscode/settings.json"));
   }
 }
 
 // src/cli/run.ts
-async function run(options = {}) {
-  const argSkipPrompt = !!process4.env.SKIP_PROMPT || options.yes;
+async function run({ jetbrains, vscode, ...options } = {}) {
+  const argSkipPrompt = !!process5.env.SKIP_PROMPT || options.yes;
   const argTemplate = options.frameworks?.map((m) => m.trim());
   const argExtra = options.extra?.map((m) => m.trim());
-  if (fs3.existsSync(path4.join(process4.cwd(), "eslint.config.js"))) {
-    p4.log.warn(c5.yellow("eslint.config.js already exists, migration wizard exited."));
-    return process4.exit(1);
+  if (fs4.existsSync(path5.join(process5.cwd(), "eslint.config.js"))) {
+    p5.log.warn(c6.yellow("eslint.config.js already exists, migration wizard exited."));
+    return process5.exit(1);
   }
   let result = {
     extra: argExtra ?? [],
     frameworks: argTemplate ?? [],
     uncommittedConfirmed: false,
-    updateVscodeSettings: true
+    updateVscodeSettings: vscode ?? true,
+    updateJetbrainsIdea: jetbrains ?? true
   };
   if (!argSkipPrompt) {
-    result = await p4.group({
+    result = await p5.group({
       uncommittedConfirmed: () => {
         if (argSkipPrompt || isGitClean())
           return Promise.resolve(true);
-        return p4.confirm({
+        return p5.confirm({
           initialValue: false,
           message: "There are uncommitted changes in the current repository, are you sure to continue?"
         });
@@ -491,8 +580,8 @@ async function run(options = {}) {
         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: c5.reset(message),
+        return p5.multiselect({
+          message: c6.reset(message),
           options: frameworkOptions,
           required: false
         });
@@ -502,67 +591,89 @@ async function run(options = {}) {
         if (!results.uncommittedConfirmed || isArgExtraValid)
           return;
         const message = !isArgExtraValid && argExtra ? `"${argExtra}" isn't a valid extra util. Please choose from below: ` : "Select a extra utils:";
-        return p4.multiselect({
-          message: c5.reset(message),
+        return p5.multiselect({
+          message: c6.reset(message),
           options: extraOptions,
           required: false
         });
       },
+      updateJetbrainsIdea: ({ results }) => {
+        if (!results.uncommittedConfirmed)
+          return;
+        return p5.confirm({
+          initialValue: true,
+          message: "Update JetBrain IDE's eslint configuration for better experience WebStorm / PhpStorm?"
+        });
+      },
       updateVscodeSettings: ({ results }) => {
         if (!results.uncommittedConfirmed)
           return;
-        return p4.confirm({
+        return p5.confirm({
           initialValue: true,
           message: "Update .vscode/settings.json for better VS Code experience?"
         });
       }
     }, {
       onCancel: () => {
-        p4.cancel("Operation cancelled.");
-        process4.exit(0);
+        p5.cancel("Operation cancelled.");
+        process5.exit(0);
       }
     });
     if (!result.uncommittedConfirmed)
-      return process4.exit(1);
+      return process5.exit(1);
   }
   await updatePackageJson(result);
-  await updateEslintFiles(result);
+  const configFileName = await updateEslintFiles(result);
+  await updateJetbrainsIdea(
+    result,
+    configFileName
+  );
   await updateVscodeSettings(result);
-  p4.log.success(c5.green("Setup completed"));
-  p4.outro(`Now you can update the dependencies by run ${c5.blue("pnpm install")} and run ${c5.blue("eslint . --fix")}
+  p5.log.success(c6.green("Setup completed"));
+  p5.outro(`Now you can update the dependencies by run ${c6.blue("pnpm install")} and run ${c6.blue("eslint . --fix")}
 `);
 }
 
 // src/cli/index.ts
 function header() {
   console.log("\n");
-  p5.intro(`${c6.green("@whoj/eslint-config ")}${c6.dim(`v${package_default.version}`)}`);
+  p6.intro(`${c7.green("@whoj/eslint-config ")}${c7.dim(`v${package_default.version}`)}`);
 }
-var instance = yargs(hideBin(process5.argv)).scriptName("@whoj/eslint-config").usage("").command(
+var instance = yargs(hideBin(process6.argv)).scriptName("@whoj/eslint-config").usage("").command(
   "*",
   "Run the initialization or migration",
   (args) => args.option("yes", {
     alias: "y",
-    description: "Skip prompts and use default values",
-    type: "boolean"
+    type: "boolean",
+    description: "Skip prompts and use default values"
+  }).option("jetbrains", {
+    default: true,
+    type: "boolean",
+    alias: ["idea", "j"],
+    description: "Configure eslint settings for better Jetbrains IDE. (WebStorm / PhpStorm) experience."
+  }).option("vscode", {
+    default: true,
+    type: "boolean",
+    alias: ["c", "code"],
+    description: "Add/Update .vscode/settings.json for better VS Code experience."
   }).option("template", {
     alias: "t",
-    description: "Use the framework template for optimal customization: vue / react / svelte / astro",
-    type: "string"
+    type: "string",
+    description: "Use the framework template for optimal customization: vue / nuxt / react / svelte / astro"
   }).option("extra", {
     alias: "e",
     array: true,
-    description: "Use the extra utils: formatter / perfectionist / unocss",
-    type: "string"
+    type: "string",
+    description: "Use the extra utils: formatter / perfectionist / unocss"
   }).help(),
   async (args) => {
     header();
     try {
       await run(args);
     } catch (error) {
-      p5.log.error(c6.inverse(c6.red(" Failed to migrate ")));
-      p5.log.error(c6.red(`\u2718 ${String(error)}`));
-      process5.exit(1);
+      p6.log.error(c7.inverse(c7.red(" Failed to migrate ")));
+      p6.log.error(c7.red(`\u2718 ${String(error)}`));
+      process6.exit(1);
     }
   }
 ).showHelpOnFail(false).alias("h", "help").version("version", package_default.version).alias("v", "version");