@joystick.js/cli-canary 0.0.0-canary.1

package/src/functions/start/onWarn.js

@@ -0,0 +1,68 @@
+import chalk from "chalk";
+import { OBJECT_REGEX } from "../../lib/regexes.js";
+import rainbowRoad from '../../lib/rainbowRoad.js';
+import getCodeFrame from "../../lib/getCodeFrame.js";
+
+const removeLocationDataFromStackTrace = (stackTrace = "") => {
+  return stackTrace.replace(OBJECT_REGEX, "");
+};
+
+const logError = (warning = {}) => {
+  const snippetParts = warning?.snippet?.split(`\n`);
+
+  console.log('\n');
+  console.log(`${rainbowRoad()}\n`);
+
+  if (warning.file) {
+    console.log(chalk.yellowBright(`Build Error in ${warning?.file}:\n`));
+  }
+
+  if (snippetParts && snippetParts.length > 0) {
+    snippetParts.forEach((line) => {
+      if (line.includes(`> ${warning.line} |`)) {
+        return console.log(`   ${chalk.red(line)}`);
+      }
+
+      return console.log(`   ${chalk.gray(line)}`);
+    });
+  }
+
+  if (warning?.stack) {
+    console.log(chalk.magentaBright("\nStack Trace:\n"));
+    console.log(chalk.yellow(`   ${removeLocationDataFromStackTrace(warning?.stack)}\n`));
+  }
+
+  process.loader.error(
+    "Build error. Fix the error above to continue building your app."
+  );
+  console.log('\n');
+  console.log(`${rainbowRoad()}\n`);
+};
+
+const parseWarning = (warning = {}, type = "") => {
+  if (type && type === "BUILD_ERROR") {
+    return {
+      file: warning?.file,
+      snippet: warning?.snippet || getCodeFrame(warning.file, {
+        line: warning?.line,
+        column: warning?.column,
+      }),
+      stack: warning?.stack,
+      line: warning?.line,
+      character: warning?.column,
+      message: warning?.message,
+    };
+  }
+
+  return null;
+};
+
+export default (warning) => {
+  const parsedWarning = parseWarning(warning, "BUILD_ERROR");
+
+  if (parsedWarning) {
+    logError(parsedWarning);
+  }
+
+  return parsedWarning;
+};

package/src/functions/start/readFileDependencyMap.js

@@ -0,0 +1,19 @@
+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/functions/start/removeDeletedDependenciesFromMap.js

@@ -0,0 +1,19 @@
+import fs from 'fs';
+import readFileDependencyMap from "./readFileDependencyMap.js";
+
+export default (deletedDependencies = []) => {
+  const fileDependencyMap = readFileDependencyMap();
+
+  deletedDependencies.forEach((dependency) => {
+    const match = Object.keys(fileDependencyMap).find((key) => key.includes(dependency));
+
+    if (match) {
+      delete fileDependencyMap[match];
+    }
+  });
+
+  fs.writeFileSync(
+    `.joystick/build/fileMap.json`,
+    JSON.stringify(fileDependencyMap, null, 2)
+  );
+};

package/src/functions/start/setComponentId.js

