@joystick.js/cli-canary 0.0.0-canary.172 → 0.0.0-canary.1721

package/dist/lib/dev/index.js

@@ -1,561 +0,0 @@
-import fs from "fs";
-import path, { dirname } from "path";
-import { fileURLToPath } from "url";
-import child_process from "child_process";
-import chokidar from "chokidar";
-import CLILog from "../CLILog.js";
-import loadSettings from "./loadSettings.js";
-import Loader from "../loader.js";
-import startDatabases from "./startDatabases.js";
-import runTests from "./runTests.js";
-import startHMR from "./startHMR.js";
-import startApp from "./startApp.js";
-import requiredFiles from "./requiredFiles.js";
-import watchlist from "./watchlist.js";
-import getFilesToBuild from "./getFilesToBuild.js";
-import buildFiles from "../build/buildFiles.js";
-import filesToCopy from "../filesToCopy.js";
-import { SETTINGS_FILE_NAME_REGEX } from "../regexes.js";
-import getCodependenciesForFile from "./getCodependenciesForFile.js";
-import removeDeletedDependenciesFromMap from "../build/removeDeletedDependenciesFromMap.js";
-import chalk from "chalk";
-const processIds = [];
-const getDatabaseProcessIds = () => {
-  try {
-    const databaseProcessIds = [];
-    const databases = Object.entries(process._databases || {});
-    for (let i = 0; i < databases?.length; i += 1) {
-      const [_provider, providerConnection] = databases[i];
-      if (providerConnection?.pid) {
-        databaseProcessIds.push(providerConnection.pid);
-      }
-      if (!providerConnection?.pid) {
-        const providerConnections = Object.entries(providerConnection);
-        for (let pc = 0; pc < providerConnections?.length; pc += 1) {
-          const [_connectionName, connection] = providerConnections[pc];
-          if (connection?.pid) {
-            databaseProcessIds.push(connection.pid);
-          }
-        }
-      }
-    }
-    return databaseProcessIds;
-  } catch (exception) {
-    throw new Error(`[dev.getDatabaseProcessIds] ${exception.message}`);
-  }
-};
-const handleSignalEvents = (processIds2 = [], nodeMajorVersion = 0, __dirname = "") => {
-  try {
-    const execArgv = ["--no-warnings"];
-    if (nodeMajorVersion < 19) {
-      execArgv.push("--experimental-specifier-resolution=node");
-    }
-    const cleanupProcess = child_process.fork(
-      path.resolve(`${__dirname}/cleanup.js`),
-      [],
-      {
-        // NOTE: Run in detached mode so when parent process dies, the child still runs
-        // and cleanup completes.
-        detached: true,
-        execArgv,
-        // NOTE: Pipe stdin, stdout, and stderr. IPC establishes a message channel so we
-        // communicate with the child_process.
-        silent: true
-      }
-    );
-    process.cleanupProcess = cleanupProcess;
-    process.on("SIGINT", async () => {
-      const databaseProcessIds = getDatabaseProcessIds();
-      cleanupProcess.send(JSON.stringify({ processIds: [...processIds2, ...databaseProcessIds] }));
-      process.exit();
-    });
-    process.on("SIGTERM", async () => {
-      const databaseProcessIds = getDatabaseProcessIds();
-      cleanupProcess.send(JSON.stringify({ processIds: [...processIds2, ...databaseProcessIds] }));
-      process.exit();
-    });
-  } catch (exception) {
-    throw new Error(`[dev.handleSignalEvents] ${exception.message}`);
-  }
-};
-const handleHMRProcessMessages = (options = {}) => {
-  try {
-    process.hmrProcess.on("message", (message) => {
-      const processMessages = [
-        "SERVER_CLOSED",
-        "HAS_HMR_CONNECTIONS",
-        "HAS_NO_HMR_CONNECTIONS",
-        "HMR_UPDATE_COMPLETED"
-      ];
-      if (!processMessages.includes(message?.type)) {
-        process.loader.stable(message);
-      }
-      if (message?.type === "HAS_HMR_CONNECTIONS") {
-        process.hmrProcess.hasConnections = true;
-      }
-      if (message?.type === "HAS_NO_HMR_CONNECTIONS") {
-        process.hmrProcess.hasConnections = false;
-      }
-      if (message?.type === "HMR_UPDATE_COMPLETED") {
-        setTimeout(() => {
-          handleRestartApplicationProcess({
-            ...options,
-            sessionsBeforeHMRUpdate: message?.sessions
-          });
-        }, 500);
-      }
-    });
-  } catch (exception) {
-    throw new Error(`[dev.handleHMRProcessMessages] ${exception.message}`);
-  }
-};
-const handleHMRProcessSTDIO = () => {
-  try {
-    if (process.hmrProcess) {
-      process.hmrProcess.on("error", (error) => {
-        CLILog(error.toString(), {
-          level: "danger",
-          docs: "https://github.com/cheatcode/joystick"
-        });
-      });
-      process.hmrProcess.stdout.on("data", (data) => {
-        console.log(data.toString());
-      });
-      process.hmrProcess.stderr.on("data", (data) => {
-        process.loader.stop();
-        CLILog(data.toString(), {
-          level: "danger",
-          docs: "https://github.com/cheatcode/joystick"
-        });
-      });
-    }
-  } catch (exception) {
-    throw new Error(`[dev.handleHMRProcessSTDIO] ${exception.message}`);
-  }
-};
-const handleServerProcessMessages = () => {
-  try {
-    process.serverProcess.on("message", (message) => {
-      const processMessages = ["SERVER_CLOSED"];
-      if (!processMessages.includes(message)) {
-        process.loader.stable(message);
-      }
-    });
-  } catch (exception) {
-    throw new Error(`[dev.handleServerProcessMessages] ${exception.message}`);
-  }
-};
-const handleServerProcessSTDIO = (options = {}) => {
-  try {
-    if (process.serverProcess) {
-      process.serverProcess.on("error", (error) => {
-        console.log(error);
-      });
-      process.serverProcess.stdout.on("data", (data) => {
-        const message = data.toString();
-        if (message && message.includes("App running at:") && !options?.watch) {
-          process.loader.stable(message);
-        } else {
-          if (message && !message.includes("BUILD_ERROR")) {
-            console.log(message);
-          }
-        }
-      });
-      process.serverProcess.stderr.on("data", (data) => {
-        process.loader.stop();
-        CLILog(data.toString(), {
-          level: "danger",
-          docs: "https://cheatcode.co/docs/joystick"
-        });
-      });
-    }
-  } catch (exception) {
-    throw new Error(`[dev.handleServerProcessSTDIO] ${exception.message}`);
-  }
-};
-const handleAddOrChangeFile = async (context = {}, path2 = "", options = {}) => {
-  try {
-    if (context.isAddingOrChangingFile) {
-      const codependencies = await getCodependenciesForFile(path2);
-      const fileResults = await buildFiles({
-        files: [path2, ...codependencies?.existing || []],
-        environment: process.env.NODE_ENV
-      });
-      const fileResultsHaveErrors = fileResults.filter((result) => !!result).map(({ success }) => success).includes(false);
-      removeDeletedDependenciesFromMap(codependencies.deleted);
-      if (process.serverProcess && fileResultsHaveErrors) {
-        process.serverProcess.send(
-          JSON.stringify({
-            error: "BUILD_ERROR",
-            paths: fileResults.filter(({ success }) => !success).map(({ path: pathWithError, error }) => ({
-              path: pathWithError,
-              error
-            }))
-          })
-        );
-        return;
-      }
-      if (!fileResultsHaveErrors) {
-        process.initialBuildComplete = true;
-        if (context.isUIUpdate) {
-          handleNotifyHMRClients(context.isHTMLUpdate);
-        } else {
-          handleRestartApplicationProcess(options);
-        }
-      }
-    }
-  } catch (exception) {
-    throw new Error(`[dev.handleAddOrChangeFile] ${exception.message}`);
-  }
-};
-const handleAddDirectory = (context = {}, path2 = "", options = {}) => {
-  try {
-    if (context.isAddDirectory) {
-      fs.mkdirSync(`./.joystick/build/${path2}`);
-      if (context.isUIUpdate) {
-        handleNotifyHMRClients(context.isHTMLUpdate);
-      } else {
-        handleRestartApplicationProcess(options);
-      }
-    }
-  } catch (exception) {
-    throw new Error(`[dev.handleAddDirectory] ${exception.message}`);
-  }
-};
-const handleCopyFile = (context = {}, path2 = "", options = {}) => {
-  try {
-    if (context.isFileToCopy && !context.isDirectory) {
-      fs.writeFileSync(`./.joystick/build/${path2}`, fs.readFileSync(path2));
-      if (context.isUIUpdate) {
-        handleNotifyHMRClients(context.isHTMLUpdate);
-      } else {
-        handleRestartApplicationProcess(options);
-      }
-    }
-  } catch (exception) {
-    throw new Error(`[dev.handleCopyFile] ${exception.message}`);
-  }
-};
-const handleCopyDirectory = (context = {}, path2 = "", options = {}) => {
-  try {
-    if (context.isFileToCopy && context.isDirectory && !context.isExistingDirectoryInBuild) {
-      fs.mkdirSync(`./.joystick/build/${path2}`);
-      if (context.isUIUpdate) {
-        handleNotifyHMRClients(context.isHTMLUpdate);
-      } else {
-        handleRestartApplicationProcess(options);
-      }
-    }
-  } catch (exception) {
-    throw new Error(`[dev.handleCopyDirectory] ${exception.message}`);
-  }
-};
-const handleRestartApplicationProcess = async (options = {}) => {
-  try {
-    if (process.serverProcess && process.serverProcess.pid) {
-      if (!options?.watch) {
-        process.loader.text("Restarting app...");
-      }
-      process.serverProcess.kill();
-      await handleStartAppServer(options);
-      return Promise.resolve();
-    }
-    process.loader.text("Starting app...");
-    startApplicationProcess();
-    if (!process.hmrProcess) {
-      startHMR();
-    }
-  } catch (exception) {
-    throw new Error(`[dev.handleRestartApplicationProcess] ${exception.message}`);
-  }
-};
-const handleStartAppServer = async (options = {}) => {
-  try {
-    const serverProcess = await startApp({
-      watch: options?.watch,
-      nodeMajorVersion: options?.nodeMajorVersion,
-      port: options?.port,
-      sessionsBeforeHMRUpdate: options?.sessionsBeforeHMRUpdate
-    });
-    if (serverProcess) {
-      processIds.push(serverProcess.pid);
-      process.serverProcess = serverProcess;
-      handleServerProcessSTDIO(options);
-      handleServerProcessMessages(options);
-    }
-  } catch (exception) {
-    console.warn(exception);
-    throw new Error(`[dev.handleStartAppServer] ${exception.message}`);
-  }
-};
-const handleNotifyHMRClients = async (indexHTMLChanged = false) => {
-  try {
-    if (process.hmrProcess) {
-      const settings = await loadSettings({ environment: process.env.NODE_ENV });
-      process.hmrProcess.send(
-        JSON.stringify({
-          type: "RESTART_SERVER",
-          settings: settings.parsed,
-          indexHTMLChanged
-        })
-      );
-    }
-  } catch (exception) {
-    console.warn(exception);
-    throw new Error(`[dev.handleNotifyHMRClients] ${exception.message}`);
-  }
-};
-const getWatchChangeContext = (event = "", path2 = "") => {
-  try {
-    const isHTMLUpdate = path2 === "index.html";
-    const isUIPath = path2?.includes("ui/") || path2 === "index.css" || isHTMLUpdate;
-    const isUIUpdate = process.hmrProcess && process.hmrProcess.hasConnections && isUIPath || false;
-    const isSettingsUpdate = path2?.match(SETTINGS_FILE_NAME_REGEX)?.length > 0;
-    const isDirectory = fs.statSync(path2).isDirectory();
-    const isFile = fs.statSync(path2).isFile();
-    const isExistingDirectoryInSource = isDirectory && fs.existsSync(path2);
-    const isExistingDirectoryInBuild = !!fs.existsSync(`./.joystick/build/${path2}`);
-    const isAddDirectory = event === "addDir" && isExistingDirectoryInSource && !isExistingDirectoryInBuild;
-    const isFileToCopy = !!filesToCopy.find((fileToCopy) => fileToCopy.path === path2);
-    const isExistingFileInSource = isFile && fs.existsSync(path2);
-    const isAddingOrChangingFile = ["add", "change"].includes(event) && isExistingFileInSource;
-    return {
-      isHTMLUpdate,
-      isUIPath,
-      isUIUpdate,
-      isSettingsUpdate,
-      isDirectory,
-      isFile,
-      isExistingDirectoryInSource,
-      isExistingDirectoryInBuild,
-      isAddDirectory,
-      isFileToCopy,
-      isExistingFileInSource,
-      isAddingOrChangingFile
-    };
-  } catch (exception) {
-    throw new Error(`[dev.getWatchChangeContext] ${exception.message}`);
-  }
-};
-const startFileWatcher = (options = {}) => {
-  try {
-    const watcher = chokidar.watch(
-      watchlist.map(({ path: path2 }) => path2),
-      { ignoreInitial: true }
-    );
-    watcher.on("all", async (event, path2) => {
-      checkForRequiredFiles();
-      if (!options?.watch) {
-        process.loader.text("Rebuilding app...");
-      }
-      const watchChangeContext = getWatchChangeContext(event, path2);
-      handleCopyDirectory(watchChangeContext, path2, options);
-      handleCopyFile(watchChangeContext, path2, options);
-      handleAddDirectory(watchChangeContext, path2, options);
-      await handleAddOrChangeFile(watchChangeContext, path2, options);
-      if (watchChangeContext?.isSettingsUpdate) {
-        await loadSettings({
-          environment: options.environment,
-          process: options.process
-        });
-      }
-    });
-  } catch (exception) {
-    throw new Error(`[dev.startFileWatcher] ${exception.message}`);
-  }
-};
-const runInitialBuild = async (buildSettings = {}) => {
-  try {
-    process.loader.text("Building app...");
-    const filesToBuild = getFilesToBuild(buildSettings?.excludedPaths, "start");
-    const fileResults = await buildFiles({
-      files: filesToBuild,
-      environment: process.env.NODE_ENV
-    });
-    const hasErrors = [...fileResults].filter((result) => !!result).map(({ success }) => success).includes(false);
-    if (hasErrors) {
-      console.log(chalk.redBright("Failed to start app. Correct the errors above and run joystick start again.\n"));
-      process.exit(1);
-    }
-  } catch (exception) {
-    console.warn(exception);
-    throw new Error(`[dev.runInitialBuild] ${exception.message}`);
-  }
-};
-const initProcess = (options = {}) => {
-  try {
-    process.title = options?.environment === "test" ? "joystick_test" : "joystick";
-    process.loader = new Loader({
-      defaultMessage: options?.environment === "test" ? "Initializing test environment..." : "Starting app..."
-    });
-    process.env.LOGS_PATH = options?.logs || null;
-    process.env.NODE_ENV = options?.environment || "development";
-    process.env.PORT = options?.port ? parseInt(options?.port, 10) : 2600;
-    process.env.IS_DEBUG_MODE = options?.debug;
-  } catch (exception) {
-    throw new Error(`[dev.initProcess] ${exception.message}`);
-  }
-};
-const checkForRequiredFiles = () => {
-  try {
-    const missingFiles = [];
-    for (let i = 0; i < requiredFiles?.length; i += 1) {
-      const requiredFile = requiredFiles[i];
-      const exists = fs.existsSync(`${process.cwd()}/${requiredFile.path}`);
-      const stats = exists && fs.statSync(`${process.cwd()}/${requiredFile.path}`);
-      if (requiredFile && requiredFile.type === "file" && (!exists || exists && !stats.isFile())) {
-        missingFiles.push({ type: "file", path: requiredFile.path });
-      }
-      if (requiredFile && requiredFile.type === "directory" && (!exists || exists && !stats.isDirectory())) {
-        missingFiles.push({ type: "directory", path: requiredFile.path });
-      }
-    }
-    if (missingFiles?.length > 0) {
-      const files = missingFiles?.filter((path2) => path2.type === "file");
-      const directories = missingFiles?.filter((path2) => path2.type === "directory");
-      let error = `The following paths are missing and required in a Joystick project:
-
-`;
-      if (files?.length > 0) {
-        error += `  > Required Files:
-
-`;
-        for (let i = 0; i < files?.length; i += 1) {
-          const file = files[i];
-          error += `  /${file.path}
-`;
-        }
-      }
-      if (directories?.length > 0) {
-        error += `  > Required Directories:
-
-`;
-        for (let i = 0; i < directories?.length; i += 1) {
-          const file = directories[i];
-          error += `  /${file.path}
-`;
-        }
-      }
-      CLILog(error, {
-        level: "danger",
-        docs: "https://cheatcode.co/docs/joystick/structure"
-      });
-      process.exit(0);
-    }
-  } catch (exception) {
-    throw new Error(`[dev.checkForRequiredFiles] ${exception.message}`);
-  }
-};
-const warnInvalidJoystickEnvironment = () => {
-  try {
-    const hasJoystickFolder = fs.existsSync(`${process.cwd()}/.joystick`);
-    const hasTestsFolder = fs.existsSync(`${process.cwd()}/tests`);
-    if (process.env.NODE_ENV === "test" && (!hasJoystickFolder || !hasTestsFolder)) {
-      CLILog(
-        "joystick test must be run in a directory with a .joystick folder and tests folder.",
-        {
-          level: "danger",
-          docs: "https://cheatcode.co/docs/joystick/cli/test"
-        }
-      );
-      process.exit(0);
-    }
-    if (process.env.NODE_ENV !== "test" && !hasJoystickFolder) {
-      CLILog(
-        "joystick start must be run in a directory with a .joystick folder.",
-        {
-          level: "danger",
-          docs: "https://cheatcode.co/docs/joystick/cli/start"
-        }
-      );
-      process.exit(0);
-    }
-  } catch (exception) {
-    throw new Error(`[dev.warnInvalidJoystickEnvironment] ${exception.message}`);
-  }
-};
-const validateOptions = (options) => {
-  try {
-    if (!options)
-      throw new Error("options object is required.");
-    if (!options.environment)
-      throw new Error("options.environment is required.");
-  } catch (exception) {
-    throw new Error(`[dev.validateOptions] ${exception.message}`);
-  }
-};
-const dev = async (options, { resolve, reject }) => {
-  try {
-    validateOptions(options);
-    initProcess(options);
-    const nodeMajorVersion = parseInt(
-      process?.version?.split(".")[0]?.replace("v", ""),
-      10
-    );
-    const __filename = fileURLToPath(import.meta.url);
-    const __dirname = dirname(__filename);
-    warnInvalidJoystickEnvironment();
-    checkForRequiredFiles();
-    const settings = await loadSettings({
-      environment: options.environment
-    });
-    await startDatabases({
-      environment: options.environment,
-      port: options.port,
-      settings: settings.parsed
-    });
-    await runInitialBuild(settings?.parsed?.config?.build);
-    await startFileWatcher({
-      ...options,
-      nodeMajorVersion
-    });
-    await handleStartAppServer({
-      ...options,
-      nodeMajorVersion
-    });
-    if (options?.environment !== "test") {
-      const hmrProcess = await startHMR({
-        nodeMajorVersion,
-        __dirname
-      });
-      processIds.push(hmrProcess.pid);
-      process.hmrProcess = hmrProcess;
-      handleHMRProcessSTDIO();
-      handleHMRProcessMessages({
-        ...options,
-        nodeMajorVersion
-      });
-    }
-    handleSignalEvents(
-      processIds,
-      nodeMajorVersion,
-      __dirname
-    );
-    if (options?.environment === "test") {
-      process.loader.stop();
-      const databaseProcessIds = getDatabaseProcessIds();
-      await runTests({
-        watch: options?.watch,
-        __dirname,
-        processIds: [
-          ...processIds,
-          ...databaseProcessIds
-        ],
-        cleanupProcess: process.cleanupProcess
-      });
-      if (!options?.watch) {
-        process.exit(0);
-      }
-    }
-    resolve();
-  } catch (exception) {
-    console.warn(exception);
-    reject(`[dev] ${exception.message}`);
-  }
-};
-var dev_default = (options) => new Promise((resolve, reject) => {
-  dev(options, { resolve, reject });
-});
-export {
-  dev_default as default
-};

