@elliemae/pui-cli 7.0.0-alpha.1 → 7.0.0-alpha.4

package/dist/esm/cli-commands/codemod.js

@@ -0,0 +1,29 @@
+import yargs from "yargs";
+import { exec, logInfo, logError, logSuccess } from "./utils.js";
+const transform = async (argv) => {
+  logInfo("Code modification in-progress...");
+  exec(`jscodeshift --ignore-file=.gitignore -t ${argv.transform} .`);
+};
+const codemodCmd = {
+  handler: async (argv) => {
+    try {
+      await transform(argv);
+      logSuccess("Code modifications completed. ");
+    } catch (err) {
+      logError("Code modifications failed", err);
+      yargs().exit(-1, err);
+    }
+  },
+  command: "codemod <transform>",
+  describe: "Transforms code",
+  builder: (yargsRef) => {
+    yargsRef.positional("transform", {
+      describe: "path to the transform file. Can be either a local path or url",
+      type: "string",
+      default: "./transform.js"
+    });
+  }
+};
+export {
+  codemodCmd
+};

package/dist/esm/cli-commands/gendoc.js

@@ -0,0 +1,29 @@
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+import fs from "node:fs";
+import yargs from "yargs";
+import { exec, logInfo, logSuccess, logError } from "./utils.js";
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+const isApp = () => fs.existsSync(path.join(process.cwd(), "app"));
+const generateDocs = async () => {
+  logInfo("Documentation Generation inprogress...");
+  const srcPath = path.join(process.cwd(), isApp() ? "app" : "lib");
+  await exec(`jsdoc ${srcPath} -r -c ${path.resolve(__dirname, "../docgen/jsdoc.conf.json")} -d docs`);
+};
+const gendocCmd = {
+  handler: async () => {
+    try {
+      await generateDocs();
+      logSuccess("Document generation completed. ");
+    } catch (err) {
+      logError("Document generation failed", err);
+      yargs().exit(-1, err);
+    }
+  },
+  command: "gendoc",
+  describe: "Builds documentation from source files",
+  builder: {}
+};
+export {
+  gendocCmd
+};

package/dist/esm/cli-commands/lint.js

@@ -0,0 +1,64 @@
+import path from "node:path";
+import yargs from "yargs";
+import { exec, logError, logSuccess } from "./utils.js";
+import { isTypeScriptEnabled } from "../typescript/util.js";
+const { CI = false } = process.env;
+const lintCSS = async (fix = false) => {
+  const fixIssues = fix ? "--fix" : "";
+  await exec(`stylelint ./{lib,app}/**/*.{js,jsx,ts,tsx} ${fixIssues} ${!CI ? "--color" : ""} --allow-empty-input --config ${path.join(process.cwd(), "stylelint.config.cjs")}`);
+};
+const lintJS = async (fix = false) => {
+  const fixIssues = fix ? "--fix" : "";
+  await exec(`eslint ${!CI ? "--color" : ""} ${fixIssues}  .`);
+};
+const lintCmd = {
+  handler: async (argv) => {
+    if (argv.js) {
+      if (isTypeScriptEnabled())
+        await exec("tsc --noEmit --emitDeclarationOnly false");
+      try {
+        await exec("rimraf ./reports/eslint.json");
+        await lintJS(argv.fix);
+        logSuccess("JS linting completed");
+      } catch (err) {
+        logError("JS linting failed");
+        yargs().exit(-1, err);
+        return -1;
+      }
+    }
+    if (argv.css) {
+      try {
+        await exec("rimraf ./reports/stylelint.json");
+        await lintCSS(argv.fix);
+        logSuccess("CSS linting completed");
+      } catch (err) {
+        logError("CSS linting failed");
+        yargs().exit(-1, err);
+        return -1;
+      }
+    }
+    return 0;
+  },
+  command: "lint [options]",
+  describe: "lints application code",
+  builder: {
+    css: {
+      alias: "css",
+      type: "boolean",
+      default: true
+    },
+    js: {
+      alias: "js",
+      type: "boolean",
+      default: true
+    },
+    fix: {
+      alias: "fix",
+      type: "boolean",
+      default: false
+    }
+  }
+};
+export {
+  lintCmd
+};

