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

package/dist/esm/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/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/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/index.cjs

@@ -0,0 +1,25 @@
+const { babelConfig } = require('./babel.config.cjs');
+const {
+  esConfig: eslintBaseConfig,
+} = require('./lint-config/eslint/non-react.cjs');
+const {
+  esReactConfig: eslintConfig,
+} = require('./lint-config/eslint/react.cjs');
+const { stylelintConfig } = require('./lint-config/stylelint.config.cjs');
+const { prettierConfig } = require('./lint-config/prettier.config.cjs');
+const { commitlintConfig } = require('./lint-config/commitlint.config.cjs');
+const { jestConfig } = require('./testing/jest.config.cjs');
+const { jestNodeConfig } = require('./testing/jest.node.config.cjs');
+const { loadRoutes } = require('./server/app-routes.cjs');
+
+module.exports = {
+  babelConfig,
+  eslintBaseConfig,
+  eslintConfig,
+  stylelintConfig,
+  prettierConfig,
+  commitlintConfig,
+  jestConfig,
+  jestNodeConfig,
+  loadRoutes,
+};

package/dist/esm/index.js

@@ -0,0 +1,22 @@
+import { babelConfig } from "./babel.config.cjs";
+import { esConfig } from "./lint-config/eslint/non-react.cjs";
+import { esReactConfig } from "./lint-config/eslint/react.cjs";
+import { stylelintConfig } from "./lint-config/stylelint.config.cjs";
+import { prettierConfig } from "./lint-config/prettier.config.cjs";
+import { commitlintConfig } from "./lint-config/commitlint.config.cjs";
+import { jestConfig } from "./testing/jest.config.cjs";
+import { jestNodeConfig } from "./testing/jest.node.config.cjs";
+import { lintStagedConfig } from "./lint-config/lint-staged.config.js";
+import { loadRoutes } from "./server/app-routes.cjs";
+export {
+  babelConfig,
+  commitlintConfig,
+  esConfig as eslintBaseConfig,
+  esReactConfig as eslintConfig,
+  jestConfig,
+  jestNodeConfig,
+  lintStagedConfig,
+  loadRoutes,
+  prettierConfig,
+  stylelintConfig
+};

package/dist/esm/jsdoc.conf.json

@@ -0,0 +1,17 @@
+{
+  "plugins": ["plugins/markdown"],
+  "opts": {
+    "template": "node_modules/docdash"
+  },
+  "docdash": {
+    "sort": true,
+    "search": true,
+    "collapse": true,
+    "wrap": true
+  },
+  "templates": {
+    "default": {
+      "includeDate": false
+    }
+  }
+}

package/dist/esm/lint-config/commitlint.config.cjs

@@ -0,0 +1 @@
+exports.commitlintConfig = { extends: ['@commitlint/config-conventional'] };

package/dist/esm/lint-config/eslint/common.cjs

