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

package/dist/esm/babel.config.cjs

@@ -0,0 +1,101 @@
+const { isApp } = require('./utils.cjs');
+
+const nodeEnvPreset = {
+  modules: process.env.ES_MODULES === 'false' ? 'commonjs' : false,
+  targets: {
+    node: 'current',
+  },
+};
+
+const webEnvPreset = {
+  modules: process.env.ES_MODULES === 'false' ? 'commonjs' : false,
+  useBuiltIns: 'usage',
+  corejs: { version: '3.19', proposals: true },
+};
+
+const presetEnvOptions =
+  process.env.TARGET_ENV === 'node' ? nodeEnvPreset : webEnvPreset;
+
+const config = {
+  ignore: [/\/core-js/],
+  sourceType: 'unambiguous',
+  presets: [
+    ['@babel/preset-env', presetEnvOptions],
+    ['@babel/preset-react', { runtime: 'automatic' }],
+    '@babel/preset-typescript',
+  ],
+  plugins: [
+    [
+      'babel-plugin-module-resolver',
+      {
+        alias: {
+          '@': isApp() ? './app' : './lib',
+        },
+        stripExtensions: [],
+      },
+    ],
+    ['babel-plugin-styled-components', { displayName: true }],
+    ['@babel/plugin-transform-runtime', { regenerator: true }],
+    '@babel/plugin-proposal-class-properties',
+    '@babel/plugin-syntax-dynamic-import',
+    '@babel/plugin-proposal-export-default-from',
+    'lodash',
+    'date-fns',
+  ],
+  env: {
+    development: {
+      plugins: [
+        ['babel-plugin-styled-components', { displayName: true }],
+        '@babel/plugin-transform-react-jsx-source',
+      ],
+    },
+    production: {
+      plugins: [
+        ['babel-plugin-styled-components', { displayName: false, pure: true }],
+        ['transform-remove-console', { exclude: ['error', 'warn'] }],
+        'transform-react-remove-prop-types',
+        '@babel/plugin-transform-react-inline-elements',
+        '@babel/plugin-transform-react-constant-elements',
+      ],
+    },
+    test: {
+      plugins: [
+        ['babel-plugin-styled-components', { displayName: true }],
+        '@babel/plugin-transform-modules-commonjs',
+        'dynamic-import-node',
+        [
+          'babel-plugin-transform-strip-block',
+          {
+            requireDirective: true,
+            identifiers: [{ start: 'block:start', end: 'block:end' }],
+          },
+        ],
+        'babel-plugin-import-remove-resource-query',
+      ],
+    },
+  },
+};
+
+if (process.env.MODULE_EXTENSIONS === 'true') {
+  config.plugins.push('babel-plugin-add-import-extension');
+}
+
+if (
+  process.env.STORYBOOK_BUILD !== 'true' &&
+  process.env.TARGET_ENV !== 'node'
+) {
+  config.env?.development?.plugins?.push?.('react-refresh/babel');
+}
+
+// ToDo: Once ECC team migrates from webpack 3 to webpack 5 remove this strip-block plugin from commonjs output. without this they are receiving error when import.meta is used in app sdk
+if (process.env.ES_MODULES === 'false') {
+  config.plugins.push([
+    'babel-plugin-transform-strip-block',
+    {
+      requireDirective: true,
+      identifiers: [{ start: 'block:start', end: 'block:end' }],
+    },
+  ]);
+}
+
+exports.babelConfig = config;

package/dist/esm/cli.js

@@ -0,0 +1,33 @@
+#!/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 "./update-notifier.js";
+import { buildCmd } from "./commands/build.js";
+import { packCmd } from "./commands/pack.js";
+import { startCmd } from "./commands/start.js";
+import { testCmd } from "./commands/test.js";
+import { lintCmd } from "./commands/lint.js";
+import { gendocCmd } from "./commands/gendoc.js";
+import { codemodCmd } from "./commands/codemod.js";
+import { storybookCmd } from "./commands/storybook.js";
+import { vitestCmd } from "./commands/vitest.js";
+import { versionCmd } from "./commands/version.js";
+import { tscheckCmd } from "./commands/tscheck.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;
+yargs(hideBin(process.argv)).command(tscheckCmd).help().argv;
+notifyUpdates();

