@valbuild/init 0.69.1 → 0.71.0

package/main/dist/valbuild-init-main.esm.js

@@ -492,7 +492,7 @@ function transformNextAppRouterValProvider(fileInfo, api, options) {
 
 var packageJson = {
 	name: "@valbuild/init",
-	version: "0.69.1",
+	version: "0.71.0",
 	description: "Initialize a new val.build project",
 	exports: {
 		"./main": {
@@ -591,6 +591,15 @@ function info(message) {
   console.log(message);
 }
 
+function addEslintPluginToEslintMjs(fileInfo, api, options) {
+  if (!options.configImportPath) {
+    throw new Error("configImportPath is required");
+  }
+  var root = api.jscodeshift(fileInfo.source);
+  root.findVariableDeclarators("eslintConfig").find(j.ArrayExpression).find(j.SpreadElement).find(j.CallExpression).find(j.Literal).at(-1).insertAfter(j.literal("plugin:@valbuild/recommended"));
+  return root.toSource();
+}
+
 var MIN_VAL_VERSION = packageJson.version;
 var MIN_NEXT_VERSION = "13.4.0";
 var maxResetLength = 0;
@@ -727,6 +736,16 @@ var analyze = /*#__PURE__*/function () {
               analysis.isValEslintRulesConfigured = analysis.eslintRcJsText.includes("plugin:@valbuild/recommended");
             }
           }
+          analysis.eslintRcMjsPath = files.find(function (file) {
+            return file.endsWith("eslint.config.mjs");
+          });
+          if (analysis.eslintRcMjsPath) {
+            analysis.eslintRcMjsText = fs.readFileSync(analysis.eslintRcMjsPath, "utf8");
+            if (analysis.eslintRcMjsText) {
+              // TODO: Evaluate and extract config?
+              analysis.isValEslintRulesConfigured = analysis.eslintRcMjsText.includes("@valbuild");
+            }
+          }
           analysis.eslintRcJsonPath = files.find(function (file) {
             return file.endsWith(".eslintrc.json");
           }) || files.find(function (file) {
@@ -764,15 +783,15 @@ var analyze = /*#__PURE__*/function () {
             analysis.appRouterPath = path.dirname(appRouterLayoutPath);
             analysis.srcDir = path.dirname(analysis.appRouterPath);
           }
-          _context.prev = 34;
+          _context.prev = 36;
           git = simpleGit(root);
-          _context.next = 38;
+          _context.next = 40;
           return git.status([]);
-        case 38:
+        case 40:
           gitStatus = _context.sent;
-          _context.next = 41;
+          _context.next = 43;
           return git.remote(["-v"]);
-        case 41:
+        case 43:
           gitRemoteOrigin = _context.sent;
           analysis.hasGit = true;
           analysis.isGitHub = gitRemoteOrigin ? !!gitRemoteOrigin.includes("github.com") : false;
@@ -788,21 +807,21 @@ var analyze = /*#__PURE__*/function () {
               repo: repo
             };
           }
-          _context.next = 50;
+          _context.next = 52;
           break;
-        case 48:
-          _context.prev = 48;
-          _context.t1 = _context["catch"](34);
         case 50:
+          _context.prev = 50;
+          _context.t1 = _context["catch"](36);
+        case 52:
           gitIgnorePath = path.join(root, ".gitignore");
           analysis.gitIgnorePath = gitIgnorePath;
           analysis.gitIgnoreFile = fs.readFileSync(gitIgnorePath, "utf-8");
           return _context.abrupt("return", analysis);
-        case 54:
+        case 56:
         case "end":
           return _context.stop();
       }
-    }, _callee, null, [[8, 19], [34, 48]]);
+    }, _callee, null, [[8, 19], [36, 50]]);
   }));
   return function analyze(_x, _x2) {
     return _ref2.apply(this, arguments);
@@ -850,8 +869,13 @@ function _plan() {
       _answer9,
       currentEslintRc,
       parsedEslint,
+      _res,
+      _diff,
+      _s,
       _answer10,
       _answer11,
+      _answer12,
+      _answer13,
       vscodeDir,
       settingsPath,
       currentSettings,
@@ -1418,7 +1442,7 @@ function _plan() {
             warn(NO_PATCH_WARNING);
           }
           if (!analysis.valEslintVersion) {
-            _context3.next = 246;
+            _context3.next = 279;
             break;
           }
           if (!analysis.isValEslintRulesConfigured) {
@@ -1426,53 +1450,58 @@ function _plan() {
             break;
           }
           warn("  @valbuild/eslint-plugin rules: already configured");
-          _context3.next = 246;
+          _context3.next = 279;
           break;
         case 220:
           if (!analysis.eslintRcJsPath) {
-            _context3.next = 224;
+            _context3.next = 225;
             break;
           }
-          warn('Cannot patch eslint: found .eslintrc.js but can only patch JSON files (at the moment).\nAdd the following to your eslint config:\n\n  "extends": ["plugin:@valbuild/recommended"]\n');
-          _context3.next = 246;
+          _context3.next = 223;
+          return confirm({
+            message: ' Cannot patch eslint: found .eslintrc.js but can only patch JSON files (at the moment).\nAdd the following to your eslint config:\n\n  "extends": ["plugin:@valbuild/recommended"]\n\n',
+            "default": true
+          });
+        case 223:
+          _context3.next = 279;
           break;
-        case 224:
+        case 225:
           if (!analysis.eslintRcJsonPath) {
-            _context3.next = 245;
+            _context3.next = 246;
             break;
           }
           if (defaultAnswers) {
-            _context3.next = 231;
+            _context3.next = 232;
             break;
           }
-          _context3.next = 228;
+          _context3.next = 229;
           return confirm({
             message: "Patch eslintrc.json to use the recommended Val eslint rules?",
             "default": true
           });
-        case 228:
+        case 229:
           _context3.t9 = _context3.sent;
-          _context3.next = 232;
+          _context3.next = 233;
           break;
-        case 231:
-          _context3.t9 = true;
         case 232:
+          _context3.t9 = true;
+        case 233:
           _answer9 = _context3.t9;
           if (!_answer9) {
-            _context3.next = 243;
+            _context3.next = 244;
             break;
           }
           currentEslintRc = fs.readFileSync(analysis.eslintRcJsonPath, "utf-8");
           parsedEslint = JSON.parse(currentEslintRc);
           if (!(_typeof(parsedEslint) !== "object")) {
-            _context3.next = 239;
+            _context3.next = 240;
             break;
           }
           error("Could not patch eslint: ".concat(analysis.eslintRcJsonPath, " was not an object"));
           return _context3.abrupt("return", {
             abort: true
           });
-        case 239:
+        case 240:
           if (typeof parsedEslint["extends"] === "string") {
             parsedEslint["extends"] = [parsedEslint["extends"]];
           }
@@ -1482,34 +1511,124 @@ function _plan() {
             path: analysis.eslintRcJsonPath,
             source: JSON.stringify(parsedEslint, null, 2) + "\n"
           };
-        case 243:
-          _context3.next = 246;
+        case 244:
+          _context3.next = 279;
           break;
-        case 245:
-          warn("Cannot patch eslint: failed to find eslint config file");
         case 246:
-          if (!analysis.gitIgnorePath) {
-            _context3.next = 258;
+          if (!analysis.eslintRcMjsPath) {
+            _context3.next = 278;
+            break;
+          }
+          if (!analysis.eslintRcMjsText) {
+            _context3.next = 275;
             break;
           }
+          _res = addEslintPluginToEslintMjs({
+            path: analysis.eslintRcMjsPath,
+            source: analysis.eslintRcMjsText
+          }, {
+            j: j,
+            jscodeshift: j.withParser("tsx"),
+            stats: function stats() {},
+            report: function report() {}
+          }, {
+            configImportPath: path.relative(path.dirname(analysis.eslintRcMjsPath), valConfigPath).replace(".js", "").replace(".ts", "")
+          });
+          _diff = diffLines(analysis.eslintRcMjsText, _res, {});
+          _s = "";
+          _diff.forEach(function (part) {
+            if (part.added) {
+              _s += chalk.green(part.value);
+            } else if (part.removed) {
+              _s += chalk.red(part.value);
+            } else {
+              _s += part.value;
+            }
+          });
           if (defaultAnswers) {
-            _context3.next = 253;
+            _context3.next = 258;
             break;
           }
-          _context3.next = 250;
+          _context3.next = 255;
           return confirm({
-            message: "Append .gitignore entry for Val cache? (recommended)",
+            message: "Automatically patch ".concat(analysis.eslintRcMjsPath, " file?"),
             "default": true
           });
-        case 250:
+        case 255:
           _context3.t10 = _context3.sent;
-          _context3.next = 254;
+          _context3.next = 259;
           break;
-        case 253:
+        case 258:
           _context3.t10 = true;
-        case 254:
+        case 259:
           _answer10 = _context3.t10;
-          if (_answer10) {
+          if (!_answer10) {
+            _context3.next = 272;
+            break;
+          }
+          if (defaultAnswers) {
+            _context3.next = 267;
+            break;
+          }
+          _context3.next = 264;
+          return confirm({
+            message: "Do you accept the following patch:\n".concat(_s, "\n"),
+            "default": true
+          });
+        case 264:
+          _context3.t11 = _context3.sent;
+          _context3.next = 268;
+          break;
+        case 267:
+          _context3.t11 = true;
+        case 268:
+          _answer11 = _context3.t11;
+          if (!_answer11) {
+            warn(NO_PATCH_WARNING);
+            plan.updateEslint = false;
+          } else {
+            plan.updateEslint = {
+              path: analysis.eslintRcMjsPath,
+              source: _res
+            };
+          }
+          _context3.next = 273;
+          break;
+        case 272:
+          warn(NO_PATCH_WARNING);
+        case 273:
+          _context3.next = 276;
+          break;
+        case 275:
+          warn(NO_PATCH_WARNING);
+        case 276:
+          _context3.next = 279;
+          break;
+        case 278:
+          warn("Cannot patch eslint: failed to find eslint config file");
+        case 279:
+          if (!analysis.gitIgnorePath) {
+            _context3.next = 291;
+            break;
+          }
+          if (defaultAnswers) {
+            _context3.next = 286;
+            break;
+          }
+          _context3.next = 283;
+          return confirm({
+            message: "Append .gitignore entry for Val cache? (recommended)",
+            "default": true
+          });
+        case 283:
+          _context3.t12 = _context3.sent;
+          _context3.next = 287;
+          break;
+        case 286:
+          _context3.t12 = true;
+        case 287:
+          _answer12 = _context3.t12;
+          if (_answer12) {
             plan.updateGitIgnore = {
               path: analysis.gitIgnorePath,
               source: (analysis.gitIgnoreFile ? "".concat(analysis.gitIgnoreFile, "\n\n") : "") + "# Val local cache\n.val\n"
@@ -1517,59 +1636,59 @@ function _plan() {
           } else {
             plan.updateGitIgnore = false;
           }
-          _context3.next = 259;
+          _context3.next = 292;
           break;
-        case 258:
+        case 291:
           plan.updateGitIgnore = false;
-        case 259:
+        case 292:
           if (defaultAnswers) {
-            _context3.next = 265;
+            _context3.next = 298;
             break;
           }
-          _context3.next = 262;
+          _context3.next = 295;
           return confirm({
             message: "Add the Val Build IntelliSense to .vscode/extensions.json?",
             "default": true
           });
-        case 262:
-          _context3.t11 = _context3.sent;
-          _context3.next = 266;
+        case 295:
+          _context3.t13 = _context3.sent;
+          _context3.next = 299;
           break;
-        case 265:
-          _context3.t11 = true;
-        case 266:
-          _answer11 = _context3.t11;
-          if (!_answer11) {
-            _context3.next = 292;
+        case 298:
+          _context3.t13 = true;
+        case 299:
+          _answer13 = _context3.t13;
+          if (!_answer13) {
+            _context3.next = 325;
             break;
           }
           vscodeDir = path.join(analysis.root, ".vscode");
           settingsPath = path.join(vscodeDir, "extensions.json");
           currentSettings = {};
-          _context3.prev = 271;
+          _context3.prev = 304;
           currentSettingsFile = fs.readFileSync(settingsPath, "utf-8");
           if (!currentSettingsFile) {
-            _context3.next = 282;
+            _context3.next = 315;
             break;
           }
-          _context3.prev = 274;
+          _context3.prev = 307;
           currentSettings = JSON.parse(currentSettingsFile);
-          _context3.next = 282;
+          _context3.next = 315;
           break;
-        case 278:
-          _context3.prev = 278;
-          _context3.t12 = _context3["catch"](274);
-          warn("Failed to parse VS Code extensions.json found here: ".concat(settingsPath, ".").concat(_context3.t12 instanceof Error ? "Parse error: ".concat(_context3.t12.message) : ""));
+        case 311:
+          _context3.prev = 311;
+          _context3.t14 = _context3["catch"](307);
+          warn("Failed to parse VS Code extensions.json found here: ".concat(settingsPath, ".").concat(_context3.t14 instanceof Error ? "Parse error: ".concat(_context3.t14.message) : ""));
           return _context3.abrupt("return", {
             abort: true
           });
-        case 282:
-          _context3.next = 286;
+        case 315:
+          _context3.next = 319;
           break;
-        case 284:
-          _context3.prev = 284;
-          _context3.t13 = _context3["catch"](271);
-        case 286:
+        case 317:
+          _context3.prev = 317;
+          _context3.t15 = _context3["catch"](304);
+        case 319:
           currentRecommendations =
           // eslint-disable-next-line @typescript-eslint/no-explicit-any
           currentSettings.recommendations;
@@ -1583,17 +1702,17 @@ function _plan() {
             path: settingsPath,
             source: JSON.stringify(currentSettings, null, 2)
           };
-          _context3.next = 293;
+          _context3.next = 326;
           break;
-        case 292:
+        case 325:
           plan.updateVSCodeSettings = false;
-        case 293:
+        case 326:
           return _context3.abrupt("return", plan);
-        case 294:
+        case 327:
         case "end":
           return _context3.stop();
       }
-    }, _callee3, null, [[271, 284], [274, 278]]);
+    }, _callee3, null, [[304, 317], [307, 311]]);
   }));
   return _plan.apply(this, arguments);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@valbuild/init",