@@ -0,0 +1,160 @@
+/* eslint-disable max-lines */
+const prettierOptions = require('../prettier.config.cjs');
+// const webpackConfig = require('../../webpack/webpack.prod.babel');
+
+exports.baseExtends = [
+  'plugin:eslint-comments/recommended',
+  'plugin:import/recommended',
+  'plugin:prettier/recommended',
+  'plugin:jest/recommended',
+  'plugin:jsdoc/recommended',
+  'plugin:wdio/recommended',
+  'plugin:testing-library/dom',
+  'plugin:storybook/recommended',
+];
+
+const basePlugins = ['testing-library', 'jest', 'jsdoc', 'wdio', 'import'];
+exports.basePlugins = basePlugins;
+
+exports.baseOverrides = [
+  {
+    files: ['*.func.spec.js', '*.visual.spec.js'],
+    rules: {
+      'jest/valid-expect': 'off',
+    },
+  },
+];
+
+const baseRules = {
+  'prettier/prettier': ['error', prettierOptions],
+  'arrow-body-style': [2, 'as-needed'],
+  'class-methods-use-this': 0,
+  'import/imports-first': 0,
+  'import/newline-after-import': 0,
+  'import/no-dynamic-require': 0,
+  'import/no-extraneous-dependencies': 0,
+  'import/no-named-as-default': 0,
+  'import/no-unresolved': [
+    2,
+    { caseSensitive: true, caseSensitiveStrict: true },
+  ], // Tip: https://github.com/import-js/eslint-plugin-import/issues/1868
+  'import/no-webpack-loader-syntax': 0,
+  'import/prefer-default-export': 0,
+  'import/extensions': [
+    2,
+    'never',
+    {
+      json: 'ignorePackages',
+      js: 'ignorePackages',
+    },
+  ],
+  indent: [
+    2,
+    2,
+    {
+      SwitchCase: 1,
+    },
+  ],
+  'max-lines': ['error', { max: 120, skipComments: true }],
+  complexity: ['error', { max: 10 }],
+  'max-depth': ['error', { max: 4 }],
+  'max-lines-per-function': 0,
+  'max-nested-callbacks': ['error', { max: 3 }],
+  'max-params': ['error', { max: 3 }],
+  'max-statements': ['error', { max: 20 }],
+  'max-len': 0,
+  'newline-per-chained-call': 0,
+  'no-confusing-arrow': 0,
+  'no-console': 1,
+  'no-param-reassign': ['error', { props: false }],
+  'no-unused-vars': 2,
+  'no-use-before-define': 0,
+  'prefer-template': 2,
+  'require-yield': 0,
+  'jsdoc/require-jsdoc': 0,
+  'eslint-comments/disable-enable-pair': 0,
+};
+
+exports.baseRules = baseRules;
+
+const reactRules = {
+  'jsx-a11y/aria-props': 2,
+  'jsx-a11y/heading-has-content': 0,
+  'jsx-a11y/label-has-associated-control': [
+    2,
+    {
+      // NOTE: If this error triggers, either disable it or add
+      // your custom components, labels and attributes via these options
+      // See https://github.com/evcohen/eslint-plugin-jsx-a11y/blob/master/docs/rules/label-has-associated-control.md
+      controlComponents: ['Input'],
+    },
+  ],
+  'jsx-a11y/label-has-for': 0,
+  'jsx-a11y/mouse-events-have-key-events': 2,
+  'jsx-a11y/role-has-required-aria-props': 2,
+  'jsx-a11y/role-supports-aria-props': 2,
+  'react/destructuring-assignment': 0,
+  'react-hooks/rules-of-hooks': 'error',
+  'react/jsx-closing-tag-location': 0,
+  'react/forbid-prop-types': 0,
+  'react/jsx-first-prop-new-line': [2, 'multiline'],
+  'react/jsx-no-target-blank': 0,
+  'react/jsx-props-no-spreading': 0,
+  'react/jsx-uses-vars': 2,
+  'react/require-default-props': 0,
+  'react/require-extension': 0,
+  'react/self-closing-comp': 0,
+  'react/sort-comp': 0,
+  'react/react-in-jsx-scope': 0,
+  'react/jsx-filename-extension': [
+    1,
+    { extensions: ['.js', '.jsx', '.tsx', '.mdx'] },
+  ],
+  'react/function-component-definition': [
+    2,
+    { namedComponents: 'arrow-function' },
+  ],
+  'redux-saga/no-yield-in-race': 2,
+  'redux-saga/yield-effects': 2,
+};
+exports.reactRules = reactRules;
+
+exports.baseConfig = {
+  parser: '@babel/eslint-parser',
+  plugins: basePlugins,
+  env: {
+    jest: true,
+    browser: true,
+    node: true,
+    es2021: true,
+  },
+  parserOptions: {
+    sourceType: 'module',
+    ecmaFeatures: {
+      jsx: true,
+    },
+  },
+  settings: {
+    react: {
+      version: 'detect',
+    },
+    jest: {
+      version: 28,
+    },
+    'import/resolver': {
+      node: {
+        extensions: ['.js', '.jsx', '.ts', '.tsx']
+      },
+    },
+  },
+  ignorePatterns: [
+    '/build/**/*',
+    '/dist/**/*',
+    '/reports/**/*',
+    '/coverage/**/*',
+    '/demo/**/*',
+    '/docs/**/*',
+    '/temp/**/*',
+    '**/vendor/*.js',
+  ],
+};

