@joystick.js/cli-canary 0.0.0-canary.13 → 0.0.0-canary.130

package/_package.json

@@ -26,6 +26,7 @@
     "@babel/code-frame": "^7.15.8",
     "acorn": "^8.5.0",
     "ascii-table": "^0.0.9",
+    "ava": "^5.3.1",
     "chalk": "^4.1.2",
     "chokidar": "^3.5.2",
     "command-exists": "^1.2.9",
@@ -52,4 +53,4 @@
     "ws": "^8.2.3",
     "xmlhttprequest": "^1.8.0"
   }
-}
+}

package/dist/cli.js

@@ -53,6 +53,13 @@ if (functionsCalled.includes("start")) {
     functions.start.function(args, options);
   }
 }
+if (functionsCalled.includes("test")) {
+  const args = getArgs(functions.test.args);
+  const options = getOptions(functions.test.options);
+  if (functions.test.function && typeof functions.test.function === "function") {
+    functions.test.function(args, options);
+  }
+}
 if (functionsCalled.includes("update")) {
   const args = getArgs(functions.update.args);
   const options = getOptions(functions.update.options);

package/dist/functions/index.js

@@ -4,6 +4,7 @@ import logout from "./logout/index.js";
 import start from "./start/index.js";
 import update from "./update/index.js";
 import use from "./use/index.js";
+import test from "./test/index.js";
 const [_node, _bin, ...rawArgs] = process.argv;
 var functions_default = {
   build: {
@@ -216,6 +217,20 @@ var functions_default = {
     },
     function: start
   },
+  test: {
+    set: !!rawArgs.includes("test"),
+    description: "Start an existing Joystick app and run its tests.",
+    args: {
+      watch: {
+        set: !!rawArgs.includes("watch"),
+        parent: "watch",
+        value: !!rawArgs.includes("watch"),
+        description: "Run joystick test in watch mode."
+      }
+    },
+    options: {},
+    function: test()
+  },
   update: {
     set: !!rawArgs.includes("update"),
     description: "Update all Joystick packages to their latest version.",

package/dist/functions/start/index.js

@@ -1,198 +1,4 @@
 import dev from "../../lib/dev/index.js";
-const majorVersion = parseInt(
-  process?.version?.split(".")[0]?.replace("v", ""),
-  10
-);
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = dirname(__filename);
-const killProcess = (pid = 0) => {
-  return new Promise((resolve) => {
-    ps.kill(pid, () => {
-      resolve();
-    });
-  });
-};
-const watchlist = [
-  { path: "ui" },
-  { path: "lib" },
-  { path: "i18n" },
-  { path: "api" },
-  { path: "email" },
-  { path: "fixtures" },
-  { path: "routes" },
-  { path: "index.client.js" },
-  { path: "index.server.js" },
-  ...filesToCopy
-];
-const requiredFileCheck = () => {
-  return new Promise((resolve) => {
-    const requiredFiles = [
-      { path: "index.server.js", type: "file" },
-      { path: "index.html", type: "file" },
-      { path: "index.client.js", type: "file" },
-      { path: "api", type: "directory" },
-      { path: "i18n", type: "directory" },
-      { path: "lib", 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" }
-    ];
-    requiredFiles.forEach((requiredFile) => {
-      const exists = fs.existsSync(`${process.cwd()}/${requiredFile.path}`);
-      const stats = exists && fs.statSync(`${process.cwd()}/${requiredFile.path}`);
-      const isFile = stats && stats.isFile();
-      const isDirectory = stats && stats.isDirectory();
-      if (requiredFile && requiredFile.type === "file") {
-        if (!exists || exists && !isFile) {
-          CLILog(
-            `The path ${requiredFile.path} must exist in your project and must be a file (not a directory).`,
-            {
-              level: "danger",
-              docs: "https://github.com/cheatcode/joystick#folder-and-file-structure"
-            }
-          );
-          process.exit(0);
-        }
-      }
-      if (requiredFile && requiredFile.type === "directory") {
-        if (!exists || exists && !isDirectory) {
-          CLILog(
-            `The path ${requiredFile.path} must exist in your project and must be a directory (not a file).`,
-            {
-              level: "danger",
-              docs: "https://github.com/cheatcode/joystick#folder-and-file-structure"
-            }
-          );
-          process.exit(0);
-        }
-      }
-    });
-    resolve();
-  });
-};
-const handleCleanup = async (processIds = [process?.serverProcess?.pid, process?.hmrProcess?.pid]) => {
-  for (let i = 0; i < processIds?.length; i += 1) {
-    const processId = processIds[i];
-    if (processId) {
-      await killProcess(processId);
-    }
-  }
-  const databases = Object.entries(process._databases || {});
-  for (let i = 0; i < databases?.length; i += 1) {
-    const [provider, providerConnection] = databases[i];
-    if (providerConnection?.pid) {
-      await killProcess(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) {
-          await killProcess(connection?.pid);
-        }
-      }
-    }
-  }
-};
-const getDatabaseProcessIds = () => {
-  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;
-};
-const handleSignalEvents = (processIds = []) => {
-  const execArgv = ["--no-warnings"];
-  if (majorVersion < 19) {
-    execArgv.push("--experimental-specifier-resolution=node");
-  }
-  const cleanupProcess = child_process.fork(
-    path.resolve(`${__dirname}/cleanup/index.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.on("SIGINT", async () => {
-    const databaseProcessIds = getDatabaseProcessIds();
-    cleanupProcess.send(JSON.stringify({ processIds: [...processIds, ...databaseProcessIds] }));
-    process.exit();
-  });
-  process.on("SIGTERM", async () => {
-    const databaseProcessIds = getDatabaseProcessIds();
-    cleanupProcess.send(JSON.stringify({ processIds: [...processIds, ...databaseProcessIds] }));
-    process.exit();
-  });
-};
-const handleHMRProcessMessages = () => {
-  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(() => {
-        restartApplicationProcess(message?.sessions);
-      }, 500);
-    }
-  });
-};
-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 startHMRProcess = () => {
   const execArgv = ["--no-warnings"];
   if (majorVersion < 19) {
@@ -212,284 +18,11 @@ const startHMRProcess = () => {
   handleHMRProcessSTDIO();
   handleHMRProcessMessages();
 };
-const notifyHMRClients = (indexHTMLChanged = false) => {
-  const settings = loadSettings(process.env.NODE_ENV);
-  process.hmrProcess.send(
-    JSON.stringify({
-      type: "RESTART_SERVER",
-      settings,
-      indexHTMLChanged
-    })
-  );
-};
-const handleServerProcessMessages = () => {
-  process.serverProcess.on("message", (message) => {
-    const processMessages = ["SERVER_CLOSED"];
-    if (!processMessages.includes(message)) {
-      process.loader.stable(message);
-    }
-  });
-};
-const handleServerProcessSTDIO = () => {
-  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:")) {
-          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://github.com/cheatcode/joystick"
-        });
-      });
-    }
-  } catch (exception) {
-    throw new Error(`[dev.handleServerProcessSTDIO] ${exception.message}`);
-  }
-};
-const startApplicationProcess = (sessionsBeforeHMRUpdate = null) => {
-  const execArgv = ["--no-warnings"];
-  if (majorVersion < 19) {
-    execArgv.push("--experimental-specifier-resolution=node");
-  }
-  if (process.env.NODE_ENV === "development" && process.env.IS_DEBUG_MODE === "true") {
-    execArgv.push("--inspect");
-  }
-  const serverProcess = child_process.fork(
-    path.resolve(".joystick/build/index.server.js"),
-    [],
-    {
-      execArgv,
-      // NOTE: Pipe stdin, stdout, and stderr. IPC establishes a message channel so we
-      // communicate with the child_process.
-      silent: true,
-      env: {
-        FORCE_COLOR: "1",
-        LOGS_PATH: process.env.LOGS_PATH,
-        NODE_ENV: process.env.NODE_ENV,
-        ROOT_URL: process.env.ROOT_URL,
-        PORT: process.env.PORT,
-        JOYSTICK_SETTINGS: process.env.JOYSTICK_SETTINGS,
-        HMR_SESSIONS: sessionsBeforeHMRUpdate
-      }
-    }
-  );
-  process.serverProcess = serverProcess;
-  handleServerProcessSTDIO();
-  handleServerProcessMessages();
-  return serverProcess;
-};
-const restartApplicationProcess = async (sessionsBeforeHMRUpdate = null) => {
-  if (process.serverProcess && process.serverProcess.pid) {
-    process.loader.text("Restarting app...");
-    process.serverProcess.kill();
-    startApplicationProcess(sessionsBeforeHMRUpdate);
-    return Promise.resolve();
-  }
-  process.loader.text("Starting app...");
-  startApplicationProcess();
-  if (!process.hmrProcess) {
-    startHMRProcess();
-  }
-};
-const initialBuild = async (buildSettings = {}) => {
-  const buildPath = `.joystick/build`;
-  const fileMapPath = `.joystick/build/fileMap.json`;
-  if (!fs.existsSync(buildPath)) {
-    fs.mkdirSync(".joystick/build");
-  }
-  if (fs.existsSync(fileMapPath)) {
-    fs.unlinkSync(fileMapPath);
-  }
-  process.loader.text("Building app...");
-  await requiredFileCheck();
-  const filesToBuild = getFilesToBuild(buildSettings?.excludedPaths, "start");
-  const fileResults = await buildFiles(
-    filesToBuild,
-    null,
-    process.env.NODE_ENV
-  );
-  const hasErrors = [...fileResults].filter((result) => !!result).map(({ success }) => success).includes(false);
-  if (!hasErrors) {
-    startApplicationProcess();
-    startHMRProcess();
-  }
-};
-const startWatcher = async (buildSettings = {}) => {
-  await initialBuild(buildSettings);
-  const watcher = chokidar.watch(
-    watchlist.map(({ path: path2 }) => path2),
-    {
-      ignoreInitial: true
-    }
-  );
-  watcher.on("all", async (event, path2) => {
-    await requiredFileCheck();
-    process.loader.text("Rebuilding app...");
-    const isHTMLUpdate = path2 === "index.html";
-    const isUIPath = path2?.includes("ui/") || path2 === "index.css" || isHTMLUpdate;
-    const isUIUpdate = process.hmrProcess.hasConnections && isUIPath || false;
-    if (["addDir"].includes(event) && fs.existsSync(path2) && fs.lstatSync(path2).isDirectory() && !fs.existsSync(`./.joystick/build/${path2}`)) {
-      fs.mkdirSync(`./.joystick/build/${path2}`);
-      if (isUIUpdate) {
-        notifyHMRClients(isHTMLUpdate);
-      } else {
-        restartApplicationProcess();
-      }
-      return;
-    }
-    if (!!filesToCopy.find((fileToCopy) => fileToCopy.path === path2)) {
-      const isDirectory = fs.statSync(path2).isDirectory();
-      if (isDirectory && !fs.existsSync(`./.joystick/build/${path2}`)) {
-        fs.mkdirSync(`./.joystick/build/${path2}`);
-      }
-      if (!isDirectory) {
-        fs.writeFileSync(`./.joystick/build/${path2}`, fs.readFileSync(path2));
-      }
-      loadSettings(process.env.NODE_ENV);
-      if (isUIUpdate) {
-        notifyHMRClients(isHTMLUpdate);
-      } else {
-        restartApplicationProcess();
-      }
-      return;
-    }
-    if (["add", "change"].includes(event) && fs.existsSync(path2)) {
-      const codependencies = getCodependenciesForFile(path2);
-      const fileResults = await buildFiles(
-        [path2, ...codependencies?.existing || []],
-        null,
-        process.env.NODE_ENV
-      );
-      const fileResultsHaveErrors = fileResults.filter((result) => !!result).map(({ success }) => success).includes(false);
-      removeDeletedDependenciesFromMap(codependencies.deleted);
-      const hasErrors = fileResultsHaveErrors;
-      if (process.serverProcess && hasErrors) {
-        process.serverProcess.send(
-          JSON.stringify({
-            error: "BUILD_ERROR",
-            paths: fileResults.filter(({ success }) => !success).map(({ path: pathWithError, error }) => ({
-              path: pathWithError,
-              error
-            }))
-          })
-        );
-        return;
-      }
-      if (!hasErrors) {
-        process.initialBuildComplete = true;
-        if (isUIUpdate) {
-          notifyHMRClients(isHTMLUpdate);
-        } else {
-          restartApplicationProcess();
-        }
-        return;
-      }
-    }
-    if (["unlink", "unlinkDir"].includes(event) && !fs.existsSync(`./.joystick/build/${path2}`)) {
-      if (isUIUpdate) {
-        notifyHMRClients(isHTMLUpdate);
-      } else {
-        restartApplicationProcess();
-      }
-      return;
-    }
-    if (["unlink", "unlinkDir"].includes(event) && fs.existsSync(`./.joystick/build/${path2}`)) {
-      const pathToUnlink = `./.joystick/build/${path2}`;
-      const stats = fs.lstatSync(pathToUnlink);
-      if (stats.isDirectory()) {
-        fs.rmdirSync(pathToUnlink, { recursive: true });
-      }
-      if (stats.isFile()) {
-        fs.unlinkSync(pathToUnlink);
-      }
-      if (isUIUpdate) {
-        notifyHMRClients(isHTMLUpdate);
-      } else {
-        restartApplicationProcess();
-      }
-      return;
-    }
-  });
-};
-const startDatabase = async (database = {}, databasePort = 2610, hasMultipleOfProvider = false) => {
-  process._databases = {
-    ...process._databases || {},
-    [database.provider]: !hasMultipleOfProvider ? await startDatabaseProvider(database, databasePort) : {
-      ...process._databases && process._databases[database.provider] || {},
-      [database?.name || `${database.provider}_${databasePort}`]: await startDatabaseProvider(database, databasePort)
-    }
-  };
-  return Promise.resolve(process._databases);
-};
-const startDatabases = async (databasePortStart = 2610) => {
-  try {
-    const hasSettings = !!process.env.JOYSTICK_SETTINGS;
-    const settings = hasSettings && JSON.parse(process.env.JOYSTICK_SETTINGS);
-    const databases = settings?.config?.databases || [];
-    if (databases && Array.isArray(databases) && databases.length > 0) {
-      validateDatabasesFromSettings(databases);
-      for (let i = 0; i < databases?.length; i += 1) {
-        const database = databases[i];
-        const hasMultipleOfProvider = databases?.filter((database2) => database2?.provider === database2?.provider)?.length > 1;
-        await startDatabase(database, databasePortStart + i, hasMultipleOfProvider);
-      }
-      return Promise.resolve();
-    }
-    return Promise.resolve();
-  } catch (exception) {
-    console.warn(exception);
-  }
-};
-const loadSettings = () => {
-  const environment = process.env.NODE_ENV;
-  const settingsFilePath = `${process.cwd()}/settings.${environment}.json`;
-  const hasSettingsFile = fs.existsSync(settingsFilePath);
-  if (!hasSettingsFile) {
-    CLILog(
-      `A settings file could not be found for this environment (${environment}). Create a settings.${environment}.json file at the root of your project and restart Joystick.`,
-      {
-        level: "danger",
-        docs: "https://github.com/cheatcode/joystick#settings"
-      }
-    );
-    process.exit(0);
-  }
-  const rawSettingsFile = fs.readFileSync(settingsFilePath, "utf-8");
-  const isValidJSON = isValidJSONString(rawSettingsFile);
-  if (!isValidJSON) {
-    CLILog(
-      `Failed to parse settings file. Double-check the syntax in your settings.${environment}.json file at the root of your project and restart Joystick.`,
-      {
-        level: "danger",
-        docs: "https://github.com/cheatcode/joystick#settings",
-        tools: [{ title: "JSON Linter", url: "https://jsonlint.com/" }]
-      }
-    );
-    process.exit(0);
-  }
-  const settingsFile = isValidJSON ? rawSettingsFile : "{}";
-  process.env.JOYSTICK_SETTINGS = settingsFile;
-  return JSON.parse(settingsFile);
-};
-const checkIfJoystickProject = () => {
-  return fs.existsSync(`${process.cwd()}/.joystick`);
-};
 var start_default = async (args = {}, options = {}) => {
   await dev({
-    environment: options?.environment,
-    process
+    environment: args?.environment || "development",
+    process,
+    port: options?.port ? parseInt(options?.port) : 2600
   });
 };
 export {

package/dist/functions/start/setComponentId.js

@@ -1,7 +1,7 @@
 import fs from "fs";
 import generateId from "./generateId.js";
 var setComponentId_default = (file = "") => {
-  const componentMapPath = process.env.NODE_ENV === "development" ? `./.joystick/build/componentMap.json` : `./.build/componentMap.json`;
+  const componentMapPath = ["development", "test"].includes(process.env.NODE_ENV) ? `./.joystick/build/componentMap.json` : `./.build/componentMap.json`;
   const componentMapExists = fs.existsSync(componentMapPath);
   const componentMap = componentMapExists ? JSON.parse(fs.readFileSync(componentMapPath, "utf-8")) : {};
   const parts = [...file?.matchAll(/\/\/ ui+.*/gi)]?.map((match) => {

package/dist/functions/test/index.js

@@ -1,30 +1,12 @@
-const actionMethod = () => {
-  try {
-  } catch (exception) {
-    throw new Error(`[test.actionMethod] ${exception.message}`);
-  }
+import dev from "../../lib/dev/index.js";
+var test_default = async (args = {}, options = {}) => {
+  await dev({
+    environment: "test",
+    process,
+    port: 1977,
+    watch: args?.watch
+  });
 };
-const validateOptions = (options) => {
-  try {
-    if (!options)
-      throw new Error("options object is required.");
-    if (!options.someOption)
-      throw new Error("options.someOption is required.");
-  } catch (exception) {
-    throw new Error(`[test.validateOptions] ${exception.message}`);
-  }
-};
-const test = (options, { resolve, reject }) => {
-  try {
-    validateOptions(options);
-    resolve();
-  } catch (exception) {
-    reject(`[test] ${exception.message}`);
-  }
-};
-var test_default = (options) => new Promise((resolve, reject) => {
-  test(options, { resolve, reject });
-});
 export {
   test_default as default
 };

package/dist/lib/build/browserPathExclusions.js

@@ -1,6 +1,7 @@
 import getPlatformSafePath from "../getPlatformSafePath.js";
 var browserPathExclusions_default = [
-  getPlatformSafePath("lib/node")
+  getPlatformSafePath("lib/node"),
+  getPlatformSafePath("tests/")
 ];
 export {
   browserPathExclusions_default as default