package/dist/esm/cli-commands/pack.js

@@ -0,0 +1,65 @@
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+import yargs from "yargs";
+import { exec, logInfo, logError, logSuccess } from "./utils.js";
+import { isTypeScriptEnabled } from "../typescript/util.js";
+import { esBuild } from "../transpile/esbuild.js";
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+const compileTypeScript = async () => {
+  logInfo("Generating types...");
+  await exec("tsc --emitDeclarationOnly");
+  logInfo("Types generation completed...");
+};
+const webBuild = async (productionBuild) => {
+  logInfo("Building source files for browser environment...");
+  const devCmd = `${path.resolve(__dirname, "../webpack/webpack.lib.dev.babel.js")} --color`;
+  const prodCmd = `${path.resolve(__dirname, "../webpack/webpack.lib.prod.babel.js")} --color`;
+  await exec(`webpack --config ${productionBuild ? prodCmd : devCmd}`);
+  logInfo("Building source files for browser environment completed...");
+};
+const pack = async ({ production, target, srcPath }) => {
+  logInfo("Build in-progress...");
+  await exec("rimraf ./dist");
+  if (isTypeScriptEnabled()) {
+    await compileTypeScript();
+  }
+  if (target !== "node")
+    await webBuild(production);
+  if (target !== "web") {
+    logInfo("Building source files for nodejs environment...");
+    await esBuild({ srcdir: srcPath });
+    logInfo("Building source files for nodejs environment completed.");
+  }
+};
+const packCmd = {
+  handler: async (argv) => {
+    try {
+      await pack(argv);
+      logSuccess("Build completed");
+    } catch (err) {
+      logError("Build failed", err);
+      yargs().exit(-1, err);
+    }
+  },
+  command: "pack",
+  describe: "builds library",
+  builder: {
+    production: {
+      alias: "p",
+      type: "boolean",
+      default: false
+    },
+    target: {
+      alias: "t",
+      type: "string",
+      description: "target environment where this library will be used. allowed values are web, node. by default libraries will be compiled for both web and nodejs environments"
+    },
+    srcPath: {
+      type: "string",
+      default: "./lib"
+    }
+  }
+};
+export {
+  packCmd
+};

package/dist/esm/cli-commands/start.js

@@ -0,0 +1,38 @@
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+import yargs from "yargs";
+import { exec, logError, logSuccess } from "./utils.js";
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+const startProdServer = async () => {
+  await exec(`cross-env NODE_ENV=production ts-node ${path.resolve(__dirname, "../server")} --color always`);
+};
+const startDevServer = async () => {
+  await exec(`cross-env NODE_ENV=development webpack serve --config ${path.resolve(__dirname, "../webpack/webpack.dev.babel.js")}`);
+};
+const startCmd = {
+  handler: async (argv) => {
+    try {
+      if (argv.prod) {
+        await startProdServer();
+      } else {
+        await startDevServer();
+      }
+      logSuccess("Server started");
+    } catch (err) {
+      logError("Server start failed", err);
+      yargs().exit(-1, err);
+    }
+  },
+  command: "start [options]",
+  describe: "starts local web server to test the application",
+  builder: {
+    prod: {
+      alias: "p",
+      default: false,
+      type: "boolean"
+    }
+  }
+};
+export {
+  startCmd
+};

package/dist/esm/cli-commands/storybook.js