package/dist/lib/dev/isWindows.js

@@ -1,5 +0,0 @@
-import os from "os";
-var isWindows_default = os.platform() === "win32";
-export {
-  isWindows_default as default
-};

package/dist/lib/dev/loadSettings.js

@@ -1,79 +0,0 @@
-import fs from "fs";
-import CLILog from "../CLILog.js";
-import isValidJSONString from "../isValidJSONString.js";
-const warnIfInvalidJSONInSettings = (settings = "") => {
-  try {
-    const isValidJSON = isValidJSONString(settings);
-    const context = process.env.NODE_ENV === "test" ? "test" : "start";
-    if (!isValidJSON) {
-      CLILog(
-        `Failed to parse settings file. Double-check the syntax in your settings.${process.env.NODE_ENV}.json file at the root of your project and rerun joystick ${context}.`,
-        {
-          level: "danger",
-          docs: `https://cheatcode.co/docs/joystick/environment-settings`,
-          tools: [{ title: "JSON Linter", url: "https://jsonlint.com/" }]
-        }
-      );
-      process.exit(0);
-    }
-  } catch (exception) {
-    throw new Error(`[loadSettings.warnIfInvalidJSONInSettings] ${exception.message}`);
-  }
-};
-const getSettings = (settingsPath = "") => {
-  try {
-    return fs.readFileSync(settingsPath, "utf-8");
-  } catch (exception) {
-    throw new Error(`[loadSettings.getSettings] ${exception.message}`);
-  }
-};
-const warnIfSettingsNotFound = (settingsPath = "") => {
-  try {
-    const hasSettingsFile = fs.existsSync(settingsPath);
-    const context = process.env.NODE_ENV === "test" ? "test" : "start";
-    if (!hasSettingsFile) {
-      CLILog(
-        `A settings file could not be found for this environment (${process.env.NODE_ENV}). Create a settings.${process.env.NODE_ENV}.json file at the root of your project and rerun joystick ${context}.`,
-        {
-          level: "danger",
-          docs: `https://cheatcode.co/docs/joystick/cli/${context}`
-        }
-      );
-      process.exit(0);
-    }
-  } catch (exception) {
-    throw new Error(`[loadSettings.warnIfSettingsNotFound] ${exception.message}`);
-  }
-};
-const validateOptions = (options) => {
-  try {
-    if (!options)
-      throw new Error("options object is required.");
-    if (!options.environment)
-      throw new Error("options.environment is required.");
-  } catch (exception) {
-    throw new Error(`[loadSettings.validateOptions] ${exception.message}`);
-  }
-};
-const loadSettings = (options, { resolve, reject }) => {
-  try {
-    validateOptions(options);
-    const settingsPath = `${process.cwd()}/settings.${options.environment}.json`;
-    warnIfSettingsNotFound(settingsPath);
-    const settings = getSettings(settingsPath);
-    warnIfInvalidJSONInSettings(settings);
-    process.env.JOYSTICK_SETTINGS = settings;
-    resolve({
-      parsed: JSON.parse(settings),
-      unparsed: settings
-    });
-  } catch (exception) {
-    reject(`[loadSettings] ${exception.message}`);
-  }
-};
-var loadSettings_default = (options) => new Promise((resolve, reject) => {
-  loadSettings(options, { resolve, reject });
-});
-export {
-  loadSettings_default as default
-};

