@joystick.js/cli-canary 0.0.0-canary.162 → 0.0.0-canary.1621

package/src/lib/dev/loadSettings.js

@@ -1,90 +0,0 @@
-/* eslint-disable consistent-return */
-
-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}`);
-  }
-};
-
-export default (options) =>
-  new Promise((resolve, reject) => {
-    loadSettings(options, { resolve, reject });
-  });

package/src/lib/dev/readFileDependencyMap.js

@@ -1,19 +0,0 @@
-import fs from 'fs';
-
-export 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 {};
-};

package/src/lib/dev/runBuild.js

@@ -1,33 +0,0 @@
-/* eslint-disable consistent-return */
-
-const actionMethod = () => {
-  try {
-    // Perform a single step in your action here.
-  } catch (exception) {
-    throw new Error(`[runBuild.actionMethod] ${exception.message}`);
-  }
-};
-
-const validateOptions = (options) => {
-  try {
-    if (!options) throw new Error('options object is required.');
-    if (!options.port) throw new Error('options.port is required.');
-  } catch (exception) {
-    throw new Error(`[runBuild.validateOptions] ${exception.message}`);
-  }
-};
-
-const runBuild = (options, { resolve, reject }) => {
-  try {
-    validateOptions(options);
-    // Call action methods in sequence here.
-    resolve();
-  } catch (exception) {
-    reject(`[runBuild] ${exception.message}`);
-  }
-};
-
-export default (options) =>
-  new Promise((resolve, reject) => {
-    runBuild(options, { resolve, reject });
-  });

package/src/lib/dev/runTests.js

@@ -1,122 +0,0 @@
-import child_process from "child_process";
-import CLILog from "../CLILog.js";
-
-const handleAvaSTDERR = (stderr = '', options = {}) => {
-  try {
-    // NOTE: Squash output about using a configuration file (we always do in the framework).
-    if (stderr?.includes('Using configuration')) {
-      return null;
-    }
-
-    if (stderr?.includes('No tests found')) {
-      return CLILog('No tests found. Add tests in the /tests folder at the root of your Joystick app.', {
-        level: 'danger',
-        docs: 'https://cheatcode.co/docs/joystick/test/setup',
-      });
-    }
-    
-    console.log(stderr);
-  } catch (exception) {
-    throw new Error(`[runTests.handleAvaSTDERR] ${exception.message}`);
-  }
-};
-
-const handleAvaSTDOUT = (stdout = '', options = {}) => {
-  try {
-    // NOTE: Squash output about using a configuration file (we always do in the framework).
-    if (stdout?.includes('Using configuration')) {
-      return null;
-    }
-
-    if (stdout?.includes('No tests found')) {
-      CLILog('No tests found. Add tests in the /tests folder at the root of your Joystick app.', {
-        level: 'danger',
-        docs: 'https://cheatcode.co/docs/joystick/test/setup',
-      });
-      
-      // NOTE: Do this here because the standard SIGINT and SIGTERM hooks the dev process
-      // listens for don't catch a clean exit (and the process.exit() hook fires after exit).
-      options.cleanupProcess.send(JSON.stringify(({ processIds: options?.processIds })));
-      
-      return process.exit(0);
-    }
-    
-    console.log(stdout);
-  } catch (exception) {
-    throw new Error(`[runTests.handleAvaSTDOUT] ${exception.message}`);
-  }
-};
-
-const handleAvaSTDIO = (ava = {}, options = {}) => {
-  try {
-    ava.stdout.on('data', function (data) {
-      const string = data.toString();
-      handleAvaSTDOUT(string, options);
-    });
-
-    ava.stderr.on('data', function (data) {
-      const string = data.toString();
-      handleAvaSTDERR(string, options);
-    });
-  } catch (exception) {
-    throw new Error(`[runTests.handleAvaSTDIO] ${exception.message}`);
-  }
-};
-
-const runAva = (options = {}) => {
-  try {
-    // NOTE: A little bananas to reason through this. In order for Ava to run w/o errors,
-    // the Ava binary being run here has to be identical to the one used in @joystick.js/test.
-    // That would equal the copy of Ava that's installed in a Joystick app's node_modules
-    // directory, not the node_modules directory of the CLI here. We can guarantee that will
-    // exist for the CLI here because a developer has to install @joystick.js/test which will
-    // add Ava as a dependency to their app in order to write tests.
-    const avaPath = `${process.cwd()}/node_modules/.bin/ava`;
-    
-    return new Promise((resolve, reject) => {
-      // NOTE: Despite using the app's node_modules path to reference Ava, we still want to reference
-      // the internal path here for the default test config in /lib/dev/tests.config.js.
-      const ava = child_process.exec(`${avaPath} --config ${options?.__dirname}/tests.config.js ${options?.watch ? '--watch' : ''}`, {
-        stdio: 'inherit',
-        env: {
-          ...(process.env),
-          FORCE_COLOR: "1"
-        }
-      }, (error) => {
-        if (!error) {
-          resolve();
-        }
-      });
-
-      handleAvaSTDIO(ava, options);
-    });
-  } catch (exception) {
-    throw new Error(`[runTests.runAva] ${exception.message}`);
-  }
-};
-
-const validateOptions = (options) => {
-  try {
-    if (!options) throw new Error('options object is required.');
-    if (!options.__dirname) throw new Error('options.__dirname is required.');
-  } catch (exception) {
-    throw new Error(`[runTests.validateOptions] ${exception.message}`);
-  }
-};
-
-const runTests = async (options, { resolve, reject }) => {
-  try {
-    validateOptions(options);
-    
-    await runAva(options);
-    
-    resolve();
-  } catch (exception) {
-    reject(`[runTests] ${exception.message}`);
-  }
-};
-
-export default (options) =>
-  new Promise((resolve, reject) => {
-    runTests(options, { resolve, reject });
-  });

package/src/lib/dev/startApp.js

@@ -1,79 +0,0 @@
-import child_process from "child_process";
-import path from "path";
-
-const handleStartServerProcess = (execArgv = {}, sessionsBeforeHMRUpdate = {}) => {
-  try {
-    process.loader.text('Starting app...');
-
-    return 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: JSON.stringify(sessionsBeforeHMRUpdate),
-        },
-      }
-    );
-  } catch (exception) {
-    throw new Error(`[startApp.handleStartServerProcess] ${exception.message}`);
-  }
-};
-
-const getExecArgs = (nodeMajorVersion = 0) => {
-  try {
-    const execArgv = ["--no-warnings"];
-
-    if (nodeMajorVersion < 19) {
-      execArgv.push("--experimental-specifier-resolution=node");
-    }
-
-    if (
-      process.env.NODE_ENV === "development" &&
-        process.env.IS_DEBUG_MODE === "true"
-      ) {
-      execArgv.push("--inspect");
-    }
-
-    return execArgv;
-  } catch (exception) {
-    throw new Error(`[startApp.getExecArgs] ${exception.message}`);
-  }
-};
-
-const validateOptions = (options) => {
-  try {
-    if (!options) throw new Error('options object is required.');
-    if (!options.nodeMajorVersion) throw new Error('options.nodeMajorVersion is required.');
-    if (!options.port) throw new Error('options.port is required.');
-  } catch (exception) {
-    throw new Error(`[startApp.validateOptions] ${exception.message}`);
-  }
-};
-
-const startApp = (options, { resolve, reject }) => {
-  try {
-    validateOptions(options);
-
-    const execArgv = getExecArgs(options?.nodeMajorVersion);
-    const serverProcess = handleStartServerProcess(execArgv, options?.sessionsBeforeHMRUpdate);
-
-    return resolve(serverProcess);
-  } catch (exception) {
-    reject(`[startApp] ${exception.message}`);
-  }
-};
-
-export default (options) =>
-  new Promise((resolve, reject) => {
-    startApp(options, { resolve, reject });
-  });

package/src/lib/dev/startDatabases.js

@@ -1,131 +0,0 @@
-/* eslint-disable consistent-return */
-
-import CLILog from "../CLILog.js";
-import providerMap from "./databases/providerMap.js";
-import { isObject } from '../types.js';
-
-const startDatabaseProvider = async (
-  environment = 'development',
-  database = {},
-  port = 2610,
-  hasMultipleOfProvider = false
-) => {
-  try {
-    const provider = providerMap[database?.provider];
-
-    if (provider) {
-      process.loader.text(`Starting ${provider?.name}...`);
-
-      process._databases = {
-        ...(process._databases || {}),
-        [database.provider]: !hasMultipleOfProvider ? await provider.connect(database, port, environment) : {
-          ...((process._databases && process._databases[database.provider]) || {}),
-          [database?.name || `${database.provider}_${port}`]: await provider.connect(database, port, environment)
-        },
-      };
-    }
-
-    return Promise.resolve(process._databases || {});
-  } catch (exception) {
-    throw new Error(`[startDatabases.startDatabaseProvider] ${exception.message}`);
-  }
-};
-
-const startDatabaseProviders = async (databases = [], databasePortStart = 2610, environment = '') => {
-  try {
-    for (let i = 0; i < databases?.length; i += 1) {
-      const database = databases[i];
-      const hasMultipleOfProvider = (databases?.filter((database) => database?.provider === database?.provider))?.length > 1;
-
-      await startDatabaseProvider(
-        environment,
-        database,
-        // NOTE: Increment each database port using index in the databases array from settings if no port
-        // is assigned in the settings.
-        database?.port || databasePortStart + i,
-        hasMultipleOfProvider,
-      );
-    }
-  } catch (exception) {
-    throw new Error(`[startDatabases.startDatabaseProviders] ${exception.message}`);
-  }
-};
-
-const validateDatabasesFromSettings = (databases = []) => {
-  try {
-    const databasesNotAsObjects = databases.filter(
-      (database) => !isObject(database)
-    );
-
-    const userDatabases = databases.filter((database) => !!database.users);
-    const queueDatabases = databases.filter((database) => !!database.queues);
-
-    if (databasesNotAsObjects && databasesNotAsObjects.length > 0) {
-      CLILog(`Please ensure that each database in the config.databases array in your settings.${process.env.NODE_ENV}.json is an object. Correct the array and restart your app.`, {
-        level: 'danger',
-        docs: 'https://cheatcode.co/docs/joystick/cli/databases',
-      });
-
-      process.exit(1);
-    }
-
-    if (userDatabases && userDatabases.length > 1) {
-      CLILog(`Please select a single database for your user accounts and restart your app.`, {
-        level: 'danger',
-        docs: 'https://cheatcode.co/docs/joystick/cli/databases#users',
-      });
-
-      process.exit(1);
-    }
-
-    if (queueDatabases && queueDatabases.length > 1) {
-      CLILog(`Please select a single database for your queues and restart your app.`, {
-        level: 'danger',
-        docs: 'https://cheatcode.co/docs/joystick/cli/databases#queues',
-      });
-
-      process.exit(1);
-    }
-
-    return true;
-  } catch (exception) {
-    throw new Error(`[startDatabases.validateDatabasesFromSettings] ${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.');
-    if (!options.port) throw new Error('options.port is required.');
-    if (!options.settings) throw new Error('options.settings is required.');
-  } catch (exception) {
-    throw new Error(`[startDatabases.validateOptions] ${exception.message}`);
-  }
-};
-
-const startDatabases = async (options, { resolve, reject }) => {
-  try {
-    validateOptions(options);
-
-    const databases = options?.settings?.config?.databases || [];
-
-    if (databases?.length > 0) {
-      validateDatabasesFromSettings(databases);
-      await startDatabaseProviders(
-        databases,
-        options?.port + 10,
-        options?.environment,
-      );
-    }
-
-    resolve();
-  } catch (exception) {
-    reject(`[startDatabases] ${exception.message}`);
-  }
-};
-
-export default (options) =>
-  new Promise((resolve, reject) => {
-    startDatabases(options, { resolve, reject });
-  });

