@elliemae/pui-cli 6.0.0-beta.4 → 6.0.0-beta.40

package/lib/cli-commands/pack.js

@@ -4,7 +4,7 @@ const path = require('path');
 const { writeFile, readFile } = require('fs/promises');
 const { exec, logInfo, logError, logSuccess } = require('./utils');
 const { isTypeScriptEnabled } = require('../typescript/util');
-const { esBuild } = require('../esbuild');
+const { esBuild } = require('../transpile/esbuild');
 
 const { name } = require('../../package.json');
 

package/lib/cli-commands/test.js

@@ -1,6 +1,5 @@
 const { exit } = require('yargs');
 const { exec, logError, logSuccess } = require('./utils');
-const { lintCSS, lintJS } = require('./lint');
 
 const { CI = false } = process.env;
 
@@ -19,17 +18,7 @@ async function handler(argv) {
   if (argv.r) commandOptions += ' --bail --findRelatedTests';
   if (argv.s) commandOptions += ' --silent';
   try {
-    if (!CI) {
-      try {
-        await lintJS();
-        await lintCSS();
-        logSuccess('Linting completed');
-      } catch (err) {
-        logError('Linting failed');
-        exit(-1, err);
-        return -1;
-      }
-    } else {
+    if (CI) {
       await exec('rimraf ./reports');
     }
 

package/lib/cli-commands/tsc.js

@@ -0,0 +1,103 @@
+const { exit } = require('yargs');
+const { dirname, join } = require('path');
+const { spawnSync } = require('child_process');
+const fs = require('fs');
+const { logInfo, logError } = require('./utils');
+
+const randomChars = () => Math.random().toString(36).slice(2);
+
+const resolveFromModule = (moduleName, ...paths) => {
+  const modulePath = dirname(require.resolve(`${moduleName}/package.json`));
+  return join(modulePath, ...paths);
+};
+
+const resolveFromRoot = (...paths) => 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] : undefined;
+
+  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);
+  }
+
+  // Load existing config
+  const tsconfigPath = argsProjectValue || resolveFromRoot('tsconfig.json');
+  const tsconfigContent = fs.readFileSync(tsconfigPath).toString();
+  // Use 'eval' to read the JSON as regular JavaScript syntax so that comments are allowed
+  // eslint-disable-next-line prefer-const
+  let tsconfig = {};
+  // eslint-disable-next-line no-eval
+  eval(`tsconfig = ${tsconfigContent}`);
+
+  // Write a temp config file
+  const tmpTsconfigPath = resolveFromRoot(`tsconfig.${randomChars()}.json`);
+  const tmpTsconfig = {
+    ...tsconfig,
+    compilerOptions: {
+      ...tsconfig.compilerOptions,
+      skipLibCheck: true,
+    },
+    files,
+    include: ['shared/typings'],
+  };
+  fs.writeFileSync(tmpTsconfigPath, JSON.stringify(tmpTsconfig, null, 2));
+
+  // Type-check our files
+  const { status } = spawnSync(
+    resolveFromModule(
+      'typescript',
+      `../.bin/tsc${process.platform === 'win32' ? '.cmd' : ''}`,
+    ),
+    ['-p', tmpTsconfigPath, ...remainingArgsToForward],
+    { stdio: 'inherit' },
+  );
+
+  // Delete temp config file
+  fs.unlinkSync(tmpTsconfigPath);
+
+  process.exit(status);
+};
+
+async function handler(argv) {
+  try {
+    await validateTypescript(argv.p);
+    logInfo('Typescript validation started');
+  } catch (err) {
+    logError('Typescript validation failed', err);
+    exit(-1, err);
+  }
+}
+
+exports.command = 'tsc [options]';
+
+exports.describe = 'validate typescript code';
+
+exports.builder = {
+  project: {
+    alias: 'p',
+    type: 'boolean',
+    default: false,
+  },
+  docs: {
+    type: 'boolean',
+    default: false,
+  },
+};
+
+exports.handler = handler;
+
+exports.validateTypescript = validateTypescript;