package/dist/lib/dev/readFileDependencyMap.js

@@ -1,16 +0,0 @@
-import fs from "fs";
-var readFileDependencyMap_default = () => {
-  const fileDependencyMapPath = `.joystick/build/fileMap.json`;
-  if (fs.existsSync(fileDependencyMapPath)) {
-    const fileDependencyMapAsJSON = fs.readFileSync(
-      fileDependencyMapPath,
-      "utf-8"
-    );
-    const fileMap = fileDependencyMapAsJSON ? JSON.parse(fileDependencyMapAsJSON) : {};
-    return fileMap;
-  }
-  return {};
-};
-export {
-  readFileDependencyMap_default as default
-};

package/dist/lib/dev/requiredFiles.js

@@ -1,18 +0,0 @@
-var requiredFiles_default = [
-  { path: "index.server.js", type: "file" },
-  { path: "index.html", type: "file" },
-  { path: "index.client.js", type: "file" },
-  { path: "api", type: "directory" },
-  { path: "email", type: "directory" },
-  { path: "i18n", type: "directory" },
-  { path: "lib", type: "directory" },
-  { path: "private", type: "directory" },
-  { path: "public", type: "directory" },
-  { path: "ui", type: "directory" },
-  { path: "ui/components", type: "directory" },
-  { path: "ui/layouts", type: "directory" },
-  { path: "ui/pages", type: "directory" }
-];
-export {
-  requiredFiles_default as default
-};