@toptal/davinci-engine 10.5.5 → 10.5.6

package/src/commands/__snapshots__/sentry-upload-sourcemaps.test.js.snap

@@ -1,15 +1,60 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`sentryUploadSourceMapsCommandCreator has the correct command structure 1`] = `
-{
-  "action": [Function],
-  "command": "sentry-upload-source-maps",
-  "description": "Upload source maps to Sentry",
+exports[`createSentryUploadSourceMapsCommand creates a command with the correct parameters 1`] = `
+"{
+  "_events": {},
+  "_eventsCount": 1,
+  "commands": [],
   "options": [
     {
-      "label": "This sets URL prefix in front of all files. This defaults to the path where your production build is set e.g. '~/static/js' inside \`dist\` directory. This is also useful if your files are stored in a sub folder when deployed. eg: --url-prefix '~/blackfish/ui'.",
-      "name": "--url-prefix <prefix>",
-    },
+      "flags": "--url-prefix <prefix>",
+      "description": "This sets URL prefix in front of all files. This defaults to the path where your production build is set e.g. '~/static/js' inside \`dist\` directory. This is also useful if your files are stored in a sub folder when deployed. eg: --url-prefix '~/blackfish/ui'.",
+      "required": true,
+      "optional": false,
+      "variadic": false,
+      "mandatory": false,
+      "long": "--url-prefix",
+      "negate": false,
+      "hidden": false,
+      "conflictsWith": []
+    }
   ],
