@valbuild/init 0.53.0 → 0.54.0

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

@@ -451,7 +451,7 @@ function transformNextAppRouterValProvider(fileInfo, api, options) {
 
 var packageJson = {
 	name: "@valbuild/init",
-	version: "0.53.0",
+	version: "0.54.0",
 	description: "Initialize a new val.build project",
 	exports: {
 		"./main": {
@@ -461,6 +461,7 @@ var packageJson = {
 		"./package.json": "./package.json"
 	},
 	scripts: {
+		typecheck: "tsc --noEmit",
 		test: "jest"
 	},
 	bin: {
@@ -509,8 +510,8 @@ var VAL_SERVER = function VAL_SERVER(configImportPath) {
 
 // TODO: use Val config
 
-var VAL_CONFIG = function VAL_CONFIG(options) {
-  return "import { initVal } from \"@valbuild/next\";\n\nconst { s, val, config } = initVal(".concat(JSON.stringify(options, null, 2), ");\n\nexport { s, val, config };\n");
+var VAL_CONFIG = function VAL_CONFIG(isTypeScript, options) {
+  return "import { initVal } from \"@valbuild/next\";\n\nconst { s, c, val, config } = initVal(".concat(JSON.stringify(options, null, 2), ");\n\n").concat(isTypeScript ? 'export type { t } from "@valbuild/next";' : "", ";\nexport { s, c, val, config };\n");
 };
 var VAL_API_ROUTER = function VAL_API_ROUTER(valServerPath) {
   return "import { valNextAppRouter } from \"".concat(valServerPath, "\";\n\nexport const GET = valNextAppRouter;\nexport const POST = valNextAppRouter;\nexport const PATCH = valNextAppRouter;\nexport const DELETE = valNextAppRouter;\nexport const PUT = valNextAppRouter;\nexport const HEAD = valNextAppRouter;\n");
@@ -595,7 +596,7 @@ function walk(dir) {
   maxResetLength = Math.max(maxResetLength, m.length);
   process.stdout.write(m + " ".repeat(maxResetLength - m.length));
   return fs.readdirSync(dir).reduce(function (files, fileOrDirName) {
-    var fileOrDirPath = [dir, fileOrDirName].join("/"); // always use / as path separator - should work on windows as well?
+    var fileOrDirPath = [dir, fileOrDirName].join("/"); // always use / as path separator since we are doing .endsWith("/foo/bar.ts") when checking for files and we thought this would make it easier (if you are reading this and wondering wtf, then maybe not :) - should work on windows as well?
     if (fs.statSync(fileOrDirPath).isDirectory() && !skip.test(fileOrDirName)) {
       return files.concat(walk(fileOrDirPath));
     }
@@ -685,8 +686,8 @@ var analyze = /*#__PURE__*/function () {
           });
           analysis.pagesRouter = !!pagesRouterAppPath;
           if (pagesRouterAppPath) {
-            analysis.isTypescript = !!pagesRouterAppPath.endsWith(".tsx");
-            analysis.isJavascript = !!pagesRouterAppPath.endsWith(".jsx");
+            analysis.isTypeScript = !!pagesRouterAppPath.endsWith(".tsx");
+            analysis.isJavaScript = !!pagesRouterAppPath.endsWith(".jsx");
             analysis.srcDir = path.dirname(path.dirname(pagesRouterAppPath));
           }
           appRouterLayoutPath = files.find(function (file) {
@@ -698,8 +699,8 @@ var analyze = /*#__PURE__*/function () {
             analysis.appRouter = true;
             analysis.appRouterLayoutPath = appRouterLayoutPath;
             analysis.appRouterLayoutFile = fs.readFileSync(appRouterLayoutPath, "utf8");
-            analysis.isTypescript = !!appRouterLayoutPath.endsWith(".tsx");
-            analysis.isJavascript = !!appRouterLayoutPath.endsWith(".jsx");
+            analysis.isTypeScript = !!appRouterLayoutPath.endsWith(".tsx");
+            analysis.isJavaScript = !!appRouterLayoutPath.endsWith(".jsx");
             analysis.appRouterPath = path.dirname(appRouterLayoutPath);
             analysis.srcDir = path.dirname(analysis.appRouterPath);
           }
@@ -740,12 +741,10 @@ function _plan() {
   _plan = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee3(analysis) {
     var defaultAnswers,
       plan,
+      answer,
       tsconfigJsonPath,
       jsconfigJsonPath,
-      answer,
       _answer,
-      currentEslintRc,
-      parsedEslint,
       _answer2,
       valConfigPath,
       valUtilsDir,
@@ -763,6 +762,9 @@ function _plan() {
       s,
       _answer5,
       _answer6,
+      _answer7,
+      currentEslintRc,
+      parsedEslint,
       _args3 = arguments;
     return _regeneratorRuntime().wrap(function _callee3$(_context3) {
       while (1) switch (_context3.prev = _context3.next) {
@@ -828,30 +830,64 @@ function _plan() {
             abort: true
           });
         case 25:
+          if (analysis.valVersionIsSatisfied) {
+            _context3.next = 40;
+            break;
+          }
+          warn("  This init script expects @valbuild/next >= ".concat(MIN_VAL_VERSION, ". Found: ").concat(analysis.valVersion));
+          if (defaultAnswers) {
+            _context3.next = 33;
+            break;
+          }
+          _context3.next = 30;
+          return confirm({
+            message: "Continue?",
+            "default": false
+          });
+        case 30:
+          _context3.t0 = _context3.sent;
+          _context3.next = 34;
+          break;
+        case 33:
+          _context3.t0 = false;
+        case 34:
+          answer = _context3.t0;
+          if (answer) {
+            _context3.next = 38;
+            break;
+          }
+          error("Aborted: val version is not satisfied.\n\nInstall the @valbuild/next@".concat(MIN_VAL_VERSION, " package with your favorite package manager.\n\nExample:\n\n  npm install -D @valbuild/next@").concat(MIN_VAL_VERSION, "\n"));
+          return _context3.abrupt("return", {
+            abort: true
+          });
+        case 38:
+          _context3.next = 41;
+          break;
+        case 40:
           info("  Val version: found ".concat(analysis.valVersion, " >= ").concat(MIN_VAL_VERSION), {
             isGood: true
           });
-        case 26:
+        case 41:
           if (analysis.nextVersionIsSatisfied) {
-            _context3.next = 31;
+            _context3.next = 46;
             break;
           }
           error("Val requires Next.js >= ".concat(MIN_NEXT_VERSION, ". Found: ").concat(analysis.nextVersion));
           return _context3.abrupt("return", {
             abort: true
           });
-        case 31:
+        case 46:
           info("  Next.js version: found ".concat(analysis.nextVersion, " >= ").concat(MIN_NEXT_VERSION), {
             isGood: true
           });
-        case 32:
-          if (analysis.isTypescript) {
+        case 47:
+          if (analysis.isTypeScript) {
             info("  Use: TypeScript", {
               isGood: true
             });
             plan.useTypescript = true;
           }
-          if (analysis.isJavascript) {
+          if (analysis.isJavaScript) {
             info("  Use: JavaScript", {
               isGood: true
             });
@@ -859,82 +895,82 @@ function _plan() {
               plan.useJavascript = true;
             }
           }
-          if (!analysis.isTypescript) {
-            _context3.next = 44;
+          if (!analysis.isTypeScript) {
+            _context3.next = 59;
             break;
           }
           tsconfigJsonPath = path.join(analysis.root, "tsconfig.json");
           if (!fs.statSync(tsconfigJsonPath).isFile()) {
-            _context3.next = 40;
+            _context3.next = 55;
             break;
           }
           info("  tsconfig.json: found", {
             isGood: true
           });
-          _context3.next = 42;
+          _context3.next = 57;
           break;
-        case 40:
+        case 55:
           error("tsconfig.json: Failed to find tsconfig.json");
           return _context3.abrupt("return", {
             abort: true
           });
-        case 42:
-          _context3.next = 51;
+        case 57:
+          _context3.next = 66;
           break;
-        case 44:
+        case 59:
           jsconfigJsonPath = path.join(analysis.root, "jsconfig.json");
           if (!fs.statSync(jsconfigJsonPath).isFile()) {
-            _context3.next = 49;
+            _context3.next = 64;
             break;
           }
           info("  jsconfig.json: found", {
             isGood: true
           });
-          _context3.next = 51;
+          _context3.next = 66;
           break;
-        case 49:
+        case 64:
           error(" jsconfig.json: failed to find jsconfig.json");
           return _context3.abrupt("return", {
             abort: true
           });
-        case 51:
+        case 66:
           if (!(analysis.valEslintVersion === undefined)) {
-            _context3.next = 65;
+            _context3.next = 80;
             break;
           }
           if (defaultAnswers) {
-            _context3.next = 58;
+            _context3.next = 73;
             break;
           }
-          _context3.next = 55;
+          _context3.next = 70;
           return confirm({
             message: "The recommended Val eslint plugin (@valbuild/eslint-plugin) is not installed. Continue?",
             "default": false
           });
-        case 55:
-          _context3.t0 = _context3.sent;
-          _context3.next = 59;
+        case 70:
+          _context3.t1 = _context3.sent;
+          _context3.next = 74;
           break;
-        case 58:
-          _context3.t0 = false;
-        case 59:
-          answer = _context3.t0;
-          if (answer) {
-            _context3.next = 63;
+        case 73:
+          _context3.t1 = false;
+        case 74:
+          _answer = _context3.t1;
+          if (_answer) {
+            _context3.next = 78;
             break;
           }
           error("Aborted: the Val eslint plugin is not installed.\n\nInstall the @valbuild/eslint-plugin package with your favorite package manager.\n\nExample:\n\n  npm install -D @valbuild/eslint-plugin\n");
           return _context3.abrupt("return", {
             abort: true
           });
-        case 63:
-          _context3.next = 66;
+        case 78:
+          _context3.next = 81;
           break;
-        case 65:
+        case 80:
           info("  @valbuild/eslint-plugin: installed", {
             isGood: true
           });
-        case 66:
+        case 81:
           if (analysis.appRouter) {
             info("  Use: App Router", {
               isGood: true
@@ -953,128 +989,63 @@ function _plan() {
           if (!analysis.isGitClean) {
             warn("  Git state: dirty");
           }
-          if (!analysis.valEslintVersion) {
+          if (analysis.isGitClean) {
             _context3.next = 101;
             break;
           }
-          if (!analysis.isValEslintRulesConfigured) {
-            _context3.next = 75;
-            break;
-          }
-          info("  @valbuild/eslint-plugin rules configured", {
-            isGood: true
-          });
-          _context3.next = 101;
-          break;
-        case 75:
-          if (!analysis.eslintRcJsPath) {
-            _context3.next = 79;
-            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 = 101;
-          break;
-        case 79:
-          if (!analysis.eslintRcJsonPath) {
-            _context3.next = 100;
-            break;
-          }
-          if (defaultAnswers) {
-            _context3.next = 86;
-            break;
-          }
-          _context3.next = 83;
-          return confirm({
-            message: "Patch eslintrc.json to use the recommended Val eslint rules?",
-            "default": true
-          });
-        case 83:
-          _context3.t1 = _context3.sent;
-          _context3.next = 87;
-          break;
         case 86:
-          _context3.t1 = true;
-        case 87:
-          _answer = _context3.t1;
-          if (!_answer) {
-            _context3.next = 98;
-            break;
-          }
-          currentEslintRc = fs.readFileSync(analysis.eslintRcJsonPath, "utf-8");
-          parsedEslint = JSON.parse(currentEslintRc);
-          if (!(_typeof(parsedEslint) !== "object")) {
-            _context3.next = 94;
-            break;
-          }
-          error("Could not patch eslint: ".concat(analysis.eslintRcJsonPath, " was not an object"));
-          return _context3.abrupt("return", {
-            abort: true
-          });
-        case 94:
-          if (typeof parsedEslint["extends"] === "string") {
-            parsedEslint["extends"] = [parsedEslint["extends"]];
-          }
-          parsedEslint["extends"] = parsedEslint["extends"] || [];
-          parsedEslint["extends"].push("plugin:@valbuild/recommended");
-          plan.updateEslint = {
-            path: analysis.eslintRcJsonPath,
-            source: JSON.stringify(parsedEslint, null, 2) + "\n"
-          };
-        case 98:
-          _context3.next = 101;
-          break;
-        case 100:
-          warn("Cannot patch eslint: failed to find eslint config file");
-        case 101:
-          if (analysis.isGitClean) {
-            _context3.next = 117;
-            break;
-          }
-        case 102:
           if (!(plan.ignoreGitDirty === undefined)) {
-            _context3.next = 117;
+            _context3.next = 101;
             break;
           }
           if (defaultAnswers) {
-            _context3.next = 109;
+            _context3.next = 93;
             break;
           }
-          _context3.next = 106;
+          _context3.next = 90;
           return confirm({
             message: "You have uncommitted changes. Continue?",
             "default": false
           });
-        case 106:
+        case 90:
           _context3.t2 = _context3.sent;
-          _context3.next = 110;
+          _context3.next = 94;
           break;
-        case 109:
+        case 93:
           _context3.t2 = false;
-        case 110:
+        case 94:
           _answer2 = _context3.t2;
           plan.ignoreGitDirty = _answer2;
           if (_answer2) {
-            _context3.next = 115;
+            _context3.next = 99;
             break;
           }
           error("Aborted: git state dirty");
           return _context3.abrupt("return", {
-            abort: true,
-            ignoreGitDirty: true
+            abort: true
           });
-        case 115:
-          _context3.next = 102;
+        case 99:
+          _context3.next = 86;
           break;
-        case 117:
+        case 101:
           // New required files:
-          valConfigPath = path.join(analysis.root, "val.config.ts");
+          valConfigPath = path.join(analysis.root, analysis.isTypeScript ? "val.config.ts" : "val.config.js");
+          if (!fs.existsSync(valConfigPath)) {
+            _context3.next = 105;
+            break;
+          }
+          error("Aborted: a Val config file: ".concat(valConfigPath, " already exists."));
+          return _context3.abrupt("return", {
+            abort: true
+          });
+        case 105:
           plan.createConfigFile = {
             path: valConfigPath,
-            source: VAL_CONFIG({})
+            source: VAL_CONFIG(!!analysis.isTypeScript, {})
           };
           valUtilsDir = path.join(analysis.srcDir, "val");
           valUtilsImportPath = path.relative(valUtilsDir, valConfigPath).replace(".js", "").replace(".ts", "");
-          valServerPath = path.join(valUtilsDir, analysis.isTypescript ? "val.server.ts" : "val.server.js");
+          valServerPath = path.join(valUtilsDir, analysis.isTypeScript ? "val.server.ts" : "val.server.js");
           plan.createValServer = {
             path: valServerPath,
             source: VAL_SERVER(valUtilsImportPath)
@@ -1082,13 +1053,13 @@ function _plan() {
           if (!analysis.appRouterPath) {
             warn('Creating a new "app" router');
           }
-          valAppPagePath = path.join(analysis.appRouterPath || path.join(analysis.srcDir, "app"), "(val)", "val", analysis.isTypescript ? "page.tsx" : "page.jsx");
+          valAppPagePath = path.join(analysis.appRouterPath || path.join(analysis.srcDir, "app"), "(val)", "val", "[[...val]]", analysis.isTypeScript ? "page.tsx" : "page.jsx");
           valPageImportPath = path.relative(path.dirname(valAppPagePath), valConfigPath).replace(".js", "").replace(".ts", "");
           plan.createValAppPage = {
             path: valAppPagePath,
             source: VAL_APP_PAGE(valPageImportPath)
           };
-          valRouterPath = path.join(analysis.appRouterPath || path.join(analysis.srcDir, "app"), "(val)", "api", "val", analysis.isTypescript ? "router.tsx" : "router.jsx");
+          valRouterPath = path.join(analysis.appRouterPath || path.join(analysis.srcDir, "app"), "(val)", "api", "val", "[[...val]]", analysis.isTypeScript ? "router.tsx" : "router.jsx");
           valRouterImportPath = path.relative(path.dirname(valRouterPath), valServerPath).replace(".js", "").replace(".ts", "");
           plan.createValRouter = {
             path: valRouterPath,
@@ -1096,90 +1067,86 @@ function _plan() {
           };
 
           // Util files:
-        case 130:
+        case 117:
           if (!(plan.createValClient === undefined)) {
-            _context3.next = 142;
+            _context3.next = 129;
             break;
           }
           if (defaultAnswers) {
-            _context3.next = 137;
+            _context3.next = 124;
             break;
           }
-          _context3.next = 134;
+          _context3.next = 121;
           return confirm({
             message: "Setup useVal for Client Components",
             "default": true
           });
-        case 134:
+        case 121:
           _context3.t3 = _context3.sent;
-          _context3.next = 138;
+          _context3.next = 125;
           break;
-        case 137:
+        case 124:
           _context3.t3 = true;
-        case 138:
+        case 125:
           _answer3 = _context3.t3;
           if (_answer3) {
             plan.createValClient = {
-              path: path.join(valUtilsDir, analysis.isTypescript ? "val.client.ts" : "val.client.js"),
+              path: path.join(valUtilsDir, analysis.isTypeScript ? "val.client.ts" : "val.client.js"),
               source: VAL_CLIENT(valUtilsImportPath)
             };
           } else {
             plan.createValClient = false;
           }
-          _context3.next = 130;
+          _context3.next = 117;
           break;
-        case 142:
+        case 129:
           if (!(plan.createValRsc === undefined)) {
-            _context3.next = 154;
+            _context3.next = 141;
             break;
           }
           if (defaultAnswers) {
-            _context3.next = 149;
+            _context3.next = 136;
             break;
           }
-          _context3.next = 146;
+          _context3.next = 133;
           return confirm({
             message: "Setup fetchVal for React Server Components",
             "default": true
           });
-        case 146:
+        case 133:
           _context3.t4 = _context3.sent;
-          _context3.next = 150;
+          _context3.next = 137;
           break;
-        case 149:
+        case 136:
           _context3.t4 = true;
-        case 150:
+        case 137:
           _answer4 = _context3.t4;
           if (_answer4) {
             plan.createValRsc = {
-              path: path.join(valUtilsDir, analysis.isTypescript ? "val.rsc.ts" : "val.rsc.js"),
+              path: path.join(valUtilsDir, analysis.isTypeScript ? "val.rsc.ts" : "val.rsc.js"),
               source: VAL_SERVER(valUtilsImportPath)
             };
           } else {
             plan.createValRsc = false;
           }
-          _context3.next = 142;
+          _context3.next = 129;
           break;
-        case 154:
-          if (analysis.eslintRcJsPath) {
-            warn("ESLint config found: " + analysis.eslintRcJsPath);
-          }
-
+        case 141:
           // Patches:
           NO_PATCH_WARNING = "Remember to add the ValProvider in your root app/layout.tsx or pages/_app.tsx file.\n";
           if (!analysis.appRouterLayoutPath) {
-            _context3.next = 185;
+            _context3.next = 171;
             break;
           }
           if (analysis.appRouterLayoutFile) {
-            _context3.next = 160;
+            _context3.next = 146;
             break;
           }
           error("Failed to read app router layout file");
           return _context3.abrupt("return", {
             abort: true
           });
-        case 160:
+        case 146:
           res = transformNextAppRouterValProvider({
             path: analysis.appRouterLayoutPath,
             source: analysis.appRouterLayoutFile
@@ -1203,42 +1170,42 @@ function _plan() {
             }
           });
           if (defaultAnswers) {
-            _context3.next = 170;
+            _context3.next = 156;
             break;
           }
-          _context3.next = 167;
+          _context3.next = 153;
           return confirm({
             message: "Automatically patch ".concat(analysis.appRouterLayoutPath, " file?"),
             "default": true
           });
-        case 167:
+        case 153:
           _context3.t5 = _context3.sent;
-          _context3.next = 171;
+          _context3.next = 157;
           break;
-        case 170:
+        case 156:
           _context3.t5 = true;
-        case 171:
+        case 157:
           _answer5 = _context3.t5;
           if (!_answer5) {
-            _context3.next = 184;
+            _context3.next = 170;
             break;
           }
           if (defaultAnswers) {
-            _context3.next = 179;
+            _context3.next = 165;
             break;
           }
-          _context3.next = 176;
+          _context3.next = 162;
           return confirm({
             message: "Do you accept the following patch:\n".concat(s, "\n"),
             "default": true
           });
-        case 176:
+        case 162:
           _context3.t6 = _context3.sent;
-          _context3.next = 180;
+          _context3.next = 166;
           break;
-        case 179:
+        case 165:
           _context3.t6 = true;
-        case 180:
+        case 166:
           _answer6 = _context3.t6;
           if (!_answer6) {
             warn(NO_PATCH_WARNING);
@@ -1249,16 +1216,87 @@ function _plan() {
               source: res
             };
           }
-          _context3.next = 185;
+          _context3.next = 171;
           break;
-        case 184:
+        case 170:
           warn(NO_PATCH_WARNING);
-        case 185:
+        case 171:
           if (analysis.pagesRouter) {
             warn(NO_PATCH_WARNING);
           }
+          if (!analysis.valEslintVersion) {
+            _context3.next = 203;
+            break;
+          }
+          if (!analysis.isValEslintRulesConfigured) {
+            _context3.next = 177;
+            break;
+          }
+          warn("  @valbuild/eslint-plugin rules: already configured");
+          _context3.next = 203;
+          break;
+        case 177:
+          if (!analysis.eslintRcJsPath) {
+            _context3.next = 181;
+            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 = 203;
+          break;
+        case 181:
+          if (!analysis.eslintRcJsonPath) {
+            _context3.next = 202;
+            break;
+          }
+          if (defaultAnswers) {
+            _context3.next = 188;
+            break;
+          }
+          _context3.next = 185;
+          return confirm({
+            message: "Patch eslintrc.json to use the recommended Val eslint rules?",
+            "default": true
+          });
+        case 185:
+          _context3.t7 = _context3.sent;
+          _context3.next = 189;
+          break;
+        case 188:
+          _context3.t7 = true;
+        case 189:
+          _answer7 = _context3.t7;
+          if (!_answer7) {
+            _context3.next = 200;
+            break;
+          }
+          currentEslintRc = fs.readFileSync(analysis.eslintRcJsonPath, "utf-8");
+          parsedEslint = JSON.parse(currentEslintRc);
+          if (!(_typeof(parsedEslint) !== "object")) {
+            _context3.next = 196;
+            break;
+          }
+          error("Could not patch eslint: ".concat(analysis.eslintRcJsonPath, " was not an object"));
+          return _context3.abrupt("return", {
+            abort: true
+          });
+        case 196:
+          if (typeof parsedEslint["extends"] === "string") {
+            parsedEslint["extends"] = [parsedEslint["extends"]];
+          }
+          parsedEslint["extends"] = parsedEslint["extends"] || [];
+          parsedEslint["extends"].push("plugin:@valbuild/recommended");
+          plan.updateEslint = {
+            path: analysis.eslintRcJsonPath,
+            source: JSON.stringify(parsedEslint, null, 2) + "\n"
+          };
+        case 200:
+          _context3.next = 203;
+          break;
+        case 202:
+          warn("Cannot patch eslint: failed to find eslint config file");
+        case 203:
           return _context3.abrupt("return", plan);
-        case 187:
+        case 204:
         case "end":
           return _context3.stop();
       }