@@ -0,0 +1,41 @@
+import yargs from "yargs";
+import { exec, logInfo, logError, logSuccess } from "./utils.js";
+const buildStoryBook = async (isDoc = false) => {
+  const additionalParams = isDoc ? "--docs -o demo/docs" : "-o demo";
+  await exec(`cross-env NODE_ENV=production FORCE_COLOR=true build-storybook --quiet ${additionalParams}`);
+};
+const startStoryBook = async (isDoc = false) => {
+  await exec(`cross-env NODE_ENV=development STORYBOOK_BUILD=true FORCE_COLOR=true start-storybook ${isDoc && "--docs"} -p 11000 --quiet`);
+};
+const storybookCmd = {
+  handler: async (argv) => {
+    try {
+      if (!argv.build) {
+        await startStoryBook(argv.docs);
+        logInfo("Storybook started");
+      } else {
+        await buildStoryBook(argv.docs);
+        logSuccess("Storybook build completed");
+      }
+    } catch (err) {
+      logError("Storybook execution failed", err);
+      yargs().exit(-1, err);
+    }
+  },
+  command: "storybook [options]",
+  describe: "story book application code",
+  builder: {
+    build: {
+      alias: "b",
+      type: "boolean",
+      default: false
+    },
+    docs: {
+      type: "boolean",
+      default: false
+    }
+  }
+};
+export {
+  storybookCmd
+};

package/dist/esm/cli-commands/test.js

@@ -0,0 +1,64 @@
+import yargs from "yargs";
+import { exec, logError, logSuccess } from "./utils.js";
+const { CI = false } = process.env;
+const test = async (commandOptions) => {
+  await exec(`cross-env NODE_ENV=test jest ${commandOptions}`);
+};
+const testCmd = {
+  handler: async (argv) => {
+    let commandOptions = "--coverage";
+    if (argv.fix)
+      commandOptions = "-u";
+    else if (argv.watch)
+      commandOptions = "--watchAll";
+    if (CI)
+      commandOptions += " --ci --runInBand --no-colors";
+    else
+      commandOptions += " --maxWorkers=50%";
+    if (argv.p)
+      commandOptions += " --passWithNoTests";
+    if (argv.r)
+      commandOptions += " --bail --findRelatedTests";
+    if (argv.s)
+      commandOptions += " --silent";
+    try {
+      if (CI) {
+        await exec("rimraf ./reports");
+      }
+      await test(commandOptions);
+      logSuccess("Unit test execution completed");
+    } catch (err) {
+      logError("Unit test execution failed", err);
+      yargs().exit(-1, err);
+      return -1;
+    }
+    return 0;
+  },
+  command: "test [options]",
+  describe: "unit tests application code",
+  builder: {
+    fix: {
+      alias: "f",
+      type: "boolean"
+    },
+    watch: {
+      alias: "w",
+      type: "boolean"
+    },
+    passWithNoTests: {
+      alias: "p",
+      type: "boolean"
+    },
+    findReleatedTests: {
+      alias: "r",
+      type: "boolean"
+    },
+    silent: {
+      alias: "s",
+      type: "boolean"
+    }
+  }
+};
+export {
+  testCmd
+};

package/dist/esm/cli-commands/tsc.js

