@valbuild/init 0.53.0 → 0.55.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@valbuild/init",
-  "version": "0.53.0",
+  "version": "0.55.0",
   "description": "Initialize a new val.build project",
   "exports": {
     "./main": {
@@ -10,6 +10,7 @@
     "./package.json": "./package.json"
   },
   "scripts": {
+    "typecheck": "tsc --noEmit",
     "test": "jest"
   },
   "bin": {

package/src/init.ts

@@ -51,7 +51,7 @@ function walk(dir: string, skip: RegExp = /node_modules|.git/): string[] {
   maxResetLength = Math.max(maxResetLength, m.length);
   process.stdout.write(m + " ".repeat(maxResetLength - m.length));
   return fs.readdirSync(dir).reduce((files, fileOrDirName) => {
-    const fileOrDirPath = [dir, fileOrDirName].join("/"); // always use / as path separator - should work on windows as well?
+    const 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));
     }
@@ -65,8 +65,8 @@ type Analysis = Partial<{
   srcDir: string;
   packageJsonDir: string;
   valConfigPath: string;
-  isTypescript: boolean;
-  isJavascript: boolean;
+  isTypeScript: boolean;
+  isJavaScript: boolean;
 
   // Val package:
   isValInstalled: boolean;
@@ -179,8 +179,8 @@ const analyze = async (root: string, files: string[]): Promise<Analysis> => {
     files.find((file) => file.endsWith("/pages/_app.jsx"));
   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));
   }
 
@@ -192,8 +192,8 @@ const analyze = async (root: string, files: string[]): Promise<Analysis> => {
     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);
   }