-  "version": "0.69.1",
+  "version": "0.71.0",
   "description": "Initialize a new val.build project",
   "exports": {
     "./main": {

package/src/codemods/addEslintPluginToEslintMjs.ts

@@ -0,0 +1,22 @@
+import j from "jscodeshift";
+
+export function addEslintPluginToEslintMjs(
+  fileInfo: j.FileInfo,
+  api: j.API,
+  options: j.Options,
+) {
+  if (!options.configImportPath) {
+    throw new Error("configImportPath is required");
+  }
+  const root = api.jscodeshift(fileInfo.source);
+  root
+    .findVariableDeclarators("eslintConfig")
+    .find(j.ArrayExpression)
+    .find(j.SpreadElement)
+    .find(j.CallExpression)
+    .find(j.Literal)
+    .at(-1)
+    .insertAfter(j.literal("plugin:@valbuild/recommended"));
+
+  return root.toSource();
+}

package/src/codemods/index.ts

@@ -1 +1,2 @@
 export * from "./transformNextAppRouterValProvider";
+export * from "./addEslintPluginToEslintMjs";

package/src/codemods.test.ts

@@ -1,5 +1,6 @@
 import jcs from "jscodeshift";
 import { transformNextAppRouterValProvider } from "./codemods/transformNextAppRouterValProvider";
+import { addEslintPluginToEslintMjs } from "./codemods/addEslintPluginToEslintMjs";
 
 const APP_ROUTER_LAYOUT_SANS_VAL_PROVIDER = `import type { Metadata } from "next";
 import { Inter } from "next/font/google";
@@ -70,6 +71,57 @@ export default function RootLayout({
     </html>)
   );
 }
+`);
+  });
+
+  test("add eslint plugin to eslint.config.mjs generated by create-next-app", async () => {
+    const res = addEslintPluginToEslintMjs(
+      {
+        path: "./eslint.config.mjs",
+        source: `import { dirname } from "path";
+import { fileURLToPath } from "url";
+import { FlatCompat } from "@eslint/eslintrc";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+const compat = new FlatCompat({
+  baseDirectory: __dirname,
+});
+
+const eslintConfig = [
+  ...compat.extends("next/core-web-vitals", "next/typescript"),
+];
+
+export default eslintConfig;
+`,
+      },
+      {
+        j: jcs,
+        jscodeshift: jcs,
+        stats: () => {},
+        report: () => {},
+      },
+      {
+        configImportPath: "../val.config",
+      },
+    );
+    expect(res).toEqual(`import { dirname } from "path";
+import { fileURLToPath } from "url";
+import { FlatCompat } from "@eslint/eslintrc";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+const compat = new FlatCompat({
+  baseDirectory: __dirname,
+});
+
+const eslintConfig = [
+  ...compat.extends("next/core-web-vitals", "next/typescript", "plugin:@valbuild/recommended"),
+];
+
+export default eslintConfig;
 `);
   });
 });