package/lib/cli-commands/utils.js

@@ -24,10 +24,15 @@ exports.logSuccess = (...args) => console.log(chalk.green(...args));
 exports.logError = console.error;
 
 const readPackageLock = async () => {
-  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 || '';
+  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 () => {

package/lib/cli-commands/vitest.js

@@ -0,0 +1,66 @@
+const { exit } = require('yargs');
+const path = require('path');
+const { exec, logError, logSuccess } = require('./utils');
+
+const { CI = false } = process.env;
+
+const configPath = path.resolve(__dirname, '../testing/vitest.config.ts');
+
+async function test(commandOptions) {
+  await exec(
+    `cross-env FORCE_COLOR=true vitest --config ${configPath} ${commandOptions}`,
+  );
+}
+
+// eslint-disable-next-line max-statements
+async function handler(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');
+    }
+
+    // eslint-disable-next-line jest/valid-title, jest/no-disabled-tests, jest/expect-expect
+    await test(commandOptions);
+    logSuccess('Unit test execution completed');
+  } catch (err) {
+    logError('Unit test execution failed', err);
+    exit(-1, err);
+    return -1;
+  }
+  return 0;
+}
+
+exports.command = 'vitest [options]';
+
+exports.describe = 'unit tests application code using vitest';
+
+exports.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',
+  },
+};
+
+exports.handler = handler;

package/lib/cli.js

@@ -12,6 +12,7 @@ const lintCmd = require('./cli-commands/lint');
 const gendocCmd = require('./cli-commands/gendoc');
 const codemodCmd = require('./cli-commands/codemod');
 const storybookCmd = require('./cli-commands/storybook');
+const vitestCmd = require('./cli-commands/vitest');
 
 envConfig();
 process.env.PATH +=
@@ -25,5 +26,6 @@ yargs.command(lintCmd).help().argv;
 yargs.command(gendocCmd).help().argv;
 yargs.command(codemodCmd).help().argv;
 yargs.command(storybookCmd).help().argv;
+yargs.command(vitestCmd).help().argv;
 
 notifyUpdates();

package/lib/lint/eslint/common.js