@@ -267,10 +267,28 @@ async function plan(
     logger.error("Install @valbuild/next first");
     return { abort: true };
   } else {
-    logger.info(
-      `  Val version: found ${analysis.valVersion} >= ${MIN_VAL_VERSION}`,
-      { isGood: true }
-    );
+    if (!analysis.valVersionIsSatisfied) {
+      logger.warn(
+        `  This init script expects @valbuild/next >= ${MIN_VAL_VERSION}. Found: ${analysis.valVersion}`
+      );
+      const answer = !defaultAnswers
+        ? await confirm({
+            message: "Continue?",
+            default: false,
+          })
+        : false;
+      if (!answer) {
+        logger.error(
+          `Aborted: val version is not satisfied.\n\nInstall the @valbuild/next@${MIN_VAL_VERSION} package with your favorite package manager.\n\nExample:\n\n  npm install -D @valbuild/next@${MIN_VAL_VERSION}\n`
+        );
+        return { abort: true };
+      }
+    } else {
+      logger.info(
+        `  Val version: found ${analysis.valVersion} >= ${MIN_VAL_VERSION}`,
+        { isGood: true }
+      );
+    }
   }
   if (!analysis.nextVersionIsSatisfied) {
     logger.error(
@@ -283,17 +301,17 @@ async function plan(
       { isGood: true }
     );
   }
-  if (analysis.isTypescript) {
+  if (analysis.isTypeScript) {
     logger.info("  Use: TypeScript", { isGood: true });
     plan.useTypescript = true;
   }
-  if (analysis.isJavascript) {
+  if (analysis.isJavaScript) {
     logger.info("  Use: JavaScript", { isGood: true });
     if (!plan.useTypescript) {
       plan.useJavascript = true;
     }
   }
-  if (analysis.isTypescript) {
+  if (analysis.isTypeScript) {
     const tsconfigJsonPath = path.join(analysis.root, "tsconfig.json");
     if (fs.statSync(tsconfigJsonPath).isFile()) {
       logger.info("  tsconfig.json: found", { isGood: true });
@@ -341,51 +359,6 @@ async function plan(
     logger.warn("  Git state: dirty");
   }
 
-  if (analysis.valEslintVersion) {
-    if (analysis.isValEslintRulesConfigured) {
-      logger.info("  @valbuild/eslint-plugin rules configured", {
-        isGood: true,
-      });
-    } 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'
-        );
-      } else if (analysis.eslintRcJsonPath) {
-        const answer = !defaultAnswers
-          ? await confirm({
-              message:
-                "Patch eslintrc.json to use the recommended Val eslint rules?",
-              default: true,
-            })
-          : true;
-        if (answer) {
-          const currentEslintRc = fs.readFileSync(
-            analysis.eslintRcJsonPath,
-            "utf-8"
-          );
-          const parsedEslint = JSON.parse(currentEslintRc);
-          if (typeof parsedEslint !== "object") {
-            logger.error(
-              `Could not patch eslint: ${analysis.eslintRcJsonPath} was not an object`
-            );
-            return { abort: true };
-          }
-          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",
-          };
-        }
-      } else {
-        logger.warn("Cannot patch eslint: failed to find eslint config file");
-      }
-    }
-  }
   if (!analysis.isGitClean) {
     while (plan.ignoreGitDirty === undefined) {
       const answer = !defaultAnswers
@@ -397,17 +370,26 @@ async function plan(
       plan.ignoreGitDirty = answer;
       if (!answer) {
         logger.error("Aborted: git state dirty");
-        return { abort: true, ignoreGitDirty: true };
+        return { abort: true };
       }
     }
   }
 
   // New required files:
-  const valConfigPath = path.join(analysis.root, "val.config.ts");
+  const valConfigPath = path.join(
+    analysis.root,
+    analysis.isTypeScript ? "val.config.ts" : "val.config.js"
+  );
+  if (fs.existsSync(valConfigPath)) {
+    logger.error(
+      `Aborted: a Val config file: ${valConfigPath} already exists.`
+    );
+    return { abort: true };
+  }
 
   plan.createConfigFile = {
     path: valConfigPath,
-    source: VAL_CONFIG({}),
+    source: VAL_CONFIG(!!analysis.isTypeScript, {}),
   };
 
   const valUtilsDir = path.join(analysis.srcDir, "val");
@@ -418,7 +400,7 @@ async function plan(
 
   const valServerPath = path.join(
     valUtilsDir,
-    analysis.isTypescript ? "val.server.ts" : "val.server.js"
+    analysis.isTypeScript ? "val.server.ts" : "val.server.js"
   );
   plan.createValServer = {
     path: valServerPath,
@@ -433,7 +415,8 @@ async function plan(
     analysis.appRouterPath || path.join(analysis.srcDir, "app"),
     "(val)",
     "val",
-    analysis.isTypescript ? "page.tsx" : "page.jsx"
+    "[[...val]]",
+    analysis.isTypeScript ? "page.tsx" : "page.jsx"
   );
   const valPageImportPath = path
     .relative(path.dirname(valAppPagePath), valConfigPath)
@@ -449,7 +432,8 @@ async function plan(
     "(val)",
     "api",
     "val",
-    analysis.isTypescript ? "router.tsx" : "router.jsx"
+    "[[...val]]",
+    analysis.isTypeScript ? "router.tsx" : "router.jsx"
   );
   const valRouterImportPath = path
     .relative(path.dirname(valRouterPath), valServerPath)
@@ -473,7 +457,7 @@ async function plan(
       plan.createValClient = {
         path: path.join(
           valUtilsDir,
-          analysis.isTypescript ? "val.client.ts" : "val.client.js"
+          analysis.isTypeScript ? "val.client.ts" : "val.client.js"
         ),
         source: VAL_CLIENT(valUtilsImportPath),
       };
@@ -492,7 +476,7 @@ async function plan(
       plan.createValRsc = {
         path: path.join(
           valUtilsDir,
-          analysis.isTypescript ? "val.rsc.ts" : "val.rsc.js"
+          analysis.isTypeScript ? "val.rsc.ts" : "val.rsc.js"
         ),
         source: VAL_SERVER(valUtilsImportPath),
       };
@@ -501,10 +485,6 @@ async function plan(
     }
   }
 
-  if (analysis.eslintRcJsPath) {
-    logger.warn("ESLint config found: " + analysis.eslintRcJsPath);
-  }
-
   // Patches:
 
   const NO_PATCH_WARNING =
@@ -576,6 +556,50 @@ async function plan(
     logger.warn(NO_PATCH_WARNING);
   }
 
+  if (analysis.valEslintVersion) {
+    if (analysis.isValEslintRulesConfigured) {
+      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'
+        );
+      } else if (analysis.eslintRcJsonPath) {
+        const answer = !defaultAnswers
+          ? await confirm({
+              message:
+                "Patch eslintrc.json to use the recommended Val eslint rules?",
+              default: true,
+            })
+          : true;
+        if (answer) {
+          const currentEslintRc = fs.readFileSync(
+            analysis.eslintRcJsonPath,
+            "utf-8"
+          );
+          const parsedEslint = JSON.parse(currentEslintRc);
+          if (typeof parsedEslint !== "object") {
+            logger.error(
+              `Could not patch eslint: ${analysis.eslintRcJsonPath} was not an object`
+            );
+            return { abort: true };
+          }
+          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",
+          };
+        }
+      } else {
+        logger.warn("Cannot patch eslint: failed to find eslint config file");
+      }
+    }
+  }
+
   return plan;
 }
 

package/src/templates.ts

@@ -44,12 +44,14 @@ type ValConfig = {
   valConfigPath?: string;
 };
 export const VAL_CONFIG = (
+  isTypeScript: boolean,
   options: ValConfig
 ) => `import { initVal } from "@valbuild/next";
 
-const { s, val, config } = initVal(${JSON.stringify(options, null, 2)});
+const { s, c, val, config } = initVal(${JSON.stringify(options, null, 2)});
 
-export { s, val, config };
+${isTypeScript ? 'export type { t } from "@valbuild/next";' : ""};
+export { s, c, val, config };
 `;
 
 export const VAL_API_ROUTER = (