@valbuild/init 0.63.1 → 0.63.4

package/main/dist/valbuild-init-main.cjs.prod.js

@@ -516,7 +516,7 @@ function transformNextAppRouterValProvider(fileInfo, api, options) {
 
 var packageJson = {
 	name: "@valbuild/init",
-	version: "0.63.1",
+	version: "0.63.4",
 	description: "Initialize a new val.build project",
 	exports: {
 		"./main": {
@@ -591,7 +591,7 @@ var VAL_MODULES = function VAL_MODULES(configImportPath, exampleModuleImport) {
   return "import { modules } from \"@valbuild/next\";\nimport { config } from \"./".concat(configImportPath, "\";\n\nexport default modules(config, [\n  // Add your modules here").concat(exampleModuleImport ? "\n  { def: () => import(\"./".concat(exampleModuleImport, "\") },") : "", "\n]);\n\n");
 };
 var BASIC_EXAMPLE = function BASIC_EXAMPLE(moduleFilePath, configImportPath, isJavaScript) {
-  return "".concat(isJavaScript ? "// @ts-check\n" : "", "/**\n * Val example file - generated by @valbuild/init\n **/\n\nimport {\n  s /* s = schema */,\n  c /* c = content */,").concat(isJavaScript ? "" : "\n  type t /* t = type */,", "\n} from \"").concat(configImportPath, "\";\n\n/**\n * This is the schema for the content. It defines the structure of the content and the types of each field.\n *\n * @docs https://val.build/docs/api-reference\n */\nexport const testSchema = s.object({\n  /**\n   * Basic text field\n   */\n  text: s.string(),\n\n  /**\n   * Nullable are optional fields in the UI that can be null or not\n   */\n  optionals: s.string().nullable(),\n\n  arrays: s.array(s.string()),\n  /**\n   * Records are objects where entries can be added. Useful for array-like structures where you would use a key to uniquely identify each entry.\n   */\n  records: s.record(s.string()),\n\n  /**\n   * Rich text can be used for multiline text, but also for more complex text editing capabilities like links, images, lists, etc.\n   *\n   * @docs https://val.build/docs/api-reference/schema-types/richtext\n   *\n   * @see ValRichText will render rich text\n   */\n  richText: s.richtext({\n    // All features enabled:\n    bold: true,\n    italic: true,\n    lineThrough: true,\n    headings: [\"h1\", \"h2\", \"h3\", \"h4\", \"h5\", \"h6\"],\n    a: true,\n    img: true,\n    ul: true,\n    ol: true,\n  }),\n\n  /**\n   * Images in Val are stored as files in the public folder.\n   *\n   * @docs https://val.build/docs/api-reference/schema-types/image\n   *\n   * When defining content use the following syntax:\n   * @example c.file('/public/myimage.png') // path to the image file, use the VS Code plugin or the `@valbuild/cli validate --fix` command to add metadata\n   *\n   * @see ValImage component to see how to render this in your app\n   */\n  image: s.image().nullable(),\n\n  /**\n   * String enums: presents as a dropdown in the UI\n   */\n  stringEnum: s.union(s.literal(\"lit-0\"), s.literal(\"lit-1\")),\n\n  /**\n   * Raw strings disables the stega (steganography) feature that automatically tags content when using the overlay.\n   * It is useful for slugs and other data that might be processed in code (parsed or matching for equality...)\n   */\n  slug: s.string().raw(),\n\n  /**\n   * Object unions: presents as a dropdown in the UI and the different fields\n   *\n   * @docs https://val.build/docs/api-reference/schema-types/union\n   */\n  objectUnions: s.union(\n    \"type\",\n    s.object({\n      type: s.literal(\"page-type-1\"),\n      value: s.number(),\n    }),\n    s.object({\n      type: s.literal(\"page-type-2\"),\n      text: s.string(),\n    })\n  ),\n});\n").concat(isJavaScript ? "" : "\n/**\n * t.inferSchema returns the type of the content.\n * This pattern is useful to type props of components that use this content (partially or whole)\n */\nexport type TestContent = t.inferSchema<typeof testSchema>;\n", "\n\n/**\n * This is the content definition. Add your content below.\n *\n * NOTE: the first argument, module id, must match the path of the file.\n */\nexport default c.define(\"").concat(moduleFilePath, "\", testSchema, {\n  text: \"Basic text content\",\n  optionals: null,\n  arrays: [\"A string\"],\n  records: {\n    \"unique-key-1\": \"A string\",\n  },\n  richText: c.richtext`# Title 1\n\n${c.rt.link(\"Val docs\", { href: \"https://val.build/docs\" })}\n\n- List item 1\n- List item 2\n`,\n  image: null,\n  slug: \"test\",\n  objectUnions: {\n    type: \"page-type-2\",\n    text: \"String value\",\n  },\n  stringEnum: \"lit-1\",\n});\n");
+  return "".concat(isJavaScript ? "// @ts-check\n" : "", "/**\n * Val example file - generated by @valbuild/init\n **/\n\nimport {\n  s /* s = schema */,\n  c /* c = content */,").concat(isJavaScript ? "" : "\n  type t /* t = type */,", "\n} from \"").concat(configImportPath, "\";\n\n/**\n * This is the schema for the content. It defines the structure of the content and the types of each field.\n *\n * @docs https://val.build/docs/api-reference\n */\nexport const testSchema = s.object({\n  /**\n   * Basic text field\n   */\n  text: s.string(),\n\n  /**\n   * Nullable are optional fields in the UI that can be null or not\n   */\n  optionals: s.string().nullable(),\n\n  arrays: s.array(s.string()),\n  /**\n   * Records are objects where entries can be added. Useful for array-like structures where you would use a key to uniquely identify each entry.\n   */\n  records: s.record(s.string()),\n\n  /**\n   * Rich text can be used for multiline text, but also for more complex text editing capabilities like links, images, lists, etc.\n   *\n   * @docs https://val.build/docs/api-reference/schema-types/richtext\n   *\n   * @see ValRichText will render rich text\n   */\n  richText: s.richtext({\n    // styling:\n    style: {\n      bold: true, // enables bold\n      italic: true, // enables italic text\n      lineThrough: true, // enables line/strike-through\n    },\n    // block-level elements:\n    block: {\n      // tags:\n      h1: true, // enables h1\n      h2: true,\n      h3: true,\n      h4: true,\n      h5: true,\n      h6: true,\n      ul: true, // enables unordered lists\n      ol: true, // enables ordered lists\n    },\n    // inline elements:\n    inline: {\n      a: true,\n      img: true,\n    },\n  }),\n\n  /**\n   * Images in Val are stored as files in the public folder.\n   *\n   * @docs https://val.build/docs/api-reference/schema-types/image\n   *\n   * When defining content use the following syntax:\n   * @example c.file('/public/myimage.png') // path to the image file, use the VS Code plugin or the `@valbuild/cli validate --fix` command to add metadata\n   *\n   * @see ValImage component to see how to render this in your app\n   */\n  image: s.image().nullable(),\n\n  /**\n   * String enums: presents as a dropdown in the UI\n   */\n  stringEnum: s.union(s.literal(\"lit-0\"), s.literal(\"lit-1\")),\n\n  /**\n   * Raw strings disables the stega (steganography) feature that automatically tags content when using the overlay.\n   * It is useful for slugs and other data that might be processed in code (parsed or matching for equality...)\n   */\n  slug: s.string().raw(),\n\n  /**\n   * Object unions: presents as a dropdown in the UI and the different fields\n   *\n   * @docs https://val.build/docs/api-reference/schema-types/union\n   */\n  objectUnions: s.union(\n    \"type\",\n    s.object({\n      type: s.literal(\"page-type-1\"),\n      value: s.number(),\n    }),\n    s.object({\n      type: s.literal(\"page-type-2\"),\n      text: s.string(),\n    })\n  ),\n});\n").concat(isJavaScript ? "" : "\n/**\n * t.inferSchema returns the type of the content.\n * This pattern is useful to type props of components that use this content (partially or whole)\n */\nexport type TestContent = t.inferSchema<typeof testSchema>;\n", "\n\n/**\n * This is the content definition. Add your content below.\n *\n * NOTE: the first argument, module id, must match the path of the file.\n */\nexport default c.define(\"").concat(moduleFilePath, "\", testSchema, {\n  text: \"Basic text content\",\n  optionals: null,\n  arrays: [\"A string\"],\n  records: {\n    \"unique-key-1\": \"A string\",\n  },\n  richText: [\n    { tag: \"h1\", children: [\"Title 1\"] },\n    {\n      tag: \"p\",\n      children: [\n        { tag: \"a\", href: \"https://val.build/docs\", children: [\"Val docs\"] },\n      ],\n    },\n    {\n      tag: \"ul\",\n      children: [\n        { tag: \"li\", children: [{ tag: \"p\", children: [\"List item 1\"] }] },\n        { tag: \"li\", children: [{ tag: \"p\", children: [\"List item 2\"] }] },\n      ],\n    },\n  ],\n  image: null,\n  slug: \"test\",\n  objectUnions: {\n    type: \"page-type-2\",\n    text: \"String value\",\n  },\n  stringEnum: \"lit-1\",\n});\n");
 };
 
 function error(message) {
@@ -1211,32 +1211,42 @@ function _plan() {
             path: valConfigPath,
             source: VAL_CONFIG(!!analysis.isTypeScript, {})
           };
-          _context3.next = 129;
+          if (defaultAnswers) {
+            _context3.next = 133;
+            break;
+          }
+          _context3.next = 130;
           return prompts.confirm({
             message: "Include example Val files?",
             "default": true
           });
-        case 129:
-          _answer4 = _context3.sent;
+        case 130:
+          _context3.t4 = _context3.sent;
+          _context3.next = 134;
+          break;
+        case 133:
+          _context3.t4 = true;
+        case 134:
+          _answer4 = _context3.t4;
           if (!_answer4) {
-            _context3.next = 138;
+            _context3.next = 143;
             break;
           }
           exampleDir = path__default["default"].join(analysis.srcDir, "examples", "val");
           examplePath = path__default["default"].join(exampleDir, "example.val." + (analysis.isJavaScript ? "js" : "ts"));
           exampleImport = path__default["default"].relative(exampleDir, valConfigPath).replace(".js", "").replace(".ts", "");
           if (analysis.packageJsonDir) {
-            _context3.next = 136;
+            _context3.next = 141;
             break;
           }
           throw Error("Could not detect package.json directory! This is a Val bug.");
-        case 136:
+        case 141:
           _exampleModuleFilePath = "/".concat(path__default["default"].relative(analysis.packageJsonDir, examplePath));
           plan.includeExample = {
             path: examplePath,
             source: BASIC_EXAMPLE(_exampleModuleFilePath, exampleImport, !!analysis.isJavaScript)
           };
-        case 138:
+        case 143:
           valModulesDir = analysis.root;
           valModulesImport = path__default["default"].relative(valModulesDir, valConfigPath).replace(".js", "").replace(".ts", "");
           exampleModuleFilePath = plan.includeExample ? plan.includeExample.path : undefined;
@@ -1270,28 +1280,28 @@ function _plan() {
           };
 
           // Util files:
-        case 155:
+        case 160:
           if (!(plan.createValClient === undefined)) {
-            _context3.next = 167;
+            _context3.next = 172;
             break;
           }
           if (defaultAnswers) {
-            _context3.next = 162;
+            _context3.next = 167;
             break;
           }
-          _context3.next = 159;
+          _context3.next = 164;
           return prompts.confirm({
             message: "Setup useVal for Client Components",
             "default": true
           });
-        case 159:
-          _context3.t4 = _context3.sent;
-          _context3.next = 163;
+        case 164:
+          _context3.t5 = _context3.sent;
+          _context3.next = 168;
           break;
-        case 162:
-          _context3.t4 = true;
-        case 163:
-          _answer5 = _context3.t4;
+        case 167:
+          _context3.t5 = true;
+        case 168:
+          _answer5 = _context3.t5;
           if (_answer5) {
             plan.createValClient = {
               path: path__default["default"].join(valUtilsDir, analysis.isTypeScript ? "val.client.ts" : "val.client.js"),
@@ -1300,30 +1310,30 @@ function _plan() {
           } else {
             plan.createValClient = false;
           }
-          _context3.next = 155;
+          _context3.next = 160;
           break;
-        case 167:
+        case 172:
           if (!(plan.createValRsc === undefined)) {
-            _context3.next = 179;
+            _context3.next = 184;
             break;
           }
           if (defaultAnswers) {
-            _context3.next = 174;
+            _context3.next = 179;
             break;
           }
-          _context3.next = 171;
+          _context3.next = 176;
           return prompts.confirm({
             message: "Setup fetchVal for React Server Components",
             "default": true
           });
-        case 171:
-          _context3.t5 = _context3.sent;
-          _context3.next = 175;
+        case 176:
+          _context3.t6 = _context3.sent;
+          _context3.next = 180;
           break;
-        case 174:
-          _context3.t5 = true;
-        case 175:
-          _answer6 = _context3.t5;
+        case 179:
+          _context3.t6 = true;
+        case 180:
+          _answer6 = _context3.t6;
           if (_answer6) {
             plan.createValRsc = {
               path: path__default["default"].join(valUtilsDir, analysis.isTypeScript ? "val.rsc.ts" : "val.rsc.js"),
@@ -1332,24 +1342,24 @@ function _plan() {
           } else {
             plan.createValRsc = false;
           }
-          _context3.next = 167;
+          _context3.next = 172;
           break;
-        case 179:
+        case 184:
           // 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 = 209;
+            _context3.next = 214;
             break;
           }
           if (analysis.appRouterLayoutFile) {
-            _context3.next = 184;
+            _context3.next = 189;
             break;
           }
           error("Failed to read app router layout file");
           return _context3.abrupt("return", {
             abort: true
           });
-        case 184:
+        case 189:
           res = transformNextAppRouterValProvider({
             path: analysis.appRouterLayoutPath,
             source: analysis.appRouterLayoutFile
@@ -1373,43 +1383,43 @@ function _plan() {
             }
           });
           if (defaultAnswers) {
-            _context3.next = 194;
+            _context3.next = 199;
             break;
           }
-          _context3.next = 191;
+          _context3.next = 196;
           return prompts.confirm({
             message: "Automatically patch ".concat(analysis.appRouterLayoutPath, " file?"),
             "default": true
           });
-        case 191:
-          _context3.t6 = _context3.sent;
-          _context3.next = 195;
+        case 196:
+          _context3.t7 = _context3.sent;
+          _context3.next = 200;
           break;
-        case 194:
-          _context3.t6 = true;
-        case 195:
-          _answer7 = _context3.t6;
+        case 199:
+          _context3.t7 = true;
+        case 200:
+          _answer7 = _context3.t7;
           if (!_answer7) {
-            _context3.next = 208;
+            _context3.next = 213;
             break;
           }
           if (defaultAnswers) {
-            _context3.next = 203;
+            _context3.next = 208;
             break;
           }
-          _context3.next = 200;
+          _context3.next = 205;
           return prompts.confirm({
             message: "Do you accept the following patch:\n".concat(s, "\n"),
             "default": true
           });
-        case 200:
-          _context3.t7 = _context3.sent;
-          _context3.next = 204;
+        case 205:
+          _context3.t8 = _context3.sent;
+          _context3.next = 209;
           break;
-        case 203:
-          _context3.t7 = true;
-        case 204:
-          _answer8 = _context3.t7;
+        case 208:
+          _context3.t8 = true;
+        case 209:
+          _answer8 = _context3.t8;
           if (!_answer8) {
             warn(NO_PATCH_WARNING);
             plan.updateAppLayout = false;
@@ -1419,70 +1429,70 @@ function _plan() {
               source: res
             };
           }
-          _context3.next = 209;
+          _context3.next = 214;
           break;
-        case 208:
+        case 213:
           warn(NO_PATCH_WARNING);
-        case 209:
+        case 214:
           if (analysis.pagesRouter) {
             warn(NO_PATCH_WARNING);
           }
           if (!analysis.valEslintVersion) {
-            _context3.next = 241;
+            _context3.next = 246;
             break;
           }
           if (!analysis.isValEslintRulesConfigured) {
-            _context3.next = 215;
+            _context3.next = 220;
             break;
           }
           warn("  @valbuild/eslint-plugin rules: already configured");
-          _context3.next = 241;
+          _context3.next = 246;
           break;
-        case 215:
+        case 220:
           if (!analysis.eslintRcJsPath) {
-            _context3.next = 219;
+            _context3.next = 224;
             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 = 241;
+          _context3.next = 246;
           break;
-        case 219:
+        case 224:
           if (!analysis.eslintRcJsonPath) {
-            _context3.next = 240;
+            _context3.next = 245;
             break;
           }
           if (defaultAnswers) {
-            _context3.next = 226;
+            _context3.next = 231;
             break;
           }
-          _context3.next = 223;
+          _context3.next = 228;
           return prompts.confirm({
             message: "Patch eslintrc.json to use the recommended Val eslint rules?",
             "default": true
           });
-        case 223:
-          _context3.t8 = _context3.sent;
-          _context3.next = 227;
+        case 228:
+          _context3.t9 = _context3.sent;
+          _context3.next = 232;
           break;
-        case 226:
-          _context3.t8 = true;
-        case 227:
-          _answer9 = _context3.t8;
+        case 231:
+          _context3.t9 = true;
+        case 232:
+          _answer9 = _context3.t9;
           if (!_answer9) {
-            _context3.next = 238;
+            _context3.next = 243;
             break;
           }
           currentEslintRc = fs__default["default"].readFileSync(analysis.eslintRcJsonPath, "utf-8");
           parsedEslint = JSON.parse(currentEslintRc);
           if (!(_typeof(parsedEslint) !== "object")) {
-            _context3.next = 234;
+            _context3.next = 239;
             break;
           }
           error("Could not patch eslint: ".concat(analysis.eslintRcJsonPath, " was not an object"));
           return _context3.abrupt("return", {
             abort: true
           });
-        case 234:
+        case 239:
           if (typeof parsedEslint["extends"] === "string") {
             parsedEslint["extends"] = [parsedEslint["extends"]];
           }
@@ -1492,23 +1502,33 @@ function _plan() {
             path: analysis.eslintRcJsonPath,
             source: JSON.stringify(parsedEslint, null, 2) + "\n"
           };
-        case 238:
-          _context3.next = 241;
+        case 243:
+          _context3.next = 246;
           break;
-        case 240:
+        case 245:
           warn("Cannot patch eslint: failed to find eslint config file");
-        case 241:
+        case 246:
           if (!analysis.gitIgnorePath) {
-            _context3.next = 248;
+            _context3.next = 258;
+            break;
+          }
+          if (defaultAnswers) {
+            _context3.next = 253;
             break;
           }
-          _context3.next = 244;
+          _context3.next = 250;
           return prompts.confirm({
             message: "Append .gitignore entry for Val cache? (recommended)",
             "default": true
           });
-        case 244:
-          _answer10 = _context3.sent;
+        case 250:
+          _context3.t10 = _context3.sent;
+          _context3.next = 254;
+          break;
+        case 253:
+          _context3.t10 = true;
+        case 254:
+          _answer10 = _context3.t10;
           if (_answer10) {
             plan.updateGitIgnore = {
               path: analysis.gitIgnorePath,
@@ -1517,49 +1537,59 @@ function _plan() {
           } else {
             plan.updateGitIgnore = false;
           }
-          _context3.next = 249;
+          _context3.next = 259;
           break;
-        case 248:
+        case 258:
           plan.updateGitIgnore = false;
-        case 249:
-          _context3.next = 251;
+        case 259:
+          if (defaultAnswers) {
+            _context3.next = 265;
+            break;
+          }
+          _context3.next = 262;
           return prompts.confirm({
             message: "Add the Val Build IntelliSense to .vscode/extensions.json?",
             "default": true
           });
-        case 251:
-          _answer11 = _context3.sent;
+        case 262:
+          _context3.t11 = _context3.sent;
+          _context3.next = 266;
+          break;
+        case 265:
+          _context3.t11 = true;
+        case 266:
+          _answer11 = _context3.t11;
           if (!_answer11) {
-            _context3.next = 277;
+            _context3.next = 292;
             break;
           }
           vscodeDir = path__default["default"].join(analysis.root, ".vscode");
           settingsPath = path__default["default"].join(vscodeDir, "extensions.json");
           currentSettings = {};
-          _context3.prev = 256;
+          _context3.prev = 271;
           currentSettingsFile = fs__default["default"].readFileSync(settingsPath, "utf-8");
           if (!currentSettingsFile) {
-            _context3.next = 267;
+            _context3.next = 282;
             break;
           }
-          _context3.prev = 259;
+          _context3.prev = 274;
           currentSettings = JSON.parse(currentSettingsFile);
-          _context3.next = 267;
+          _context3.next = 282;
           break;
-        case 263:
-          _context3.prev = 263;
-          _context3.t9 = _context3["catch"](259);
-          warn("Failed to parse VS Code extensions.json found here: ".concat(settingsPath, ".").concat(_context3.t9 instanceof Error ? "Parse error: ".concat(_context3.t9.message) : ""));
+        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) : ""));
           return _context3.abrupt("return", {
             abort: true
           });
-        case 267:
-          _context3.next = 271;
+        case 282:
+          _context3.next = 286;
           break;
-        case 269:
-          _context3.prev = 269;
-          _context3.t10 = _context3["catch"](256);
-        case 271:
+        case 284:
+          _context3.prev = 284;
+          _context3.t13 = _context3["catch"](271);
+        case 286:
           currentRecommendations =
           // eslint-disable-next-line @typescript-eslint/no-explicit-any
           currentSettings.recommendations;
@@ -1573,17 +1603,17 @@ function _plan() {
             path: settingsPath,
             source: JSON.stringify(currentSettings, null, 2)
           };
-          _context3.next = 278;
+          _context3.next = 293;
           break;
-        case 277:
+        case 292:
           plan.updateVSCodeSettings = false;
-        case 278:
+        case 293:
           return _context3.abrupt("return", plan);
-        case 279:
+        case 294:
         case "end":
           return _context3.stop();
       }
-    }, _callee3, null, [[256, 269], [259, 263]]);
+    }, _callee3, null, [[271, 284], [274, 278]]);
   }));
   return _plan.apply(this, arguments);
 }