@valbuild/init 0.60.18 → 0.60.20

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

@@ -406,6 +406,59 @@ function _slicedToArray(arr, i) {
   return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest();
 }
 
+function toPrimitive(t, r) {
+  if ("object" != typeof t || !t) return t;
+  var e = t[Symbol.toPrimitive];
+  if (void 0 !== e) {
+    var i = e.call(t, r || "default");
+    if ("object" != typeof i) return i;
+    throw new TypeError("@@toPrimitive must return a primitive value.");
+  }
+  return ("string" === r ? String : Number)(t);
+}
+
+function toPropertyKey(t) {
+  var i = toPrimitive(t, "string");
+  return "symbol" == typeof i ? i : String(i);
+}
+
+function _defineProperty(obj, key, value) {
+  key = toPropertyKey(key);
+  if (key in obj) {
+    Object.defineProperty(obj, key, {
+      value: value,
+      enumerable: true,
+      configurable: true,
+      writable: true
+    });
+  } else {
+    obj[key] = value;
+  }
+  return obj;
+}
+
+function ownKeys(e, r) {
+  var t = Object.keys(e);
+  if (Object.getOwnPropertySymbols) {
+    var o = Object.getOwnPropertySymbols(e);
+    r && (o = o.filter(function (r) {
+      return Object.getOwnPropertyDescriptor(e, r).enumerable;
+    })), t.push.apply(t, o);
+  }
+  return t;
+}
+function _objectSpread2(e) {
+  for (var r = 1; r < arguments.length; r++) {
+    var t = null != arguments[r] ? arguments[r] : {};
+    r % 2 ? ownKeys(Object(t), !0).forEach(function (r) {
+      _defineProperty(e, r, t[r]);
+    }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) {
+      Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r));
+    });
+  }
+  return e;
+}
+
 function transformNextAppRouterValProvider(fileInfo, api, options) {
   if (!options.configImportPath) {
     throw new Error("configImportPath is required");
@@ -451,7 +504,7 @@ function transformNextAppRouterValProvider(fileInfo, api, options) {
 
 var packageJson = {
 	name: "@valbuild/init",
-	version: "0.60.18",
+	version: "0.60.20",
 	description: "Initialize a new val.build project",
 	exports: {
 		"./main": {
@@ -522,12 +575,15 @@ var VAL_API_ROUTER = function VAL_API_ROUTER(valServerPath) {
 var VAL_APP_PAGE = function VAL_APP_PAGE(configImportPath) {
   return "import { ValApp } from \"@valbuild/next\";\nimport { config } from \"".concat(configImportPath, "\";\n\nexport default function Val() {\n  return <ValApp config={config} />;\n}\n");
 };
+var BASIC_EXAMPLE = function BASIC_EXAMPLE(moduleId, 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   * Optional fields are marked with `.optional()`\n   */\n  optionals: s.string().optional(),\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().optional(),\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(moduleId, "\", 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");
+};
 
 function error(message) {
-  console.error(chalk.red("❌ ERROR: ") + message);
+  console.error(chalk.red("  ❌ ERROR: ") + message);
 }
 function warn(message) {
-  console.error(chalk.yellow("⚠️  WARN:") + message);
+  console.error(chalk.yellow("  ⚠️  WARN:" + message));
 }
 function info(message) {
   var opts = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
@@ -536,7 +592,7 @@ function info(message) {
     return;
   }
   if (opts.isGood) {
-    console.log(chalk.green("✅      ") + message);
+    console.log(chalk.hex("#37cd99")("  V") + message);
     return;
   }
   console.log(message);
@@ -561,7 +617,7 @@ function _init() {
         case 0:
           root = _args2.length > 0 && _args2[0] !== undefined ? _args2[0] : process.cwd();
           _ref = _args2.length > 1 && _args2[1] !== undefined ? _args2[1] : {}, defaultAnswers = _ref.yes;
-          info('Initializing Val in "' + root + '"...\n');
+          info("Initializing " + chalk.bgBlack.hex("#37cd99")("Val") + ' in "' + root + '"...\n');
           process.stdout.write("Analyzing project...");
           _context2.next = 6;
           return analyze(path.resolve(root), walk(path.resolve(root)));
@@ -608,7 +664,7 @@ function walk(dir) {
 }
 var analyze = /*#__PURE__*/function () {
   var _ref2 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee(root, files) {
-    var analysis, packageJsonPath, packageJsonText, _packageJson, _semver$minVersion, minNextVersion, _semver$minVersion2, minValVersion, pagesRouterAppPath, appRouterLayoutPath, git, gitStatus, gitRemoteOrigin;
+    var analysis, packageJsonPath, packageJsonText, _packageJson, _semver$minVersion, minNextVersion, _semver$minVersion2, minValVersion, pagesRouterAppPath, appRouterLayoutPath, git, gitStatus, gitRemoteOrigin, parts, owner, repo, gitIgnorePath;
     return _regeneratorRuntime().wrap(function _callee$(_context) {
       while (1) switch (_context.prev = _context.next) {
         case 0:
@@ -720,18 +776,32 @@ var analyze = /*#__PURE__*/function () {
           analysis.hasGit = true;
           analysis.isGitHub = gitRemoteOrigin ? !!gitRemoteOrigin.includes("github.com") : false;
           analysis.isGitClean = getGitStatusIsClean(gitStatus);
-          _context.next = 46;
+          // get owner and repo from git remote:
+          if (gitRemoteOrigin) {
+            // Split the URL by colon
+            parts = gitRemoteOrigin.split(":"); // Extract owner and repo
+            owner = parts[0].split("@")[1];
+            repo = parts[1].replace(".git", ""); // Remove .git extension if present
+            analysis.gitRemote = {
+              owner: owner,
+              repo: repo
+            };
+          }
+          _context.next = 47;
           break;
-        case 44:
-          _context.prev = 44;
+        case 45:
+          _context.prev = 45;
           _context.t1 = _context["catch"](31);
-        case 46:
-          return _context.abrupt("return", analysis);
         case 47:
+          gitIgnorePath = path.join(root, ".gitignore");
+          analysis.gitIgnorePath = gitIgnorePath;
+          analysis.gitIgnoreFile = fs.readFileSync(gitIgnorePath, "utf-8");
+          return _context.abrupt("return", analysis);
+        case 51:
         case "end":
           return _context.stop();
       }
-    }, _callee, null, [[8, 17], [31, 44]]);
+    }, _callee, null, [[8, 17], [31, 45]]);
   }));
   return function analyze(_x, _x2) {
     return _ref2.apply(this, arguments);
@@ -768,6 +838,19 @@ function _plan() {
       _answer7,
       currentEslintRc,
       parsedEslint,
+      _answer8,
+      _answer9,
+      vscodeDir,
+      settingsPath,
+      currentSettings,
+      currentSettingsFile,
+      currentRecommendations,
+      valBuildIntelliSense,
+      _answer10,
+      exampleDir,
+      examplePath,
+      exampleImport,
+      exampleModuleId,
       _args3 = arguments;
     return _regeneratorRuntime().wrap(function _callee3$(_context3) {
       while (1) switch (_context3.prev = _context3.next) {
@@ -804,7 +887,7 @@ function _plan() {
             _context3.next = 15;
             break;
           }
-          info("  Source dir: " + analysis.root, {
+          info("  Source dir: " + analysis.srcDir, {
             isGood: true
           });
           _context3.next = 17;
@@ -1304,12 +1387,117 @@ function _plan() {
         case 202:
           warn("Cannot patch eslint: failed to find eslint config file");
         case 203:
+          if (!analysis.gitIgnorePath) {
+            _context3.next = 210;
+            break;
+          }
+          _context3.next = 206;
+          return confirm({
+            message: "Append .gitignore entry for Val cache? (recommended)",
+            "default": true
+          });
+        case 206:
+          _answer8 = _context3.sent;
+          if (_answer8) {
+            plan.updateGitIgnore = {
+              path: analysis.gitIgnorePath,
+              source: (analysis.gitIgnoreFile ? "".concat(analysis.gitIgnoreFile, "\n\n") : "") + "# Val local cache\n.val\n"
+            };
+          } else {
+            plan.updateGitIgnore = false;
+          }
+          _context3.next = 211;
+          break;
+        case 210:
+          plan.updateGitIgnore = false;
+        case 211:
+          _context3.next = 213;
+          return confirm({
+            message: "Add the Val Build IntelliSense to .vscode/extensions.json?",
+            "default": true
+          });
+        case 213:
+          _answer9 = _context3.sent;
+          if (!_answer9) {
+            _context3.next = 239;
+            break;
+          }
+          vscodeDir = path.join(analysis.root, ".vscode");
+          settingsPath = path.join(vscodeDir, "extensions.json");
+          currentSettings = {};
+          _context3.prev = 218;
+          currentSettingsFile = fs.readFileSync(settingsPath, "utf-8");
+          if (!currentSettingsFile) {
+            _context3.next = 229;
+            break;
+          }
+          _context3.prev = 221;
+          currentSettings = JSON.parse(currentSettingsFile);
+          _context3.next = 229;
+          break;
+        case 225:
+          _context3.prev = 225;
+          _context3.t8 = _context3["catch"](221);
+          warn("Failed to parse VS Code extensions.json found here: ".concat(settingsPath, ".").concat(_context3.t8 instanceof Error ? "Parse error: ".concat(_context3.t8.message) : ""));
+          return _context3.abrupt("return", {
+            abort: true
+          });
+        case 229:
+          _context3.next = 233;
+          break;
+        case 231:
+          _context3.prev = 231;
+          _context3.t9 = _context3["catch"](218);
+        case 233:
+          // eslint-disable-next-line @typescript-eslint/no-explicit-any
+          currentRecommendations = currentSettings.recommendations;
+          valBuildIntelliSense = "valbuild.vscode-val-build";
+          if (!currentRecommendations.includes(valBuildIntelliSense)) {
+            currentSettings = _objectSpread2(_objectSpread2({}, currentSettings), {}, {
+              recommendations: (currentRecommendations || []).concat(valBuildIntelliSense)
+            });
+          }
+          plan.updateVSCodeSettings = {
+            path: settingsPath,
+            source: JSON.stringify(currentSettings, null, 2)
+          };
+          _context3.next = 240;
+          break;
+        case 239:
+          plan.updateVSCodeSettings = false;
+        case 240:
+          _context3.next = 242;
+          return confirm({
+            message: "Include example Val files?",
+            "default": true
+          });
+        case 242:
+          _answer10 = _context3.sent;
+          if (!_answer10) {
+            _context3.next = 251;
+            break;
+          }
+          exampleDir = path.join(analysis.srcDir, "examples", "val");
+          examplePath = path.join(exampleDir, "example.val." + (analysis.isJavaScript ? "js" : "ts"));
+          exampleImport = path.relative(exampleDir, valConfigPath).replace(".js", "").replace(".ts", "");
+          if (analysis.packageJsonDir) {
+            _context3.next = 249;
+            break;
+          }
+          throw Error("Could not detect package.json directory! This is a Val bug.");
+        case 249:
+          exampleModuleId = "/".concat(path.relative(analysis.packageJsonDir, examplePath).replace(".val", "").replace(".js", "").replace(".ts", ""));
+          plan.includeExample = {
+            path: examplePath,
+            source: BASIC_EXAMPLE(exampleModuleId, exampleImport, !!analysis.isJavaScript)
+          };
+        case 251:
           return _context3.abrupt("return", plan);
-        case 204:
+        case 252:
         case "end":
           return _context3.stop();
       }
-    }, _callee3);
+    }, _callee3, null, [[218, 231], [221, 225]]);
   }));
   return _plan.apply(this, arguments);
 }
@@ -1318,7 +1506,7 @@ function execute(_x4) {
 }
 function _execute() {
   _execute = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee4(plan) {
-    var _i, _Object$entries, _Object$entries$_i, key, fileOp;
+    var _i, _Object$entries, _Object$entries$_i, key, maybeFileOp;
     return _regeneratorRuntime().wrap(function _callee4$(_context4) {
       while (1) switch (_context4.prev = _context4.next) {
         case 0:
@@ -1336,10 +1524,13 @@ function _execute() {
         case 4:
           info("Executing...");
           for (_i = 0, _Object$entries = Object.entries(plan); _i < _Object$entries.length; _i++) {
-            _Object$entries$_i = _slicedToArray(_Object$entries[_i], 2), key = _Object$entries$_i[0], fileOp = _Object$entries$_i[1];
-            writeFile(fileOp, plan.root, key.startsWith("update"));
+            _Object$entries$_i = _slicedToArray(_Object$entries[_i], 2), key = _Object$entries$_i[0], maybeFileOp = _Object$entries$_i[1];
+            if (isFileOp(maybeFileOp)) {
+              writeFile(maybeFileOp, plan.root, key.startsWith("update"));
+            }
           }
-        case 6:
+          info("\n  \nVal was successfully initialized!\n\n  Start the application:\n\n  $ ".concat(chalk.gray("npm run dev"), "\n\n  Open (assumes http://localhost:3000):\n\n  ").concat(chalk.bgBlack.hex("#37cd99").underline("http://localhost:3000/val"), "\n\n  When you want to enable editor support, import the project by opening the following link:\n  \n  ").concat(chalk.bgBlack.hex("#37cd99").underline("https://app.val.build/orgs/new".concat(plan.gitRemote ? "?org=".concat(encodeURIComponent(plan.gitRemote.owner), "&owner=").concat(encodeURIComponent(plan.gitRemote.owner), "&repo=").concat(encodeURIComponent(plan.gitRemote.repo)) : "")), "\n\n"));
+        case 7:
         case "end":
           return _context4.stop();
       }
@@ -1348,7 +1539,7 @@ function _execute() {
   return _execute.apply(this, arguments);
 }
 function writeFile(fileOp, rootDir, isUpdate) {
-  if (fileOp && typeof fileOp !== "boolean" && typeof fileOp !== "string") {
+  if (fileOp) {
     fs.mkdirSync(path.dirname(fileOp.path), {
       recursive: true
     });
@@ -1378,6 +1569,9 @@ function getGitStatusIsClean(gitStatus) {
   }
   return false;
 }
+function isFileOp(maybeFileOp) {
+  return typeof maybeFileOp !== "boolean" && typeof maybeFileOp !== "string" && _typeof(maybeFileOp) === "object" && !!maybeFileOp && "path" in maybeFileOp && "source" in maybeFileOp && typeof maybeFileOp.path === "string" && typeof maybeFileOp.source === "string";
+}
 
 function main() {
   return _main.apply(this, arguments);

package/package.json

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

package/src/init.ts

@@ -9,6 +9,7 @@ import jcs from "jscodeshift";
 import semver from "semver";
 import packageJson from "../package.json";
 import {
+  BASIC_EXAMPLE,
   VAL_API_ROUTER,
   VAL_APP_PAGE,
   VAL_CLIENT,
@@ -26,7 +27,13 @@ export async function init(
   root: string = process.cwd(),
   { yes: defaultAnswers }: { yes?: boolean } = {}
 ) {
-  logger.info('Initializing Val in "' + root + '"...\n');
+  logger.info(
+    "Initializing " +
+      chalk.bgBlack.hex("#37cd99")("Val") +
+      ' in "' +
+      root +
+      '"...\n'
+  );
   process.stdout.write("Analyzing project...");
   const analysis = await analyze(path.resolve(root), walk(path.resolve(root)));
   // reset cursor:
@@ -96,6 +103,12 @@ type Analysis = Partial<{
   hasGit: boolean;
   isGitHub: boolean;
   isGitClean: boolean | "packages";
+  gitIgnorePath: string;
+  gitIgnoreFile?: string;
+  gitRemote: {
+    owner: string;
+    repo: string;
+  };
 
   // TODO:
   // check if modules are used
@@ -208,9 +221,26 @@ const analyze = async (root: string, files: string[]): Promise<Analysis> => {
       ? !!gitRemoteOrigin.includes("github.com")
       : false;
     analysis.isGitClean = getGitStatusIsClean(gitStatus);
+    // get owner and repo from git remote:
+    if (gitRemoteOrigin) {
+      // Split the URL by colon
+      const parts = gitRemoteOrigin.split(":");
+
+      // Extract owner and repo
+      const owner = parts[0].split("@")[1];
+      const repo = parts[1].replace(".git", ""); // Remove .git extension if present
+
+      analysis.gitRemote = {
+        owner,
+        repo,
+      };
+    }
   } catch (err) {
     // console.error(err);
   }
+  const gitIgnorePath = path.join(root, ".gitignore");
+  analysis.gitIgnorePath = gitIgnorePath;
+  analysis.gitIgnoreFile = fs.readFileSync(gitIgnorePath, "utf-8");
   return analysis;
 };
 
@@ -232,6 +262,15 @@ type Plan = Partial<{
   useJavascript: boolean;
   abort: boolean;
   ignoreGitDirty: boolean;
+  updateGitIgnore: false | FileOp;
+  gitRemote:
+    | false
+    | {
+        owner: string;
+        repo: string;
+      };
+  includeExample: false | FileOp;
+  updateVSCodeSettings: false | FileOp;
 }>;
 
 async function plan(
@@ -255,7 +294,7 @@ async function plan(
     return { abort: true };
   }
   if (analysis.srcDir) {
-    logger.info("  Source dir: " + analysis.root, { isGood: true });
+    logger.info("  Source dir: " + analysis.srcDir, { isGood: true });
   } else {
     logger.error("Failed to determine source directory");
     return { abort: true };
@@ -610,6 +649,113 @@ async function plan(
     }
   }
 
+  {
+    if (analysis.gitIgnorePath) {
+      const answer = await confirm({
+        message: "Append .gitignore entry for Val cache? (recommended)",
+        default: true,
+      });
+      if (answer) {
+        plan.updateGitIgnore = {
+          path: analysis.gitIgnorePath,
+          source:
+            (analysis.gitIgnoreFile ? `${analysis.gitIgnoreFile}\n\n` : "") +
+            "# Val local cache\n.val\n",
+        };
+      } else {
+        plan.updateGitIgnore = false;
+      }
+    } else {
+      plan.updateGitIgnore = false;
+    }
+  }
+  {
+    const answer = await confirm({
+      message: "Add the Val Build IntelliSense to .vscode/extensions.json?",
+      default: true,
+    });
+    if (answer) {
+      const vscodeDir = path.join(analysis.root, ".vscode");
+      const settingsPath = path.join(vscodeDir, "extensions.json");
+      let currentSettings = {};
+
+      try {
+        const currentSettingsFile = fs.readFileSync(settingsPath, "utf-8");
+        if (currentSettingsFile) {
+          try {
+            currentSettings = JSON.parse(currentSettingsFile);
+          } catch (err) {
+            logger.warn(
+              `Failed to parse VS Code extensions.json found here: ${settingsPath}.${
+                err instanceof Error ? `Parse error: ${err.message}` : ""
+              }`
+            );
+            return {
+              abort: true,
+            };
+          }
+        }
+      } catch {
+        // ignore - dir does not exist (most likely)
+      }
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      const currentRecommendations: string[] = (currentSettings as any)
+        .recommendations;
+      const valBuildIntelliSense = "valbuild.vscode-val-build";
+      if (!currentRecommendations.includes(valBuildIntelliSense)) {
+        currentSettings = {
+          ...currentSettings,
+          recommendations: (currentRecommendations || []).concat(
+            valBuildIntelliSense
+          ),
+        };
+      }
+      plan.updateVSCodeSettings = {
+        path: settingsPath,
+        source: JSON.stringify(currentSettings, null, 2),
+      };
+    } else {
+      plan.updateVSCodeSettings = false;
+    }
+  }
+
+  {
+    const answer = await confirm({
+      message: "Include example Val files?",
+      default: true,
+    });
+    if (answer) {
+      const exampleDir = path.join(analysis.srcDir, "examples", "val");
+      const examplePath = path.join(
+        exampleDir,
+        "example.val." + (analysis.isJavaScript ? "js" : "ts")
+      );
+      const exampleImport = path
+        .relative(exampleDir, valConfigPath)
+        .replace(".js", "")
+        .replace(".ts", "");
+      if (!analysis.packageJsonDir) {
+        throw Error(
+          "Could not detect package.json directory! This is a Val bug."
+        );
+      }
+      const exampleModuleId = `/${path
+        .relative(analysis.packageJsonDir, examplePath)
+        .replace(".val", "")
+        .replace(".js", "")
+        .replace(".ts", "")}`;
+
+      plan.includeExample = {
+        path: examplePath,
+        source: BASIC_EXAMPLE(
+          exampleModuleId,
+          exampleImport,
+          !!analysis.isJavaScript
+        ),
+      };
+    }
+  }
+
   return plan;
 }
 
@@ -621,17 +767,48 @@ async function execute(plan: Plan) {
     return logger.error("Failed to find root directory");
   }
   logger.info("Executing...");
-  for (const [key, fileOp] of Object.entries(plan)) {
-    writeFile(fileOp, plan.root, key.startsWith("update"));
+  for (const [key, maybeFileOp] of Object.entries(plan)) {
+    if (isFileOp(maybeFileOp)) {
+      writeFile(maybeFileOp, plan.root, key.startsWith("update"));
+    }
   }
+  logger.info(`
+  
+Val was successfully initialized!
+
+  Start the application:
+
+  $ ${chalk.gray("npm run dev")}
+
+  Open (assumes http://localhost:3000):
+
+  ${chalk.bgBlack.hex("#37cd99").underline(`http://localhost:3000/val`)}
+
+  When you want to enable editor support, import the project by opening the following link:
+  
+  ${chalk.bgBlack
+    .hex("#37cd99")
+    .underline(
+      `https://app.val.build/orgs/new${
+        plan.gitRemote
+          ? `?org=${encodeURIComponent(
+              plan.gitRemote.owner
+            )}&owner=${encodeURIComponent(
+              plan.gitRemote.owner
+            )}&repo=${encodeURIComponent(plan.gitRemote.repo)}`
+          : ""
+      }`
+    )}
+
+`);
 }
 
 function writeFile(
-  fileOp: string | FileOp | undefined | boolean,
+  fileOp: FileOp | undefined,
   rootDir: string,
   isUpdate: boolean
 ) {
-  if (fileOp && typeof fileOp !== "boolean" && typeof fileOp !== "string") {
+  if (fileOp) {
     fs.mkdirSync(path.dirname(fileOp.path), { recursive: true });
     fs.writeFileSync(fileOp.path, fileOp.source);
     logger.info(
@@ -667,3 +844,16 @@ function getGitStatusIsClean(gitStatus: StatusResult): Analysis["isGitClean"] {
   }
   return false;
 }
+
+function isFileOp(maybeFileOp: unknown): maybeFileOp is FileOp {
+  return (
+    typeof maybeFileOp !== "boolean" &&
+    typeof maybeFileOp !== "string" &&
+    typeof maybeFileOp === "object" &&
+    !!maybeFileOp &&
+    "path" in maybeFileOp &&
+    "source" in maybeFileOp &&
+    typeof maybeFileOp.path === "string" &&
+    typeof maybeFileOp.source === "string"
+  );
+}

package/src/logger.ts

@@ -1,11 +1,11 @@
 import chalk from "chalk";
 
 export function error(message: string) {
-  console.error(chalk.red("❌ ERROR: ") + message);
+  console.error(chalk.red("  ❌ ERROR: ") + message);
 }
 
 export function warn(message: string) {
-  console.error(chalk.yellow("⚠️  WARN:") + message);
+  console.error(chalk.yellow("  ⚠️  WARN:" + message));
 }
 
 export function info(
@@ -17,7 +17,7 @@ export function info(
     return;
   }
   if (opts.isGood) {
-    console.log(chalk.green("✅      ") + message);
+    console.log(chalk.hex("#37cd99")("  V") + message);
     return;
   }
   console.log(message);