@@ -0,0 +1,83 @@
+var __defProp = Object.defineProperty;
+var __defProps = Object.defineProperties;
+var __getOwnPropDescs = Object.getOwnPropertyDescriptors;
+var __getOwnPropSymbols = Object.getOwnPropertySymbols;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __propIsEnum = Object.prototype.propertyIsEnumerable;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __spreadValues = (a, b) => {
+  for (var prop in b || (b = {}))
+    if (__hasOwnProp.call(b, prop))
+      __defNormalProp(a, prop, b[prop]);
+  if (__getOwnPropSymbols)
+    for (var prop of __getOwnPropSymbols(b)) {
+      if (__propIsEnum.call(b, prop))
+        __defNormalProp(a, prop, b[prop]);
+    }
+  return a;
+};
+var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
+import path from "node:path";
+import yargs from "yargs";
+import { spawnSync } from "child_process";
+import fs from "fs";
+import { logInfo, logError } from "./utils.js";
+const randomChars = () => Math.random().toString(36).slice(2);
+const resolveFromRoot = (...paths) => path.join(process.cwd(), ...paths);
+const validateTypescript = async () => {
+  const args = process.argv.slice(2);
+  const argsProjectIndex = args.findIndex((arg) => ["-p", "--project"].includes(arg));
+  const argsProjectValue = argsProjectIndex !== -1 ? args[argsProjectIndex + 1] : void 0;
+  const files = args.filter((file) => /\.(ts|tsx)$/.test(file));
+  if (files.length === 0) {
+    process.exit(0);
+  }
+  const remainingArgsToForward = args.slice().filter((arg) => !files.includes(arg));
+  if (argsProjectIndex !== -1) {
+    remainingArgsToForward.splice(argsProjectIndex, 2);
+  }
+  const tsconfigPath = argsProjectValue || resolveFromRoot("tsconfig.json");
+  const tsconfigContent = fs.readFileSync(tsconfigPath).toString();
+  let tsconfig = {};
+  eval(`tsconfig = ${tsconfigContent}`);
+  const tmpTsconfigPath = resolveFromRoot(`tsconfig.${randomChars()}.json`);
+  const tmpTsconfig = __spreadProps(__spreadValues({}, tsconfig), {
+    compilerOptions: __spreadProps(__spreadValues({}, tsconfig.compilerOptions), {
+      skipLibCheck: true
+    }),
+    files,
+    include: ["shared/typings"]
+  });
+  fs.writeFileSync(tmpTsconfigPath, JSON.stringify(tmpTsconfig, null, 2));
+  const { status } = spawnSync("tsc", ["-p", tmpTsconfigPath, ...remainingArgsToForward], { stdio: "inherit" });
+  fs.unlinkSync(tmpTsconfigPath);
+  process.exit(status);
+};
+const tscCmd = {
+  handler: async (argv) => {
+    try {
+      await validateTypescript(argv.p);
+      logInfo("Typescript validation started");
+    } catch (err) {
+      logError("Typescript validation failed", err);
+      yargs().exit(-1, err);
+    }
+  },
+  command: "tsc [options]",
+  describe: "validate typescript code",
+  builder: {
+    project: {
+      alias: "p",
+      type: "boolean",
+      default: false
+    },
+    docs: {
+      type: "boolean",
+      default: false
+    }
+  }
+};
+export {
+  tscCmd,
+  validateTypescript
+};

package/dist/esm/cli-commands/utils.js