@@ -0,0 +1,58 @@
+import fs from "fs";
+import generateId from "./generateId.js";
+
+export default (file = "") => {
+  const componentMapPath =
+    process.env.NODE_ENV === "development"
+      ? `./.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) => {
+    return {
+      path: match[0],
+      index: match.index,
+    };
+  });
+
+  const components = (parts || [])?.map((part, partIndex) => {
+    const nextPart = parts[partIndex + 1];
+
+    return {
+      path: part.path.replace("// ", ""),
+      index: part.index,
+      source: file.substring(
+        part.index,
+        nextPart ? nextPart.index : file.length
+      ),
+    };
+  });
+
+  for (let i = 0; i < components.length; i += 1) {
+    const component = components[i];
+    const componentId =
+      (componentMap && componentMap[component.path]) || generateId();
+
+    if (componentMap) {
+      componentMap[component.path] = componentId;
+    }
+
+    const tainted = component.source.replace(
+      /\.component\(\{+(?!\n + _componentId)/g,
+      () => {
+        return `.component({\n  _componentId: '${componentId}',`;
+      }
+    );
+
+    file = file.replace(component.source, tainted);
+  }
+
+  if (componentMap) {
+    fs.writeFileSync(componentMapPath, JSON.stringify(componentMap));
+  }
+
+  return file;
+};

package/src/functions/start/updateFileMap.js

@@ -0,0 +1,100 @@
+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/functions/update/index.js

@@ -0,0 +1,20 @@
+import chalk from 'chalk';
+import child_process from "child_process";
+import Loader from "../../lib/loader.js";
+
+process.loader = new Loader({ defaultMessage: "Updating Joystick dependencies..." });
+
+export default () => {
+  process.loader.text('Updating @joystick.js/node...');
+  child_process.exec('npm i @joystick.js/node@latest', () => {
+    process.loader.text('Updating @joystick.js/ui...');
+    child_process.exec('npm i @joystick.js/ui@latest', () => {
+      process.loader.text('Updating @joystick.js/cli...');
+      child_process.exec('npm i -g @joystick.js/cli@latest', () => {
+        process.loader.stop();
+        console.log(chalk.green('Joystick updated!'));
+        process.exit(0);
+      });
+    });
+  });
+}

package/src/functions/use/index.js

@@ -0,0 +1,62 @@
+import replaceInFiles from 'replace-in-files';
+import child_process from "child_process";
+
+export default async (args = {}) => {
+  if (args?.version === 'canary') {
+    await replaceInFiles({
+      files: ['./index.server.js', './api/**/*.js', 'lib/node/**/*.js'],
+      from: /(@joystick.js\/node)(?!-)/g,
+      to: '@joystick.js/node-canary',
+      optionsForFiles: { // default
+        "ignore": [
+          "**/node_modules/**"
+        ]
+      }
+    });
+    
+    await replaceInFiles({
+      files: ['./index.client.js', './ui/**/*.js', 'lib/**/*.js'],
+      from: /(@joystick.js\/ui)(?!-)/g,
+      to: '@joystick.js/ui-canary',
+      optionsForFiles: { // default
+        "ignore": [
+          "**/node_modules/**"
+        ]
+      }
+    });
+    
+    console.log('\nSwapping production packages for canary versions...\n');
+    
+    child_process.execSync('npm uninstall @joystick.js/node && npm i @joystick.js/node-canary');
+    child_process.execSync('npm uninstall @joystick.js/ui && npm i @joystick.js/ui-canary');
+  }
+  
+  if (args?.version === 'production') {
+    await replaceInFiles({
+      files: ['./index.server.js', './api/**/*.js', 'lib/node/**/*.js'],
+      from: /(@joystick.js\/node-canary)/g,
+      to: '@joystick.js/node',
+      optionsForFiles: { // default
+        "ignore": [
+          "**/node_modules/**"
+        ]
+      }
+    });
+    
+    await replaceInFiles({
+      files: ['./index.client.js', './ui/**/*.js', 'lib/**/*.js'],
+      from: /(@joystick.js\/ui-canary)/g,
+      to: '@joystick.js/ui',
+      optionsForFiles: { // default
+        "ignore": [
+          "**/node_modules/**"
+        ]
+      }
+    });
+    
+    console.log('\nSwapping canary packages for production versions...\n');
+    
+    child_process.execSync('npm uninstall @joystick.js/node-canary && npm i @joystick.js/node');
+    child_process.execSync('npm uninstall @joystick.js/ui-canary && npm i @joystick.js/ui');
+  }
+};

package/src/index.js

@@ -0,0 +1,13 @@
+#!/usr/bin/env node
+
+import { spawn } from 'child_process';
+import { fileURLToPath } from 'url';
+import { dirname } from 'path';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+// NOTE: Capture args passed to command line to forward to spawned script.
+const args = process.argv.slice(2, process.argv.length);
+
+spawn('node', ['--no-warnings', `${__dirname}/cli.js`, ...args], { stdio: 'inherit' });

package/src/lib/CLILog.js

@@ -0,0 +1,40 @@
+import chalk from 'chalk';
+import rainbowRoad from './rainbowRoad.js';
+
+export default (message = '', options = {}) => {
+  const colors = {
+    info: 'blue',
+    success: 'green',
+    warning: 'yellowBright',
+    danger: 'red',
+  };
+
+  const titles = {
+    info: '❱ Info',
+    success: '❱ Ok',
+    warning: '❱ Warning',
+    danger: '❱ Error',
+  };
+  
+  const color = options.level ? colors[options.level] : 'gray';
+  const title = options.level ? titles[options.level] : 'Log';
+  const docs = options.docs || 'https://github.com/cheatcode/joystick';
+
+  console.log(`\n${(options.padding || '')}${rainbowRoad()}\n`);
+  console.log(`${(options.padding || '')}${chalk[color](`${title}:`)}\n`)
+  console.log(`${(options.padding || '')}${chalk.white(message)}\n`);
+  console.log(`${(options.padding || '')}${chalk.grey('---')}\n`);
+  console.log(`${(options.padding || '')}${chalk.white('Relevant Documentation:')}\n`)
+  console.log(`${(options.padding || '')}${chalk.blue(docs)}\n`);
+  console.log(`${(options.padding || '')}${chalk.white('Stuck? Ask a Question:')}\n`)
+  console.log(`${(options.padding || '')}${chalk.blue('https://github.com/cheatcode/joystick/discussions')}\n`);
+  
+  if (options.tools && Array.isArray(options.tools)) {
+    console.log(`${(options.padding || '')}${chalk.white('Helpful Tools:')}\n`);
+    options.tools.forEach((tool) => {
+      console.log(`${(options.padding || '')}${chalk.blue(`${tool.title} — ${tool.url}`)}\n`);
+    });
+  }
+
+  console.log(`${(options.padding || '')}${rainbowRoad()}\n`);
+};

package/src/lib/buildResolvePlugin.js

@@ -0,0 +1,32 @@
+// TODO: None of these plugin-level methods give us the info we need. They *should*
+// but it's not defined (which means at best it's inconsistent).
+//
+// TODO: Just run a full build of the parent path where the file is located, or,
+// build the entire app again. That has an n(0) problem that we'll have to solve
+// but I think we can figure it out in time (or invent a custom a solution).
+
+export default function myExample() {
+  return {
+    name: "joystick-build-resolve", // this name will show up in warnings and errors
+    buildEnd() {
+      const moduleIds = Array.from(this.getModuleIds());
+      const modules = moduleIds
+        .map((moduleId) => this.getModuleInfo(moduleId))
+        .filter(({ id }) => {
+          const ignorePaths = ["node_modules", "dist"];
+          const noResolvePaths = ["/ui", "/api"];
+
+          if (
+            !ignorePaths.some((path) => id.includes(path)) &&
+            noResolvePaths.some((path) => id.includes(path))
+          ) {
+            return true;
+          }
+
+          return false;
+        });
+
+      return null;
+    },
+  };
+}

package/src/lib/checkIfValidJSON.js

@@ -0,0 +1,8 @@
+export default (text = '') => {
+  try {
+    const json = JSON.parse(text);
+    return json;
+  } catch (exception) {
+    return {};
+  }
+}

package/src/lib/colorLog.js

@@ -0,0 +1,5 @@
+import chalk from "chalk";
+
+export default (message = '', color = 'blueBright') => {
+  return console.log(chalk[color](message));
+};

package/src/lib/getArgs.js

@@ -0,0 +1,14 @@
+export default (args = {}) => {
+  return Object.entries(args).reduce((values, [argName, argData]) => {
+    // NOTE: When creating, names can have hyphens.
+    if (argData && argData.value && argData.parent && argData.parent === 'create') {
+      values[argName] = argData.value;
+    }
+
+    if (argData && argData.value && (!argData.parent || argData.parent !== 'create')) {
+      values[argName] = !argData.value.includes('-') ? argData.value : null;
+    }
+
+    return values;
+  }, {});
+};

package/src/lib/getCodeFrame.js

@@ -0,0 +1,8 @@
+import fs from 'fs';
+import { codeFrameColumns } from "@babel/code-frame";
+
+export default (id = "", location = {}) => {
+  const file = fs.readFileSync(id, "utf-8");
+  const frame = codeFrameColumns(file, { start: location });
+  return frame;
+};

package/src/lib/getOptions.js

@@ -0,0 +1,12 @@
+export default (options = {}) => {
+  return Object.entries(options).reduce((values, [optionName, optionData]) => {
+    if (optionData && optionData.flags) {
+      Object.entries(optionData.flags).forEach(([_flagName, flag]) => {
+        if (flag && flag.value) {
+          values[optionName] = flag.value && ![`${flag.value}`.substring(0, 1)].includes('-')? flag.value : null;
+        }
+      });
+    }
+    return values;
+  }, {});
+};

package/src/lib/getPlatformSafePath.js

@@ -0,0 +1,6 @@
+import isWindows from './isWindows.js';
+
+export default (path = '') => {
+  // NOTE: This is why serial killers exist.
+  return isWindows ? path.replace('/', '\\') : path;
+};

package/src/lib/getProvider.js

@@ -0,0 +1,5 @@
+export default (providers = [], provider = '') => {
+  return providers.find((providerOption) => {
+    return providerOption?.value === provider;
+  });
+}

package/src/lib/help.js

@@ -0,0 +1,56 @@
+
+import chalk from 'chalk';
+import { createRequire } from 'module';
+import functions from '../functions/index.js';
+import rainbowRoad from './rainbowRoad.js';
+
+const require = createRequire(import.meta.url);
+const packageJSON = require('../../package.json');
+
+const createSpacer = (target = 5, start = '') => {
+  const numberOfSpaces = target - start.length;
+  const spaces = [...(numberOfSpaces > 0 ? Array(target - start.length) : '')].map(() => ' ');
+  return spaces.join('');
+};
+
+const getArgsForFunction = (functionArgs = {}) => {
+  return Object.keys(functionArgs).map((functionArg) => `<${functionArg}>`).join(' ');
+};
+
+const buildOptionsForFunction = (functionOptions = {}) => {
+  return Object.entries(functionOptions).map(([optionName, optionSettings]) => {
+    return `
+      ${chalk.green(optionName)}${createSpacer(15, optionName)}${optionSettings.flags && Object.keys(optionSettings.flags).map((flag) => chalk.magenta(flag)).join(', ')}${createSpacer(15, optionName)}${optionSettings.description}
+   `;
+ }).join('\r');
+};
+
+export default () => {
+console.log(`
+
+  ${rainbowRoad()}
+  
+  ${chalk.yellowBright('@joystick.js/cli')} ${chalk.magenta(`(v${packageJSON.version})`)}
+  
+  ${chalk.blue('Create, start, build, and update your Joystick app.')}
+  
+  ${chalk.gray('https://github.com/cheatcode/joystick')}
+  
+  ${rainbowRoad()}\n
+  
+  ${chalk.magenta('Functions:')}
+
+  ${Object.entries(functions).map(([functionName, functionSettings]) => {
+    return `
+  ${chalk.green(functionName)}${createSpacer(8, functionName)}${chalk.gray(functionSettings.description)}\n
+    ${chalk.yellow('Usage:')}
+  
+      joystick ${functionName} ${chalk.yellow(getArgsForFunction(functionSettings.args))}\n
+    ${functionSettings.options && Object.keys(functionSettings.options).length > 0 ? `
+    ${chalk.yellow('Options:')}
+    ${buildOptionsForFunction(functionSettings.options)}
+    `: ''}
+    `;
+  }).join('')}
+  `);
+};

package/src/lib/isObject.js

@@ -0,0 +1,3 @@
+export default (value) => {
+  return !!(value && typeof value === "object" && !Array.isArray(value));
+};

package/src/lib/isValidJSONString.js

@@ -0,0 +1,8 @@
+export default (JSONString = "") => {
+  try {
+    const json = JSON.parse(JSONString);
+    return json;
+  } catch (error) {
+    return false;
+  }
+};

package/src/lib/isWindows.js

@@ -0,0 +1,3 @@
+import os from 'os';
+
+export default os.platform() === "win32";

package/src/lib/killProcesses.js

@@ -0,0 +1,5 @@
+// import killPortProcess from 'kill-port-process';
+
+// export default () => {
+
+// };

package/src/lib/loadSettings.js

@@ -0,0 +1,40 @@
+import fs from 'fs';
+import CLILog from './CLILog.js';
+import isValidJSONString from './isValidJSONString.js';
+
+export default async (env = null) => {
+  const environment = 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
+    : "{}";
+
+  // NOTE: Child process will inherit this env var from this parent process.
+  process.env.JOYSTICK_SETTINGS = settingsFile;
+
+  return JSON.parse(settingsFile);
+};