package/dist/esm/lint-config/eslint/non-react.cjs

@@ -0,0 +1,14 @@
+const {
+  baseExtends,
+  baseRules,
+  baseOverrides,
+  baseConfig,
+} = require('./common.cjs');
+const { tsConfig } = require('./typescript/non-react.cjs');
+
+exports.esConfig = {
+  ...baseConfig,
+  extends: ['airbnb-base'].concat(baseExtends),
+  rules: baseRules,
+  overrides: baseOverrides.concat([tsConfig]),
+};

package/dist/esm/lint-config/eslint/react.cjs

@@ -0,0 +1,26 @@
+const {
+  baseExtends,
+  baseRules,
+  baseOverrides,
+  baseConfig,
+  reactRules,
+} = require('./common.cjs');
+const { tsReactConfig } = require('./typescript/react.cjs');
+
+exports.esReactConfig = {
+  ...baseConfig,
+  extends: ['airbnb', 'airbnb/hooks', 'plugin:redux-saga/recommended'].concat(
+    baseExtends,
+  ),
+  rules: {
+    ...baseRules,
+    ...reactRules,
+  },
+  overrides: baseOverrides.concat([
+    tsReactConfig,
+    {
+      files: '*.mdx',
+      extends: 'plugin:mdx/recommended',
+    },
+  ]),
+};

package/dist/esm/lint-config/eslint/typescript/common.cjs

@@ -0,0 +1,43 @@
+const { baseExtends, basePlugins } = require('../common.cjs');
+
+exports.tsBaseExtends = [
+  'plugin:@typescript-eslint/recommended',
+  'plugin:import/typescript',
+  'plugin:@typescript-eslint/recommended-requiring-type-checking',
+].concat(baseExtends);
+
+exports.tsBaseRules = {
+  '@typescript-eslint/explicit-module-boundary-types': 'off',
+  '@typescript-eslint/explicit-function-return-type': 'off',
+  '@typescript-eslint/no-use-before-define': [
+    'error',
+    { functions: false, classes: true, variables: true, typedefs: true },
+  ],
+  'max-lines': ['error', { max: 200, skipComments: true }],
+  '@typescript-eslint/unbound-method': [
+    'error',
+    {
+      ignoreStatic: true,
+    },
+  ],
+};
+
+exports.tsBaseConfig = {
+  files: ['*.ts', '*.tsx'],
+  parser: '@typescript-eslint/parser',
+  plugins: ['@typescript-eslint'].concat(basePlugins),
+  parserOptions: {
+    tsconfigRootDir: process.cwd(),
+    project: 'tsconfig.json',
+  },
+  settings: {
+    'import/resolver': {
+      typescript: {
+        alwaysTryTypes: true,
+      },
+    },
+    'import/parsers': {
+      '@typescript-eslint/parser': ['.ts', '.tsx'],
+    },
+  },
+};

package/dist/esm/lint-config/eslint/typescript/non-react.cjs

@@ -0,0 +1,12 @@
+/* eslint-disable max-lines */
+const { baseRules } = require('../common.cjs');
+const { tsBaseExtends, tsBaseRules, tsBaseConfig } = require('./common.cjs');
+
+exports.tsConfig = {
+  ...tsBaseConfig,
+  extends: ['airbnb-base', 'airbnb-typescript/base'].concat(tsBaseExtends),
+  rules: {
+    ...baseRules,
+    ...tsBaseRules,
+  },
+};

package/dist/esm/lint-config/eslint/typescript/react.cjs