@@ -0,0 +1,120 @@
+import path from "node:path";
+import { readFile, writeFile, mkdir, readdir, copyFile } from "fs/promises";
+import { execaCommand } from "execa";
+import chalk from "chalk";
+import {
+  getPaths,
+  isAppLoaderEnabled,
+  getAppVersion,
+  LATEST_VERSION
+} from "../webpack/helpers.js";
+const browsersMapping = {
+  and_chr: "Chrome for Android",
+  chrome: "Google Chrome",
+  edge: "Microsoft Edge",
+  firefox: "Mozilla Firefox",
+  ios_saf: "iOS Safari",
+  safari: "Safari",
+  samsung: "Samsung Internet"
+};
+const exec = async (command, options = { stdio: "inherit" }) => execaCommand(command, options);
+const logInfo = console.log;
+const logSuccess = (...args) => console.log(chalk.green(...args));
+const logError = console.error;
+const readPackageLock = async () => {
+  try {
+    const appPkgLockFile = path.join(process.cwd(), "package-lock.json");
+    const pkgLockJSON = await readFile(appPkgLockFile, "utf8");
+    const { dependencies } = JSON.parse(pkgLockJSON);
+    return (moduleName) => dependencies[moduleName]?.version || "";
+  } catch (err) {
+    console.warn("Package lock file not found");
+    return () => "";
+  }
+};
+const getSupportedBrowsers = async () => {
+  const { stdout } = await exec("npx --no-install browserslist", {
+    stdout: "pipe"
+  });
+  const browserVersions = stdout && stdout.split("\n") || [];
+  return browserVersions.reduce((acc, nameVersion) => {
+    const [name, version] = nameVersion.split(" ");
+    const versionRange = version.split("-");
+    acc[browsersMapping[name]] = versionRange && versionRange[0] || version;
+    return acc;
+  }, {});
+};
+const getModulesInfo = async () => {
+  try {
+    const getModuleVersion = await readPackageLock();
+    return {
+      react: getModuleVersion("react"),
+      "react-dom": getModuleVersion("react-dom"),
+      "app-react-dependencies": getModuleVersion("@elliemae/app-react-dependencies"),
+      "app-sdk": getModuleVersion("@elliemae/pui-app-sdk"),
+      cli: getModuleVersion("@elliemae/pui-cli"),
+      dimsum: getModuleVersion("@elliemae/ds-system")
+    };
+  } catch (err) {
+    console.warn(err);
+    return {};
+  }
+};
+const writeAppInfo = async () => {
+  const appInfo = {
+    timestamp: new Date().toISOString(),
+    modules: await getModulesInfo(),
+    browserSupport: await getSupportedBrowsers(),
+    screenReaderSupport: [
+      "JAWS with Chrome",
+      "NVDA with Chrome",
+      "VoiceOver with Safari",
+      "iOS VoiceOver",
+      "Android Talkback"
+    ]
+  };
+  const infoJSON = JSON.stringify(appInfo, null, 2);
+  const { buildPath: versionedPath } = getPaths();
+  [
+    path.join(versionedPath, "info.json"),
+    path.join(process.cwd(), "build", "public", "info.json")
+  ].forEach(async (infoPath) => writeFile(infoPath, infoJSON));
+};
+const copyDir = async (src, dest) => {
+  const entries = await readdir(src, {
+    withFileTypes: true
+  });
+  await mkdir(dest);
+  return Promise.all(entries.map((entry) => {
+    const srcPath = path.join(src, entry.name);
+    const destPath = path.join(dest, entry.name);
+    if (entry.isDirectory()) {
+      return copyDir(srcPath, destPath);
+    }
+    return copyFile(srcPath, destPath);
+  }));
+};
+const updateManifestWithVersionInfo = async (dest) => {
+  const manifestFile = path.join(dest, "manifest.json");
+  let manifestData = await readFile(manifestFile, "utf8");
+  manifestData = manifestData.replace(/latest\//g, `${getAppVersion()}/`);
+  await writeFile(manifestFile, manifestData);
+};
+const copyBuildAssetsToVersionedFolder = async () => {
+  const appVersion = getAppVersion();
+  const isVersionedApp = isAppLoaderEnabled() && appVersion !== LATEST_VERSION;
+  if (!isVersionedApp)
+    return;
+  const src = path.resolve(process.cwd(), "build/public/latest");
+  const dest = path.resolve(process.cwd(), `build/public/${appVersion}`);
+  await copyDir(src, dest);
+  await updateManifestWithVersionInfo(dest);
+};
+export {
+  copyBuildAssetsToVersionedFolder,
+  exec,
+  logError,
+  logInfo,
+  logSuccess,
+  writeAppInfo
+};

package/dist/esm/cli-commands/version.js

@@ -0,0 +1,49 @@
+import yargs from "yargs";
+import { exec, logError } from "./utils.js";
+import { setWorkspaceVersion } from "../monorepo/set-workspace-version.js";
+import { setRegistryVersion } from "../monorepo/set-registry-version.js";
+import { deleteMergedTags } from "../monorepo/delete-merged-tags.js";
+const version = async (lernaOptions = "") => {
+  await exec(`cross-env NODE_ENV=production lerna version --conventional-commits --exact --create-release github --force-publish --yes ${lernaOptions}`);
+};
+const versionCmd = {
+  handler: async (argv) => {
+    try {
+      if (argv.deleteTags) {
+        await deleteMergedTags();
+      } else if (argv.useRegistry) {
+        await setRegistryVersion();
+      } else if (argv.useWorkspace) {
+        await setWorkspaceVersion();
+      } else {
+        await version(argv.lernaOptions);
+      }
+    } catch (err) {
+      logError("Monorepo versioning failed", err);
+      yargs().exit(-1, err);
+    }
+  },
+  command: "version [options]",
+  describe: "version monorepo",
+  builder: {
+    deleteTags: {
+      type: "boolean",
+      default: false
+    },
+    useRegistry: {
+      type: "boolean",
+      default: false
+    },
+    useWorkspace: {
+      type: "boolean",
+      default: false
+    },
+    lernaOptions: {
+      type: "string",
+      default: false
+    }
+  }
+};
+export {
+  versionCmd
+};

package/dist/esm/cli-commands/vitest.js

@@ -0,0 +1,61 @@
+import yargs from "yargs";
+import { exec, logError, logSuccess } from "./utils.js";
+const { CI = false } = process.env;
+const configPath = new URL("../testing/vitest.config.ts", import.meta.url);
+const test = async (commandOptions) => {
+  await exec(`cross-env FORCE_COLOR=true vitest --config ${configPath} ${commandOptions}`);
+};
+const vitestCmd = {
+  handler: async (argv) => {
+    let commandOptions = "--coverage";
+    if (argv.fix)
+      commandOptions = "-u";
+    else if (argv.watch)
+      commandOptions = "--watch";
+    if (argv.p)
+      commandOptions += " --passWithNoTests";
+    if (argv.r)
+      commandOptions += " --related";
+    if (argv.s)
+      commandOptions += " --silent";
+    try {
+      if (CI) {
+        await exec("rimraf ./reports");
+      }
+      await test(commandOptions);
+      logSuccess("Unit test execution completed");
+    } catch (err) {
+      logError("Unit test execution failed", err);
+      yargs().exit(-1, err);
+      return -1;
+    }
+    return 0;
+  },
+  command: "vitest [options]",
+  describe: "unit tests application code using vitest",
+  builder: {
+    fix: {
+      alias: "f",
+      type: "boolean"
+    },
+    watch: {
+      alias: "w",
+      type: "boolean"
+    },
+    passWithNoTests: {
+      alias: "p",
+      type: "boolean"
+    },
+    related: {
+      alias: "r",
+      type: "boolean"
+    },
+    silent: {
+      alias: "s",
+      type: "boolean"
+    }
+  }
+};
+export {
+  vitestCmd
+};

package/dist/esm/cli.js

@@ -0,0 +1,31 @@
+#!/usr/bin/env node
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+import yargs from "yargs";
+import { hideBin } from "yargs/helpers";
+import { config as envConfig } from "dotenv";
+import notifyUpdates from "./scripts/update-notifier.js";
+import { buildCmd } from "./cli-commands/build.js";
+import { packCmd } from "./cli-commands/pack.js";
+import { startCmd } from "./cli-commands/start.js";
+import { testCmd } from "./cli-commands/test.js";
+import { lintCmd } from "./cli-commands/lint.js";
+import { gendocCmd } from "./cli-commands/gendoc.js";
+import { codemodCmd } from "./cli-commands/codemod.js";
+import { storybookCmd } from "./cli-commands/storybook.js";
+import { vitestCmd } from "./cli-commands/vitest.js";
+import { versionCmd } from "./cli-commands/version.js";
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+envConfig();
+process.env.PATH += path.delimiter + path.join(__dirname, "..", "node_modules", ".bin");
+yargs(hideBin(process.argv)).command(buildCmd).help().argv;
+yargs(hideBin(process.argv)).command(packCmd).help().argv;
+yargs(hideBin(process.argv)).command(startCmd).help().argv;
+yargs(hideBin(process.argv)).command(testCmd).help().argv;
+yargs(hideBin(process.argv)).command(lintCmd).help().argv;
+yargs(hideBin(process.argv)).command(gendocCmd).help().argv;
+yargs(hideBin(process.argv)).command(codemodCmd).help().argv;
+yargs(hideBin(process.argv)).command(storybookCmd).help().argv;
+yargs(hideBin(process.argv)).command(vitestCmd).help().argv;
+yargs(hideBin(process.argv)).command(versionCmd).help().argv;
+notifyUpdates();