package/src/init.ts

@@ -19,6 +19,7 @@ import {
   VAL_SERVER,
 } from "./templates";
 import * as logger from "./logger";
+import { addEslintPluginToEslintMjs } from "./codemods";
 
 const MIN_VAL_VERSION = packageJson.version;
 const MIN_NEXT_VERSION = "13.4.0";
@@ -92,6 +93,8 @@ type Analysis = Partial<{
   eslintRcJsonText: string;
   eslintRcJsPath: string;
   eslintRcJsText: string;
+  eslintRcMjsPath: string;
+  eslintRcMjsText: string;
   valEslintVersion: string;
   isValEslintRulesConfigured: boolean;
 
@@ -191,6 +194,20 @@ const analyze = async (root: string, files: string[]): Promise<Analysis> => {
       );
     }
   }
+  analysis.eslintRcMjsPath = files.find((file) =>
+    file.endsWith("eslint.config.mjs"),
+  );
+  if (analysis.eslintRcMjsPath) {
+    analysis.eslintRcMjsText = fs.readFileSync(
+      analysis.eslintRcMjsPath,
+      "utf8",
+    );
+    if (analysis.eslintRcMjsText) {
+      // TODO: Evaluate and extract config?
+      analysis.isValEslintRulesConfigured =
+        analysis.eslintRcMjsText.includes("@valbuild");
+    }
+  }
   analysis.eslintRcJsonPath =
     files.find((file) => file.endsWith(".eslintrc.json")) ||
     files.find((file) => file.endsWith(".eslintrc"));