package/src/lib/dev/startHMR.js

@@ -1,62 +0,0 @@
-import child_process from "child_process";
-import path from "path";
-
-const handleStartHMRProcess = (execArgv = {}, __dirname = '') => {
-  try {
-    // NOTE: Port is automatically pulled via process.env.PORT
-    // in the hmrServer.js script.
-    return child_process.fork(
-      path.resolve(`${__dirname}/hmrServer.js`),
-      [],
-      {
-        execArgv,
-        // NOTE: Pipe stdin, stdout, and stderr. IPC establishes a message channel so we
-        // communicate with the child_process.
-        silent: true,
-      }
-    );
-  } catch (exception) {
-    throw new Error(`[startHMR.handleStartHMRProcess] ${exception.message}`);
-  }
-};
-
-const getExecArgs = (nodeMajorVersion = 0) => {
-  try {
-    const execArgv = ["--no-warnings"];
-
-    if (nodeMajorVersion < 19) {
-      execArgv.push("--experimental-specifier-resolution=node");
-    }
-    
-    return execArgv;
-  } catch (exception) {
-    throw new Error(`[startHMR.getExecArgs] ${exception.message}`);
-  }
-};
-
-const validateOptions = (options) => {
-  try {
-    if (!options) throw new Error('options object is required.');
-    if (!options.nodeMajorVersion) throw new Error('options.nodeMajorVersion is required.');
-  } catch (exception) {
-    throw new Error(`[startHMR.validateOptions] ${exception.message}`);
-  }
-};
-
-const startHMR = (options, { resolve, reject }) => {
-  try {
-    validateOptions(options);
-
-    const execArgv = getExecArgs(options?.nodeMajorVersion);
-    const hmrProcess = handleStartHMRProcess(execArgv, options?.__dirname);
-
-    return resolve(hmrProcess);
-  } catch (exception) {
-    reject(`[startHMR] ${exception.message}`);
-  }
-};
-
-export default (options) =>
-  new Promise((resolve, reject) => {
-    startHMR(options, { resolve, reject });
-  });