@@ -0,0 +1,19 @@
+/* eslint-disable max-lines */
+const { baseRules, reactRules } = require('../common.cjs');
+const { tsBaseExtends, tsBaseRules, tsBaseConfig } = require('./common.cjs');
+
+exports.tsReactConfig = {
+  ...tsBaseConfig,
+  extends: [
+    'airbnb',
+    'airbnb/hooks',
+    'plugin:redux-saga/recommended',
+    'airbnb-typescript',
+  ].concat(tsBaseExtends),
+  rules: {
+    ...baseRules,
+    ...tsBaseRules,
+    ...reactRules,
+    'react/prop-types': 0,
+  },
+};

package/dist/esm/lint-config/lint-staged.config.js

@@ -0,0 +1,15 @@
+import path from "node:path";
+import fs from "node:fs";
+const npmClient = fs.existsSync(path.join(process.cwd(), "pnpm-lock.yaml")) ? "pnpm" : "npm";
+const lintStagedConfig = {
+  "*.{js,ts,jsx,tsx,md,mdx,html,css,json}": ["prettier --write"],
+  "*.{ts,tsx}": [`${npmClient} run tscheck`],
+  "*.{js,ts,jsx,tsx}": [
+    `${npmClient} run lint:fix`,
+    `${npmClient} run test:staged`,
+    `${npmClient} run gendoc`
+  ]
+};
+export {
+  lintStagedConfig
+};

package/dist/esm/lint-config/prettier.config.cjs

@@ -0,0 +1,8 @@
+exports.prettierConfig = {
+  printWidth: 80,
+  tabWidth: 2,
+  useTabs: false,
+  semi: true,
+  singleQuote: true,
+  trailingComma: 'all',
+};

package/dist/esm/lint-config/stylelint.config.cjs

@@ -0,0 +1,19 @@
+exports.stylelintConfig = {
+  ignoreFiles: [
+    '/dist/**/*',
+    '/coverage/**/*',
+    '/build/**/*',
+    '/reports/**/*',
+    '/temp/**/*',
+    '/docs/**/*',
+    '/demo/**/*',
+    '/node_modules/**/*',
+    '/vendor/**/*',
+  ],
+  customSyntax: '@stylelint/postcss-css-in-js',
+  extends: [
+    'stylelint-config-recommended',
+    'stylelint-config-styled-components',
+  ],
+  rules: { 'selector-type-no-unknown': null, 'no-extra-semicolons': null, 'function-no-unknown': null },
+};

package/dist/esm/monorepo/delete-merged-tags.js

@@ -0,0 +1,38 @@
+import { execSync } from "child_process";
+const cwd = process.cwd();
+const execaOptions = { cwd, stdio: "inherit" };
+const semVerRegEx = /^v?(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$/;
+const isSemVersion = (tagName) => semVerRegEx.test(tagName);
+const branchName = (process.env.BRANCH_NAME || "master").toLowerCase();
+const branchTags = {
+  master: /^v?(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$/,
+  next: /^v.*-next\.(0|[1-9]\d*)/,
+  alpha: /^v.*-alpha\.(0|[1-9]\d*)/,
+  beta: /^v.*-beta\.(0|[1-9]\d*)/
+};
+const deleteTags = (cmd, filter) => {
+  const result = execSync(cmd, { cwd });
+  if (!result)
+    return;
+  const tags = result.toString().split("\n").join(" ");
+  execSync(`git tag -d ${filter ? filter(tags) : tags}`, { cwd });
+};
+const tagsFromOtherBranches = (tags = []) => {
+  const regex = branchTags[branchName] || branchTags.master;
+  return tags.split(" ").filter((tagName) => isSemVersion(tagName) && !regex.test(tagName)).join(" ");
+};
+const deleteMergedTags = () => {
+  try {
+    if (branchName) {
+      deleteTags(`git tag -l --no-merged ${branchName}`);
+      deleteTags(`git tag -l --merged ${branchName}`, tagsFromOtherBranches);
+      console.log("Last two tags: ");
+      execSync("git tag --sort=-creatordate | head -n 2", execaOptions);
+    }
+  } catch (error) {
+    console.error(error);
+  }
+};
+export {
+  deleteMergedTags
+};