@@ -718,9 +735,11 @@ async function plan(
       logger.warn("  @valbuild/eslint-plugin rules: already configured");
     } else {
       if (analysis.eslintRcJsPath) {
-        logger.warn(
-          'Cannot patch eslint: found .eslintrc.js but can only patch JSON files (at the moment).\nAdd the following to your eslint config:\n\n  "extends": ["plugin:@valbuild/recommended"]\n',
-        );
+        await confirm({
+          message:
+            ' Cannot patch eslint: found .eslintrc.js but can only patch JSON files (at the moment).\nAdd the following to your eslint config:\n\n  "extends": ["plugin:@valbuild/recommended"]\n\n',
+          default: true,
+        });
       } else if (analysis.eslintRcJsonPath) {
         const answer = !defaultAnswers
           ? await confirm({
@@ -751,6 +770,67 @@ async function plan(
             source: JSON.stringify(parsedEslint, null, 2) + "\n",
           };
         }
+      } else if (analysis.eslintRcMjsPath) {
+        if (analysis.eslintRcMjsText) {
+          const res = addEslintPluginToEslintMjs(
+            {
+              path: analysis.eslintRcMjsPath,
+              source: analysis.eslintRcMjsText,
+            },
+            {
+              j: jcs,
+              jscodeshift: jcs.withParser("tsx"),
+              stats: () => {},
+              report: () => {},
+            },
+            {
+              configImportPath: path
+                .relative(path.dirname(analysis.eslintRcMjsPath), valConfigPath)
+                .replace(".js", "")
+                .replace(".ts", ""),
+            },
+          );
+
+          const diff = diffLines(analysis.eslintRcMjsText, res, {});
+
+          let s = "";
+          diff.forEach((part) => {
+            if (part.added) {
+              s += chalk.green(part.value);
+            } else if (part.removed) {
+              s += chalk.red(part.value);
+            } else {
+              s += part.value;
+            }
+          });
+          const answer = !defaultAnswers
+            ? await confirm({
+                message: `Automatically patch ${analysis.eslintRcMjsPath} file?`,
+                default: true,
+              })
+            : true;
+          if (answer) {
+            const answer = !defaultAnswers
+              ? await confirm({
+                  message: `Do you accept the following patch:\n${s}\n`,
+                  default: true,
+                })
+              : true;
+            if (!answer) {
+              logger.warn(NO_PATCH_WARNING);
+              plan.updateEslint = false;
+            } else {
+              plan.updateEslint = {
+                path: analysis.eslintRcMjsPath,
+                source: res,
+              };
+            }
+          } else {
+            logger.warn(NO_PATCH_WARNING);
+          }
+        } else {
+          logger.warn(NO_PATCH_WARNING);
+        }
       } else {
         logger.warn("Cannot patch eslint: failed to find eslint config file");
       }