package/src/lib/dev/tests.config.js

@@ -1,3 +0,0 @@
-export default {
-  files: [`tests/**/*`]
-};

package/src/lib/dev/updateFileMap.js

@@ -1,100 +0,0 @@
-import fs from "fs";
-import * as acorn from "acorn";
-
-const getImportsAndRequires = (map = {}) => {
-  const { body } = map;
-
-  const imports =
-    body &&
-    body.filter(({ type }) => {
-      return type === "ImportDeclaration";
-    });
-
-  const requires =
-    body &&
-    body.filter((statement) => {
-      const type = statement && statement.type;
-      const declarations = (statement && statement.declarations) || [];
-
-      const isVariableDeclaration = type === "VariableDeclaration";
-
-      const hasRequireStatement = declarations.some((declaration) => {
-        const isVariableDeclarator = declaration.type === "VariableDeclarator";
-        const calleeName =
-          declaration &&
-          declaration.init &&
-          declaration.init.callee &&
-          declaration.init.callee.name;
-        return isVariableDeclarator && calleeName === "require";
-      });
-
-      return isVariableDeclaration && hasRequireStatement;
-    });
-
-  return {
-    imports: imports.map((importDeclaration) => {
-      return {
-        path:
-          importDeclaration &&
-          importDeclaration.source &&
-          importDeclaration.source.value,
-      };
-    }),
-    requires: requires.map((requireDeclaration) => {
-      const declarations = requireDeclaration.declarations;
-      const declaration = declarations && declarations[0];
-
-      return {
-        path:
-          declaration &&
-          declaration.init &&
-          declaration.init.arguments &&
-          declaration.init.arguments[0] &&
-          declaration.init.arguments[0].value,
-      };
-    }),
-  };
-};
-
-const parseFileToAST = (source = "") => {
-  return acorn.parse(source, {
-    ecmaVersion: "latest",
-    sourceType: "module",
-  });
-};
-
-const readFileDependencyMap = () => {
-  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 default (path = "", source = "") => {
-  try {
-    const fileDependencyMap = readFileDependencyMap();
-    const fileAST = parseFileToAST(source);
-    const imports = fileAST ? getImportsAndRequires(fileAST) : [];
-
-    fileDependencyMap[path] = imports;
-
-    fs.writeFileSync(
-      `.joystick/build/fileMap.json`,
-      JSON.stringify(fileDependencyMap, null, 2)
-      );
-  } catch (exception) {
-    // Do nothing. This exists to handle acorn parsing errors that are also picked
-    // up by the esbuild parser (we want to defer to esbuild).
-  }
-};

package/src/lib/dev/watchlist.js

@@ -1,13 +0,0 @@
-import filesToCopy from "../filesToCopy.js";
-
-export default [
-  { path: "api" },
-  { path: "email" },
-  { path: "fixtures" },
-  { path: "lib" },
-  { path: "ui" },
-  { path: "routes" },
-  { path: "index.client.js" },
-  { path: "index.server.js" },
-  ...filesToCopy,
-];

package/src/lib/filesToCopy.js

@@ -1,15 +0,0 @@
-export default [
-  { path: "css", regex: new RegExp(/^css\//) },
-  { path: "i18n", regex: new RegExp(/^i18n\//) },
-  { path: "public", regex: new RegExp(/^public\//) },
-  { path: "private", regex: new RegExp(/^private\//) },
-  { path: "index.html", regex: new RegExp(/^index.html/) },
-  { path: "index.css", regex: new RegExp(/^index.css/) },
-  { path: "package.json", regex: new RegExp(/^package.json/) },
-  { path: "package-lock.json", regex: new RegExp(/^package-lock.json/) },
-  { path: "settings.development.json", regex: new RegExp(/^settings.development.json/) },
-  { path: "settings.staging.json", regex: new RegExp(/^settings.staging.json/) },
-  { path: "settings.test.json", regex: new RegExp(/^settings.test.json/) },
-  { path: "settings.production.json", regex: new RegExp(/^settings.production.json/) },
-  { path: ".html", regex: new RegExp(/^([0-9a-zA-Z-._])+.html/) },
-];