package/dist/esm/commands/build.js

@@ -0,0 +1,56 @@
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+import yargs from "yargs";
+import {
+  exec,
+  logInfo,
+  logError,
+  logSuccess,
+  writeAppInfo,
+  copyBuildAssetsToVersionedFolder
+} from "./utils.js";
+import { esBuild, TARGETS } from "../transpile/esbuild.js";
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+const buildWebApp = async () => {
+  await exec(`rimraf ./build`);
+  await exec(`cross-env NODE_ENV=production webpack --config ${path.resolve(__dirname, "../webpack/webpack.prod.babel.js")} --color`);
+  await copyBuildAssetsToVersionedFolder();
+  await writeAppInfo();
+};
+const buildService = async () => {
+  await exec("rimraf ./build");
+  await esBuild({
+    srcdir: "./app",
+    outdir: "build",
+    esmOnly: true,
+    target: TARGETS.node,
+    injectReactShim: false,
+    skipNestedPackageJSON: true
+  });
+};
+const buildCmd = {
+  handler: async ({ service = false }) => {
+    try {
+      logInfo("Build in progress...");
+      if (service)
+        await buildService();
+      else
+        await buildWebApp();
+      logSuccess("Build completed");
+    } catch (err) {
+      logError("Build failed", err);
+      yargs().exit(-1, err);
+    }
+  },
+  command: "build",
+  describe: "builds front end application or NodeJS service",
+  builder: {
+    service: {
+      type: "boolean",
+      default: false
+    }
+  }
+};
+export {
+  buildCmd
+};

package/dist/esm/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/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, "../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/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 "../utils.cjs";
+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/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 "../utils.cjs";
+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/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/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/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/commands/tscheck.js

@@ -0,0 +1,65 @@
+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 fs from "node:fs";
+import yargs from "yargs";
+import { exec, logInfo, logError } from "./utils.js";
+const randomChars = () => Math.random().toString(36).slice(2);
+const validateTypescript = async (files = []) => {
+  const tsconfigPath = path.join(process.cwd(), "tsconfig.json");
+  const tsconfig = JSON.parse(fs.readFileSync(tsconfigPath));
+  const tmpTsconfigPath = path.join(process.cwd(), `tsconfig.${randomChars()}.json`);
+  const tmpTsconfig = __spreadProps(__spreadValues({}, tsconfig), {
+    compilerOptions: __spreadProps(__spreadValues({}, tsconfig.compilerOptions), {
+      skipLibCheck: true
+    }),
+    files,
+    include: ["app", "lib"]
+  });
+  fs.writeFileSync(tmpTsconfigPath, JSON.stringify(tmpTsconfig, null, 2));
+  const tscPath = path.resolve(process.cwd(), `./node_modules/.bin/tsc${process.platform === "win32" ? ".cmd" : ""}`);
+  try {
+    await exec(`${tscPath} -p ${tmpTsconfigPath} --noEmit --emitDeclarationOnly false`);
+  } finally {
+    fs.unlinkSync(tmpTsconfigPath);
+  }
+};
+const tscheckCmd = {
+  handler: async ({ files }) => {
+    try {
+      await validateTypescript(files);
+      logInfo("Typescript validation completed");
+    } catch (err) {
+      logError("Typescript validation failed", err);
+      yargs().exit(-1, err);
+    }
+  },
+  command: "tscheck [options]",
+  describe: "validate typescript file(s)",
+  builder: {
+    files: {
+      type: "array",
+      default: []
+    }
+  }
+};
+export {
+  tscheckCmd
+};