-}
+  "parent": null,
+  "_allowUnknownOption": false,
+  "_allowExcessArguments": true,
+  "_args": [],
+  "args": [],
+  "rawArgs": [],
+  "processedArgs": [],
+  "_scriptPath": null,
+  "_name": "sentry-upload-source-maps",
+  "_optionValues": {},
+  "_optionValueSources": {},
+  "_storeOptionsAsProperties": false,
+  "_executableHandler": false,
+  "_executableFile": null,
+  "_executableDir": null,
+  "_defaultCommandName": null,
+  "_exitCallback": null,
+  "_aliases": [],
+  "_combineFlagAndOptionalValue": true,
+  "_description": "Upload source maps to Sentry",
+  "_summary": "",
+  "_enablePositionalOptions": false,
+  "_passThroughOptions": false,
+  "_lifeCycleHooks": {},
+  "_showHelpAfterError": false,
+  "_showSuggestionAfterError": true,
+  "_outputConfiguration": {},
+  "_hidden": false,
+  "_hasHelpOption": true,
+  "_helpFlags": "-h, --help",
+  "_helpDescription": "display help for command",
+  "_helpShortFlag": "-h",
+  "_helpLongFlag": "--help",
+  "_helpCommandName": "help",
+  "_helpCommandnameAndArgs": "help [command]",
+  "_helpCommandDescription": "display help for command",
+  "_helpConfiguration": {}
+}"
 `;

package/src/commands/__snapshots__/size.test.js.snap

@@ -1,19 +1,72 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`sizeCommandCreator has the correct command structure 1`] = `
-{
-  "action": [Function],
-  "command": "size",
-  "description": "Checks the bundle size against provided limit — fails if limit is exceeded.",
+exports[`createSizeCommand creates a command with the correct parameters 1`] = `
+"{
+  "_events": {},
+  "_eventsCount": 2,
+  "commands": [],
   "options": [
     {
-      "label": "limit to check the size against: 2.5Mb, 1337Kb, etc",
-      "name": "--limit <limit>",
+      "flags": "--limit <limit>",
+      "description": "limit to check the size against: 2.5Mb, 1337Kb, etc",
+      "required": true,
+      "optional": false,
+      "variadic": false,
+      "mandatory": false,
+      "long": "--limit",
+      "negate": false,
+      "hidden": false,
+      "conflictsWith": []
     },
     {
-      "label": "max allowed chunk size: 100Kb, 1Mb, etc",
-      "name": "--maxChunkSize <maxChunkSize>",
-    },
+      "flags": "--maxChunkSize <maxChunkSize>",
+      "description": "max allowed chunk size: 100Kb, 1Mb, etc",
+      "required": true,
+      "optional": false,
+      "variadic": false,
+      "mandatory": false,
+      "long": "--maxChunkSize",
+      "negate": false,
+      "hidden": false,
+      "conflictsWith": []
+    }
   ],
-}
+  "parent": null,
+  "_allowUnknownOption": false,
+  "_allowExcessArguments": true,
+  "_args": [],
+  "args": [],
+  "rawArgs": [],
+  "processedArgs": [],
+  "_scriptPath": null,
+  "_name": "size",
+  "_optionValues": {},
+  "_optionValueSources": {},
+  "_storeOptionsAsProperties": false,
+  "_executableHandler": false,
+  "_executableFile": null,
+  "_executableDir": null,
+  "_defaultCommandName": null,
+  "_exitCallback": null,
+  "_aliases": [],
+  "_combineFlagAndOptionalValue": true,
+  "_description": "Checks the bundle size against provided limit — fails if limit is exceeded.",
+  "_summary": "",
+  "_enablePositionalOptions": false,
+  "_passThroughOptions": false,
+  "_lifeCycleHooks": {},
+  "_showHelpAfterError": false,
+  "_showSuggestionAfterError": true,
+  "_outputConfiguration": {},
+  "_hidden": false,
+  "_hasHelpOption": true,
+  "_helpFlags": "-h, --help",
+  "_helpDescription": "display help for command",
+  "_helpShortFlag": "-h",
+  "_helpLongFlag": "--help",
+  "_helpCommandName": "help",
+  "_helpCommandnameAndArgs": "help [command]",
+  "_helpCommandDescription": "display help for command",
+  "_helpConfiguration": {}
+}"
 `;

package/src/commands/analyze.js

@@ -3,19 +3,15 @@ import { print } from '@toptal/davinci-cli-shared'
 import { BundleAnalyzerPlugin } from 'webpack-bundle-analyzer'
 
 import { getWebpackConfig } from '../utils/index.js'
-
 const printError = err => {
   print.red(err.stack || err)
-
   if (err.details) {
     print.red(err.details)
   }
 }
-
 const analyze = async () => {
   process.env.BABEL_ENV = 'production'
   process.env.NODE_ENV = 'production'
-
   const config = await getWebpackConfig({
     webpackEnv: 'production',
   })
@@ -31,9 +27,11 @@ const analyze = async () => {
 
         return reject(err)
       }
-
-      console.log(stats.toString({ colors: true }))
-
+      console.log(
+        stats.toString({
+          colors: true,
+        })
+      )
       compiler.close(closeErr => {
         if (closeErr) {
           printError(closeErr)
@@ -44,10 +42,8 @@ const analyze = async () => {
     })
   })
 }
-
 const analyzeCommand = async () => {
   print.header('Creating a production build with bundle analysis')
-
   try {
     await analyze()
   } catch (e) {
@@ -55,10 +51,9 @@ const analyzeCommand = async () => {
   }
 }
 
-const analyzeCommandCreator = {
-  command: 'analyze',
-  description: 'analyze webpack bundle and show the installed dependencies',
-  action: analyzeCommand,
+export const createAnalyzeCommand = program => {
+  return program
+    .createCommand('analyze')
+    .description('analyze webpack bundle and show the installed dependencies')
+    .action(analyzeCommand)
 }
-
-export default analyzeCommandCreator

package/src/commands/analyze.test.js

@@ -1,7 +1,24 @@
-import analyzeCommandCreator from './analyze.js'
+// eslint-disable-next-line import/no-extraneous-dependencies
+import { jest } from '@jest/globals'
+// eslint-disable-next-line import/no-extraneous-dependencies
+import { Command } from 'commander'
 
-describe('analyzeCommandCreator', () => {
-  it('has the correct command structure', () => {
-    expect(analyzeCommandCreator).toMatchSnapshot()
+const { createAnalyzeCommand } = await import('./analyze.js')
+
+describe('createAnalyzeCommand', () => {
+  let program
+
+  beforeEach(() => {
+    program = new Command()
+  })
+
+  afterEach(() => {
+    jest.clearAllMocks()
+  })
+
+  it('creates a command with the correct parameters', () => {
+    const command = createAnalyzeCommand(program)
+
+    expect(JSON.stringify(command, null, 2)).toMatchSnapshot()
   })
 })

package/src/commands/build.js

@@ -14,7 +14,6 @@ import {
   printStarting,
   printSuccess,
 } from '../utils/build/print.js'
-
 const ERROR_EXIT_CODE = 1
 const PROGRESS_BAR_TYPE = process.stdin.isTTY ? 'fancy' : 'basic'
 
@@ -23,14 +22,12 @@ export const buildCommand = async ({
   ...buildOptions
 }) => {
   printStarting()
-
   const { isProgressiveWebApp, serviceWorkerFileName } = getServiceWorkersInfo()
 
   try {
     const previousFileSizes = await measureInitialFileSizes()
 
     cleanDistFolder()
-
     const { stats, warnings } = await build({
       ...buildOptions,
       isProgressiveWebApp,
@@ -40,79 +37,66 @@ export const buildCommand = async ({
     printBuildResultMessage(warnings)
 
     // use safety workers if necessary
-    applySafetyWorkers({ emergencySafetyWorker })
+    applySafetyWorkers({
+      emergencySafetyWorker,
+    })
 
     // Merge with the public folder
     copyPublicFolder()
-
     printFileSizes(stats, previousFileSizes)
-
     printSuccess()
   } catch (e) {
     printError(e)
-
     process.exit(ERROR_EXIT_CODE)
   }
 }
+export const createBuildCommand = program => {
+  return program
+    .createCommand('build')
+    .description('Build project for release')
+    .action(options => {
+      const {
+        dotenv,
+        disableSourceMaps,
+        emergencySafetyWorker,
+        disableCloudflareHandler,
+        skipTypeChecking,
+        progressBar,
+        compiler,
+      } = options
 
-const buildCommandCreator = {
-  action: options => {
-    const {
-      dotenv,
-      disableSourceMaps,
-      emergencySafetyWorker,
-      disableCloudflareHandler,
-      skipTypeChecking,
-      progressBar,
-      compiler,
-    } = options
-
-    return buildCommand({
-      dotenv,
-      isSourceMapEnabled: !disableSourceMaps,
-      emergencySafetyWorker,
-      disableCloudflareHandler,
-      skipTypeChecking,
-      progressBar,
-      compiler,
+      return buildCommand({
+        dotenv,
+        isSourceMapEnabled: !disableSourceMaps,
+        emergencySafetyWorker,
+        disableCloudflareHandler,
+        skipTypeChecking,
+        progressBar,
+        compiler,
+      })
     })
-  },
-  command: 'build',
-  description: 'Build project for release',
-  options: [
-    {
-      label:
-        ".env file to use as source of env variables; values: 'none', 'auto' or path to dotenv file",
-      name: '--dotenv <dotenv>',
-      default: DOTENV_NONE,
-    },
-    {
-      label: 'disable source maps generation',
-      name: '--disable-source-maps',
-    },
-    {
-      label:
-        'replace progressive web app service worker with safety-worker.js content (https://toptal-core.atlassian.net/wiki/spaces/FE/pages/2059796590/Davinci+-+How+to+deal+with+progressive+web+app+PWA#Service-Worker-Safety)',
-      name: '--emergency-safety-worker',
-    },
-    {
-      label: 'disable Cloudflare fetch handler override',
-      name: '--disable-cloudflare-handler',
-    },
-    {
-      name: '--skip-type-checking',
-      label: 'skip type checking in webpack',
-    },
-    {
-      name: '--progress-bar [basic | fancy]',
-      label: 'progress bar type for webpack build process',
-      default: PROGRESS_BAR_TYPE,
-    },
-    {
-      name: '--compiler <compiler>',
-      label: 'Compiler to use: babel, swc (default: babel)',
-    },
-  ],
+    .option(
+      '--dotenv <dotenv>',
+      ".env file to use as source of env variables; values: 'none', 'auto' or path to dotenv file",
+      DOTENV_NONE
+    )
+    .option('--disable-source-maps', 'disable source maps generation')
+    .option(
+      '--emergency-safety-worker',
+      'replace progressive web app service worker with safety-worker.js content (https://toptal-core.atlassian.net/wiki/spaces/FE/pages/2059796590/Davinci+-+How+to+deal+with+progressive+web+app+PWA#Service-Worker-Safety)'
+    )
+    .option(
+      '--disable-cloudflare-handler',
+      'disable Cloudflare fetch handler override'
+    )
+    .option('--skip-type-checking', 'skip type checking in webpack')
+    .option(
+      '--progress-bar [basic | fancy]',
+      'progress bar type for webpack build process',
+      PROGRESS_BAR_TYPE
+    )
+    .option(
+      '--compiler <compiler>',
+      'Compiler to use: babel, swc (default: babel)'
+    )
 }
-
-export default buildCommandCreator

package/src/commands/build.test.js

@@ -1,4 +1,6 @@
 import { jest } from '@jest/globals'
+// eslint-disable-next-line import/no-extraneous-dependencies
+import { Command } from 'commander'
 
 jest.unstable_mockModule('../utils/build/build.js', () => ({
   build: jest.fn(),
@@ -31,9 +33,7 @@ const {
 const { printBuildResultMessage, printFileSizes, printSuccess } = await import(
   '../utils/build/print.js'
 )
-const buildCommandCreator = await import('./build.js')
-
-const { buildCommand } = buildCommandCreator
+const { createBuildCommand, buildCommand } = await import('./build.js')
 
 const buildOptions = {
   option1: 123,
@@ -43,7 +43,9 @@ const warnings = ['warning1', 'warning2']
 const previousFileSizes = [1, 2, 3]
 const originalProcessExit = process.exit
 
-describe('buildCommandCreator', () => {
+describe('createBuildCommand', () => {
+  let program
+
   beforeEach(() => {
     getServiceWorkersInfo.mockReturnValue({
       isProgressiveWebApp: true,
@@ -58,6 +60,8 @@ describe('buildCommandCreator', () => {
     })
 
     process.exit = jest.fn()
+
+    program = new Command()
   })
 
   afterEach(() => {
@@ -75,7 +79,9 @@ describe('buildCommandCreator', () => {
   }
 
   it('has the correct command structure', () => {
-    expect(buildCommandCreator.default).toMatchSnapshot()
+    const command = createBuildCommand(program)
+
+    expect(JSON.stringify(command, null, 2)).toMatchSnapshot()
   })
 
   describe('when build is successful', () => {

package/src/commands/compile-package.js

@@ -8,7 +8,6 @@ import { getEnvVariables } from '../utils/index.js'
 import { copyPackageJson } from '../utils/copy-package-json.js'
 import { copyFileIfExists } from '../utils/copy-file.js'
 import { DOTENV_NONE, DIST_PACKAGE_PATH } from '../constants.cjs'
-
 const SOURCE_FOLDER_NAME = 'src'
 const PACKAGE_ENTRY_FILE = `./${SOURCE_FOLDER_NAME}/index.package.js`
 const DEFAULT_TSCONFIG_PATH = './tsconfig.json'
@@ -20,16 +19,13 @@ const TEST_FILES_PATTERNS = [
   '*.storyshot',
   '*.snap',
 ]
-
 const getTsConfigValue = (tsConfigPath, prop) => {
   const projectTsConfigContent = fs.readJsonSync(tsConfigPath)
-
   const extendsTsConfigPath = projectTsConfigContent.extends
 
   if (!extendsTsConfigPath) {
     return dotProp.get(projectTsConfigContent, prop)
   }
-
   const extendsTsConfigContent = fs.readJsonSync(
     path.resolve(extendsTsConfigPath)
   )
@@ -39,20 +35,18 @@ const getTsConfigValue = (tsConfigPath, prop) => {
     dotProp.get(extendsTsConfigContent, prop)
   )
 }
-
 const cleanFolder = outputDir => {
   print.green('Cleaning up the folder... \n')
-
   const absoluteOutputDirPath = path.resolve(outputDir)
 
-  fs.rmSync(absoluteOutputDirPath, { force: true, recursive: true })
+  fs.rmSync(absoluteOutputDirPath, {
+    force: true,
+    recursive: true,
+  })
 }
-
 const emitTypeDeclarations = ({ tsConfigPath, outputDir }) => {
   print.green('Preparing type definitions... \n')
-
   const declarationDirPath = path.resolve(outputDir, SOURCE_FOLDER_NAME)
-
   const tscArgs = [
     'tsc',
     '--emitDeclarationOnly',
@@ -65,24 +59,22 @@ const emitTypeDeclarations = ({ tsConfigPath, outputDir }) => {
   ]
 
   runSync('yarn', tscArgs)
-  replaceTscAliasPaths({ configFile: tsConfigPath })
+  replaceTscAliasPaths({
+    configFile: tsConfigPath,
+  })
 }
-
 const getPathsToIgnoreDuringTranspilation = () =>
   [...TEST_FILES_PATTERNS]
     .map(pattern => `${SOURCE_FOLDER_NAME}/**/${pattern}`)
     .join()
-
 const transpileSourceCode = ({ outputDir, envVariables, babelConfigPath }) => {
   const defaultBabelConfigPath = files.getPackageFilePath(
     '@toptal/davinci-engine',
     'src/configs/babel/babel-package-config.json'
   )
-
   const babelConfigAbsolutePath = babelConfigPath
     ? path.resolve(babelConfigPath)
     : defaultBabelConfigPath
-
   const pathsToIgnore = getPathsToIgnoreDuringTranspilation()
 
   runSync(
@@ -109,17 +101,14 @@ const transpileSourceCode = ({ outputDir, envVariables, babelConfigPath }) => {
     }
   )
 }
-
 const copySupportiveFiles = ({ outputDir, entry = PACKAGE_ENTRY_FILE }) => {
   const entryBaseName = path.basename(entry, path.extname(entry))
   const dirEntry = path.dirname(entry)
-
   const compiledEntry = path.format({
     dir: dirEntry,
     ext: '.js',
     name: entryBaseName,
   })
-
   const typesPath = path.format({
     dir: dirEntry,
     ext: '.d.ts',
@@ -155,7 +144,6 @@ const copySupportiveFiles = ({ outputDir, entry = PACKAGE_ENTRY_FILE }) => {
     to: path.join(outputDir, './.gitignore'),
   })
 }
-
 const compilePackageCommand = async ({
   dotenv,
   babelConfigPath,
@@ -163,7 +151,6 @@ const compilePackageCommand = async ({
   entry,
 }) => {
   print.header('Compiling a package')
-
   const packageJson = fs.readJsonSync(path.resolve('./package.json'))
 
   if (!('sideEffects' in packageJson)) {
@@ -171,7 +158,6 @@ const compilePackageCommand = async ({
       'sideEffects property is not added to the package.json file. The tree-shaking functionality would not be working for your package. [https://webpack.js.org/guides/tree-shaking/#clarifying-tree-shaking-and-sideeffects]'
     )
   }
-
   const projectTsConfigPath = path.resolve(
     tsConfigPath || DEFAULT_TSCONFIG_PATH
   )
@@ -186,58 +172,61 @@ const compilePackageCommand = async ({
 
   print.grey('Output dir: ', outputDir)
   print.grey('')
-
-  const envVariables = getEnvVariables({ dotenv })
+  const envVariables = getEnvVariables({
+    dotenv,
+  })
 
   cleanFolder(outputDir)
-  emitTypeDeclarations({ outputDir, tsConfigPath: projectTsConfigPath })
-  transpileSourceCode({ babelConfigPath, envVariables, outputDir })
-  copySupportiveFiles({ entry, outputDir })
-
+  emitTypeDeclarations({
+    outputDir,
+    tsConfigPath: projectTsConfigPath,
+  })
+  transpileSourceCode({
+    babelConfigPath,
+    envVariables,
+    outputDir,
+  })
+  copySupportiveFiles({
+    entry,
+    outputDir,
+  })
   print.success('Done!')
 }
 
-const compilePackageCommandCreator = {
-  action: options => {
-    const {
-      dotenv,
-      babelConfig: babelConfigPath,
-      tsConfig: tsConfigPath,
-      entry,
-    } = options
-
-    return compilePackageCommand({
-      babelConfigPath,
-      dotenv,
-      entry,
-      tsConfigPath,
+export const createCompilePackageCommand = program => {
+  return program
+    .createCommand('compile-package')
+    .description('Compile package to publish to npm')
+    .action(options => {
+      const {
+        dotenv,
+        babelConfig: babelConfigPath,
+        tsConfig: tsConfigPath,
+        entry,
+      } = options
+
+      return compilePackageCommand({
+        babelConfigPath,
+        dotenv,
+        entry,
+        tsConfigPath,
+      })
     })
-  },
-  command: 'compile-package',
-  description: 'Compile package to publish to npm',
-  options: [
-    {
-      label:
-        ".env file to use as source of env variables; values: 'none', 'auto' or path to dotenv file",
-      name: '--dotenv <dotenv>',
-      default: DOTENV_NONE,
-    },
-    {
-      label:
-        'path to a custom Babel config file; values: path to a Babel config file',
-      name: '--babelConfig <babelConfig>',
-    },
-    {
-      label:
-        'path to a custom tsconfig file; values: path to a custom tsconfig file',
-      name: '--tsConfig <tsConfig>',
-    },
-    {
-      label:
-        'path to a custom entry index file; values: path to a custom entry index file',
-      name: '--entry <entry>',
-    },
-  ],
+    .option(
+      '--dotenv <dotenv>',
+      ".env file to use as source of env variables; values: 'none', 'auto' or path to dotenv file",
+      DOTENV_NONE
+    )
+    .option(
+      '--babelConfig <babelConfig>',
+      'path to a custom Babel config file; values: path to a Babel config file'
+    )
+    .option(
+      '--tsConfig <tsConfig>',
+      'path to a custom tsconfig file; values: path to a custom tsconfig file'
+    )
+    .option(
+      '--entry <entry>',
+      'path to a custom entry index file; values: path to a custom entry index file'
+    )
 }
-
-export default compilePackageCommandCreator