@@ -4,14 +4,17 @@ 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'];
+const basePlugins = ['testing-library', 'jest', 'jsdoc', 'wdio', 'import'];
+exports.basePlugins = basePlugins;
 
 exports.baseOverrides = [
   {
@@ -36,12 +39,10 @@ const baseRules = {
   'import/prefer-default-export': 0,
   'import/extensions': [
     2,
-    'ignorePackages',
+    'never',
     {
-      js: 'never',
-      jsx: 'never',
-      ts: 'never',
-      tsx: 'never',
+      json: 'ignorePackages',
+      js: 'ignorePackages',
     },
   ],
   indent: [
@@ -104,7 +105,11 @@ const reactRules = {
   'react/react-in-jsx-scope': 0,
   'react/jsx-filename-extension': [
     1,
-    { extensions: ['.js', '.jsx', '.ts', '.tsx'] },
+    { 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,

package/lib/lint/eslint/typescript/common.js

@@ -1,7 +1,8 @@
-const { baseExtends } = require('../common');
+const { baseExtends, basePlugins } = require('../common');
 
 exports.tsBaseExtends = [
   'plugin:@typescript-eslint/recommended',
+  'plugin:import/typescript',
   'plugin:@typescript-eslint/recommended-requiring-type-checking',
 ].concat(baseExtends);
 
@@ -24,6 +25,7 @@ exports.tsBaseRules = {
 exports.tsBaseConfig = {
   files: ['*.ts', '*.tsx'],
   parser: '@typescript-eslint/parser',
+  plugins: ['@typescript-eslint'].concat(basePlugins),
   parserOptions: {
     tsconfigRootDir: process.cwd(),
     project: 'tsconfig.json',
@@ -34,5 +36,8 @@ exports.tsBaseConfig = {
         alwaysTryTypes: true,
       },
     },
+    'import/parsers': {
+      '@typescript-eslint/parser': ['.ts', '.tsx'],
+    },
   },
 };

package/lib/lint/eslint/typescript/non-react.js

@@ -4,7 +4,7 @@ const { tsBaseExtends, tsBaseRules, tsBaseConfig } = require('./common');
 
 exports.tsConfig = {
   ...tsBaseConfig,
-  extends: ['airbnb-typescript/base'].concat(tsBaseExtends),
+  extends: ['airbnb-base', 'airbnb-typescript/base'].concat(tsBaseExtends),
   rules: {
     ...baseRules,
     ...tsBaseRules,

package/lib/lint/eslint/typescript/react.js

@@ -4,7 +4,12 @@ const { tsBaseExtends, tsBaseRules, tsBaseConfig } = require('./common');
 
 exports.tsReactConfig = {
   ...tsBaseConfig,
-  extends: ['airbnb-typescript'].concat(tsBaseExtends),
+  extends: [
+    'airbnb',
+    'airbnb/hooks',
+    'plugin:redux-saga/recommended',
+    'airbnb-typescript',
+  ].concat(tsBaseExtends),
   rules: {
     ...baseRules,
     ...tsBaseRules,

package/lib/lint/lint-staged.config.js

@@ -1,5 +1,12 @@
+const path = require('path');
+
 module.exports = {
-  '*.{ts,tsx}': ['tsc-files --noEmit --emitDeclarationOnly false'],
+  '*.{ts,tsx}': [
+    `node ${path.resolve(
+      __dirname,
+      '../typescript/tsc-files/index.js',
+    )} --noEmit --emitDeclarationOnly false`,
+  ],
   '*.{js,ts,jsx,tsx}': [
     'npm run lint:fix',
     'npm run test:staged',

package/lib/pui-config/index.js

@@ -0,0 +1,18 @@
+const path = require('path');
+const fs = require('fs');
+const { merge } = require('lodash');
+
+const baseConfig = {
+  esBuild: {
+    target: 'es2020',
+  },
+};
+
+const getPUIConfig = () => {
+  const configPath = path.resolve(process.cwd(), './pui.config.js');
+  if (!fs.existsSync(configPath)) return baseConfig;
+  const config = JSON.parse(fs.readFileSync(configPath, 'utf8'));
+  return merge(baseConfig, config);
+};
+
+exports.getPUIConfig = getPUIConfig;

package/lib/server/index.js

@@ -13,8 +13,11 @@ const { loadRoutes } = require('./util');
 const { getAssetPath } = require('../webpack/helpers');
 
 const pino = expressPinoLogger({
-  prettyPrint: {
-    levelFirst: true,
+  transport: {
+    target: 'pino-pretty',
+    options: {
+      colorize: true,
+    },
   },
 });
 pino.logger.level = 'warn';
@@ -57,13 +60,6 @@ const customHost = argv.host || process.env.HOST;
 const host = customHost || null; // Let http.Server use its default IPv6/4 host
 const prettyHost = customHost || 'localhost';
 
-// use the gzipped bundle
-app.get('*.js', (req, res, next) => {
-  req.url += '.gz';
-  res.set('Content-Encoding', 'gzip');
-  next();
-});
-
 // Start your app.
 app.listen(port, host, async (err) => {
   if (err) {

package/lib/server/middlewares/addDevMiddlewares.js

@@ -1,5 +1,5 @@
 const webpack = require('webpack');
-const express = require('express');
+const expressStaticGzip = require('express-static-gzip');
 const webpackDevMiddleware = require('webpack-dev-middleware');
 const webpackHotMiddleware = require('webpack-hot-middleware');
 const { sendFileWithCSPNonce } = require('../csp');
@@ -25,7 +25,7 @@ module.exports = function addDevMiddlewares(app, webpackConfig) {
       heartbeat: 10 * 1000,
     }),
   );
-  app.use(express.static('cdn'));
+  app.use(expressStaticGzip('cdn'));
 
   const { outputFileSystem } = (middleware || {}).context || {};
 

package/lib/server/middlewares/addProdMiddlewares.js

@@ -1,6 +1,6 @@
 const path = require('path');
-const express = require('express');
 const compression = require('compression');
+const expressStaticGzip = require('express-static-gzip');
 const { sendFileWithCSPNonce } = require('../csp');
 
 module.exports = function addProdMiddlewares(app, options) {
@@ -17,8 +17,15 @@ module.exports = function addProdMiddlewares(app, options) {
     sendFileWithCSPNonce({ outputPath, res });
   });
 
-  app.use(publicPath, express.static(outputPath, { index: false }));
-  app.use(express.static('cdn'));
+  app.use(
+    publicPath,
+    expressStaticGzip(outputPath, {
+      index: false,
+      enableBrotli: true,
+      orderPreference: ['br'],
+    }),
+  );
+  app.use(expressStaticGzip('cdn'));
 
   app.get('*', (req, res) => sendFileWithCSPNonce({ outputPath, res }));
 };

package/lib/testing/jest.config.js

@@ -1,5 +1,6 @@
 const path = require('path');
 const { getAppConfig, getAssetPath } = require('../webpack/helpers');
+const swcrcConfig = require('../transpile/swcrc.config.js');
 
 const name = '@elliemae/pui-cli';
 const rootDir = path.join('<rootDir>', 'node_modules', name);
@@ -42,8 +43,8 @@ const jestConfig = {
     '!app/*/RbGenerated*/*.{js, ts, jsx, tsx}',
     '!app/index.{js, ts, jsx, tsx}',
     '!app/global-styles.{js, ts, jsx, tsx}',
-    '!app/*/*/loadable.{js, ts, jsx, tsx}',
-    '!lib/*/*/loadable.{js, ts, jsx, tsx}',
+    '!app/**/loadable.{js, ts, jsx, tsx}',
+    '!lib/**/loadable.{js, ts, jsx, tsx}',
   ],
   coverageThreshold: {
     // Todo: enable the coverage threshold later
@@ -66,17 +67,35 @@ const jestConfig = {
     '@elliemae/pui-user-monitoring': `${getRootDir()}/lib/testing/mocks/pui-user-monitoring.js`,
     '@elliemae/pui-app-loader': `${getRootDir()}/lib/testing/mocks/pui-app-loader.js`,
     '@elliemae/pui-diagnostics': `${getRootDir()}/lib/testing/mocks/pui-diagnostics.js`,
+    'react-spring/web': '<rootDir>/node_modules/react-spring/web.cjs.js',
+    'react-spring/renderprops':
+      '<rootDir>/node_modules/react-spring/renderprops.cjs.js',
     'styled-components':
       '<rootDir>/node_modules/styled-components/dist/styled-components.cjs.js',
   },
+  moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'json', 'node'],
   setupFilesAfterEnv: [`${getRootDir()}/lib/testing/setup-tests.js`],
   setupFiles: ['raf/polyfill', 'whatwg-fetch'],
-  testRegex: '(app|lib).*/tests/.*\\.test\\.(js|ts)$',
+  testRegex: '(app|lib).*/tests/.*\\.test\\.[jt]sx?$',
   snapshotSerializers: [],
   testResultsProcessor: 'jest-sonar-reporter',
+  resolver: path.resolve(__dirname, './resolver.js'),
+  transform: {
+    '^.+\\.[jt]sx?$': ['@swc/jest', swcrcConfig],
+  },
+  // transform: {
+  //   '^.+\\.[jt]sx?$': [
+  //     'esbuild-jest',
+  //     {
+  //       target: 'es2020',
+  //       loaders: {
+  //         '.js': 'jsx',
+  //       },
+  //     },
+  //   ],
+  // },
   transformIgnorePatterns: [
-    'node_modules/(?!(@elliemae/*|lodash-es/*)/)',
-    'node_modules/@elliemae/em-platform-document-viewer',
+    'node_modules/(?!(.*@elliemae/pui-cli|lodash-es|react-select|react-dates)/)',
   ],
   globals: {
     APP_CONFIG: getAppConfig(),
@@ -86,8 +105,8 @@ const jestConfig = {
   testEnvironment: 'jsdom',
 };
 
-if (isReactModule)
+if (isReactModule && jestConfig.setupFilesAfterEnv)
   jestConfig.setupFilesAfterEnv.push(
-    `${getRootDir()}/lib/testing/setup-styled-components-tests.js`,
+    `${getRootDir()}/lib/testing/setup-react-env.js`,
   );
 module.exports = jestConfig;

package/lib/testing/mocks/matchMedia.js

@@ -1,13 +1,19 @@
 /**
  *
  */
-export default function () {
+export default () => {
   Object.defineProperty(window, 'matchMedia', {
-    value: () => ({
+    writable: true,
+    value: jest.fn().mockImplementation((query) => ({
       matches: false,
-      addListener: () => {},
-      removeListener: () => {},
-    }),
+      media: query,
+      onchange: null,
+      addListener: jest.fn(), // Deprecated
+      removeListener: jest.fn(), // Deprecated
+      addEventListener: jest.fn(),
+      removeEventListener: jest.fn(),
+      dispatchEvent: jest.fn(),
+    })),
   });
 
   Object.defineProperty(window, 'getComputedStyle', {
@@ -15,4 +21,4 @@ export default function () {
       getPropertyValue: () => {},
     }),
   });
-}
+};

package/lib/testing/mocks/pui-app-loader.js

@@ -1,3 +1 @@
-module.exports = {
-  load: () => {},
-};
+export const load = () => {};

package/lib/testing/mocks/pui-diagnostics.js

@@ -1,36 +1,28 @@
-module.exports = {
-  logger() {
-    return {
-      setLogLevel() {},
-      setOptions() {},
-      info() {},
-      warn() {},
-      error() {},
-      trace() {},
-      debug() {},
-      audit() {},
-      fatal() {},
-    };
-  },
-  LogLevel: {
-    info: 'info',
-    debug: 'debug',
-    trace: 'trace',
-    warn: 'warn',
-    error: 'error',
-    audit: 'audit',
-    fatal: 'fatal',
-  },
-  Console() {
-    return {
-      log() {},
-    };
-  },
-  http() {
-    return {
-      log() {},
-    };
-  },
-  webvitals() {},
-  logUnhandledErrors() {},
+export const logger = () => ({
+  setLogLevel() {},
+  setOptions() {},
+  info() {},
+  warn() {},
+  error() {},
+  trace() {},
+  debug() {},
+  audit() {},
+  fatal() {},
+});
+export const LogLevel = {
+  info: 'info',
+  debug: 'debug',
+  trace: 'trace',
+  warn: 'warn',
+  error: 'error',
+  audit: 'audit',
+  fatal: 'fatal',
 };
+export const Console = () => ({
+  log: () => {},
+});
+export const http = () => ({
+  log() {},
+});
+export const webvitals = () => {};
+export const logUnhandledErrors = () => {};

package/lib/testing/mocks/pui-user-monitoring.js

@@ -1,5 +1,3 @@
-module.exports = {
-  setCustomUserData: () => {},
-  setCustomVirtualPageName: () => {},
-  startVirtualPageMonitoringWithAutoEnd: () => {},
-};
+export const setCustomUserData = () => {};
+export const setCustomVirtualPageName = () => {};
+export const startVirtualPageMonitoringWithAutoEnd = () => {};

package/lib/testing/mocks/retry-axios.js

@@ -1,5 +1,3 @@
-module.exports = {
-  attach: jest.fn(),
-  detach: jest.fn(),
-  getConfig: jest.fn(),
-};
+export const attach = jest.fn();
+export const detach = jest.fn();
+export const getConfig = jest.fn();

package/lib/testing/mocks/svg.js

@@ -1,3 +1,5 @@
-module.exports = {
-  ReactComponent: 'IMAGE_MOCK',
-};
+// eslint-disable-next-line no-unused-vars
+import * as React from 'react';
+
+export default 'SvgrURL';
+export const ReactComponent = 'div';