@toptal/davinci-engine 10.5.5 → 10.5.6

package/src/commands/compile-package.test.js

@@ -1,7 +1,24 @@
-import compilePackageCommandCreator from './compile-package.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('compilePackageCommandCreator', () => {
-  it('has the correct command structure', () => {
-    expect(compilePackageCommandCreator).toMatchSnapshot()
+const { createCompilePackageCommand } = await import('./compile-package.js')
+
+describe('createCompilePackageCommand', () => {
+  let program
+
+  beforeEach(() => {
+    program = new Command()
+  })
+
+  afterEach(() => {
+    jest.clearAllMocks()
+  })
+
+  it('creates a command with the correct parameters', () => {
+    const command = createCompilePackageCommand(program)
+
+    expect(JSON.stringify(command, null, 2)).toMatchSnapshot()
   })
 })

package/src/commands/publish-package.js

@@ -10,7 +10,7 @@ import { paths } from '../configs/paths.js'
 import releaseConfig from '../configs/semantic-release/release.config.js'
 import { publishMonorepoPackages } from '../utils/publish-packages/publish-monorepo-packages.js'
 
-const publishPackageCommand = async ({
+export const publishPackageCommand = async ({
   isAlpha,
   outputVersionFile,
   forceReleaseAsNonMonorepo,
@@ -18,9 +18,7 @@ const publishPackageCommand = async ({
   publishRootFolder,
 }) => {
   print.header('Publishing a package')
-
   const { lernaIsAvailable, workspacesExist } = utils.checkIfMonorepo()
-
   const monorepoIsMisconfigured = !lernaIsAvailable && workspacesExist
 
   if (!forceReleaseAsNonMonorepo && monorepoIsMisconfigured) {
@@ -29,7 +27,6 @@ const publishPackageCommand = async ({
     )
     process.exit(1)
   }
-
   const releasePackageAsMonorepo =
     !forceReleaseAsNonMonorepo && lernaIsAvailable && workspacesExist
 
@@ -49,7 +46,6 @@ const publishPackageCommand = async ({
         publishRootFolder,
       })
     }
-
     print.success('Done!')
   } catch (e) {
     print.red(
@@ -59,7 +55,6 @@ const publishPackageCommand = async ({
     process.exit(1)
   }
 }
-
 const publishPackage = async ({
   isAlpha,
   branch,
@@ -67,28 +62,26 @@ const publishPackage = async ({
   publishRootFolder = paths.appPackageBuild,
 }) => {
   validatePackageDistFolderExists()
-
   if (isAlpha) {
-    await publishAlphaPackage({ branch, packageFolder: paths.appPackageBuild })
+    await publishAlphaPackage({
+      branch,
+      packageFolder: paths.appPackageBuild,
+    })
   } else {
     await publish({
       appFolder: paths.appBuild,
       packageFolder: publishRootFolder,
     })
   }
-
   if (outputVersionFile) {
     writeNewPackageVersionToFile(outputVersionFile)
   }
 }
-
 const publishAlphaPackage = async ({ branch, packageFolder }) => {
   print.yellow('Publishing alpha version of the package \n')
-
   const packageJson = JSON.parse(
     fs.readFileSync(path.join(packageFolder, './package.json'), 'utf8')
   )
-
   const preid = `alpha-${branch}`
   const newPreidVersion = await getNewPreidVersion({
     packageName: packageJson.name,
@@ -103,10 +96,8 @@ const publishAlphaPackage = async ({ branch, packageFolder }) => {
       cwd: packageFolder,
     }
   )
-
   cliShared.runSync('npm', ['publish', packageFolder, '--tag', preid])
 }
-
 const getLatestVersion = versions => {
   let latestVersion = versions[0]
 
@@ -117,26 +108,21 @@ const getLatestVersion = versions => {
     if (!semver.gt(version, latestVersion)) {
       return
     }
-
     latestVersion = version
   })
 
   return latestVersion
 }
-
 const getNewPreidVersion = async ({ packageName, preid }) => {
   try {
     const data = await packageJsonLib(packageName, {
       allVersions: true,
     })
-
     const versions = data.versions
     const versionsForPreid = Object.keys(versions).filter(
       version => version.indexOf(preid) >= 0
     )
-
     const latestVersion = getLatestVersion(versionsForPreid)
-
     const newVersion = semver.inc(
       latestVersion || data['dist-tags'].latest,
       'prerelease',
@@ -150,22 +136,22 @@ const getNewPreidVersion = async ({ packageName, preid }) => {
     process.exit(1)
   }
 }
-
 const publish = async ({ appFolder, packageFolder }) => {
   print.yellow('Publishing PRODUCTION version of the package\n')
-
-  await semanticRelease(releaseConfig({ appFolder, packageFolder }))
+  await semanticRelease(
+    releaseConfig({
+      appFolder,
+      packageFolder,
+    })
+  )
 }
-
 const writeNewPackageVersionToFile = outputVersionFile => {
   const packageJsonPath = path.join(paths.appPackageBuild, './package.json')
   const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'))
-
   const newVersion = packageJson.version
 
   fs.writeFileSync(outputVersionFile, newVersion)
 }
-
 const validatePackageDistFolderExists = () => {
   const packageBuildFolder = paths.appPackageBuild
   const doesPackageBuildFolderExist = fs.existsSync(packageBuildFolder)
@@ -178,44 +164,39 @@ const validatePackageDistFolderExists = () => {
   }
 }
 
-const publishPackageCommandCreator = {
-  action: options => {
-    const { alpha, nonMonorepo, outputVersion, branch, publishRootFolder } =
-      options
+export const action = options => {
+  const { alpha, nonMonorepo, outputVersion, branch, publishRootFolder } =
+    options
 
-    return publishPackageCommand({
-      branch,
-      isAlpha: alpha,
-      forceReleaseAsNonMonorepo: nonMonorepo,
-      outputVersionFile: outputVersion,
-      publishRootFolder,
-    })
-  },
-  command: 'publish-package',
-  description: 'Publish package to npm',
-  options: [
-    {
-      label: 'publish alpha version of the package',
-      name: '--alpha',
-    },
-    {
-      label: 'the file to output the new published version',
-      name: '--outputVersion <outputVersion>',
-    },
-    {
-      label:
-        'the branch name to be added to the release version metadata, only for alpha version',
-      name: '--branch <branch>',
-    },
-    {
-      label: 'explicitly process as non-monorepo (a single package)',
-      name: '--nonMonorepo',
-    },
-    {
-      label: 'custom publish root folder, (by default is /dist-package)',
-      name: '--publishRootFolder <publishRootFolder>',
-    },
-  ],
+  return publishPackageCommand({
+    branch,
+    isAlpha: alpha,
+    forceReleaseAsNonMonorepo: nonMonorepo,
+    outputVersionFile: outputVersion,
+    publishRootFolder,
+  })
 }
 
-export default publishPackageCommandCreator
+export const createPublishPackageCommand = program => {
+  return program
+    .createCommand('publish-package')
+    .description('Publish package to npm')
+    .action(action)
+    .option('--alpha', 'publish alpha version of the package')
+    .option(
+      '--outputVersion <outputVersion>',
+      'the file to output the new published version'
+    )
+    .option(
+      '--branch <branch>',
+      'the branch name to be added to the release version metadata, only for alpha version'
+    )
+    .option(
+      '--nonMonorepo',
+      'explicitly process as non-monorepo (a single package)'
+    )
+    .option(
+      '--publishRootFolder <publishRootFolder>',
+      'custom publish root folder, (by default is /dist-package)'
+    )
+}

package/src/commands/publish-package.test.js

@@ -1,6 +1,8 @@
 import { utils } from '@toptal/davinci-monorepo'
 import { jest } from '@jest/globals'
 import { print } from '@toptal/davinci-cli-shared'
+// eslint-disable-next-line import/no-extraneous-dependencies
+import { Command } from 'commander'
 
 jest.unstable_mockModule(
   '../utils/publish-packages/publish-monorepo-packages.js',
@@ -17,18 +19,27 @@ const mockExit = jest.spyOn(process, 'exit').mockImplementation(() => jest.fn())
 const { publishMonorepoPackages } = await import(
   '../utils/publish-packages/publish-monorepo-packages.js'
 )
-const publishPackage = (await import('./publish-package.js')).default
-const { action } = publishPackage
+const { createPublishPackageCommand, action } = await import(
+  './publish-package.js'
+)
 
 const checkIfMonorepo = jest.spyOn(utils, 'checkIfMonorepo')
 
-describe('publishPackageCommand', () => {
+describe('createPublishPackageCommand', () => {
+  let program
+
+  beforeEach(() => {
+    program = new Command()
+  })
+
   afterEach(() => {
     jest.resetAllMocks()
   })
 
   it('has the correct command structure', () => {
-    expect(publishPackage).toMatchSnapshot()
+    const command = createPublishPackageCommand(program)
+
+    expect(JSON.stringify(command, null, 2)).toMatchSnapshot()
   })
 
   describe('when `alpha` option is passed', () => {

package/src/commands/release-package.js

@@ -1,30 +1,25 @@
 import cliShared, { print } from '@toptal/davinci-cli-shared'
-
 const getCompilePackageCommand = ({ entry, babelConfig, tsConfig }) => {
   const command = ['davinci-engine', 'compile-package', '--dotenv', 'auto']
 
   if (entry) {
     command.push('--entry', entry)
   }
-
   if (babelConfig) {
     command.push('--babelConfig', babelConfig)
   }
-
   if (tsConfig) {
     command.push('--tsConfig', tsConfig)
   }
 
   return command
 }
-
 const getPublishPackageCommand = ({ outputVersionFile, nonMonorepo }) => {
   const command = ['davinci-engine', 'publish-package']
 
   if (outputVersionFile) {
     command.push('--outputVersion', outputVersionFile)
   }
-
   if (nonMonorepo) {
     command.push('--nonMonorepo')
   }
@@ -32,7 +27,7 @@ const getPublishPackageCommand = ({ outputVersionFile, nonMonorepo }) => {
   return command
 }
 
-const releasePackageCommand = async ({
+export const releasePackageCommand = async ({
   entry,
   babelConfig,
   tsConfig,
@@ -41,16 +36,21 @@ const releasePackageCommand = async ({
 }) => {
   try {
     print.header('Building package')
-
     cliShared.runSync(
       'yarn',
-      getCompilePackageCommand({ babelConfig, entry, tsConfig })
+      getCompilePackageCommand({
+        babelConfig,
+        entry,
+        tsConfig,
+      })
     )
-
     print.green('Releasing package...\n')
     cliShared.runSync(
       'yarn',
-      getPublishPackageCommand({ outputVersionFile, nonMonorepo })
+      getPublishPackageCommand({
+        outputVersionFile,
+        nonMonorepo,
+      })
     )
   } catch (e) {
     print.red(`${e.stack || e}\n`)
@@ -58,35 +58,29 @@ const releasePackageCommand = async ({
   }
 }
 
-const releasePackageCommandCreator = {
-  action: releasePackageCommand,
-  command: 'release-package',
-  description: 'Build and release the package',
-  options: [
-    {
-      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>',
-    },
-    {
-      label: 'the file to output the new published version to',
-      name: '--outputVersion <outputVersion>',
-    },
-    {
-      label: 'explicitly process as non-monorepo (a single package)',
-      name: '--nonMonorepo',
-    },
-  ],
+export const createReleasePackageCommand = program => {
+  return program
+    .createCommand('release-package')
+    .description('Build and release the package')
+    .action(releasePackageCommand)
+    .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'
+    )
+    .option(
+      '--outputVersion <outputVersion>',
+      'the file to output the new published version to'
+    )
+    .option(
+      '--nonMonorepo',
+      'explicitly process as non-monorepo (a single package)'
+    )
 }
-
-export default releasePackageCommandCreator

package/src/commands/release-package.test.js

@@ -1,15 +1,31 @@
 import cliShared from '@toptal/davinci-cli-shared'
 import { jest } from '@jest/globals'
+// eslint-disable-next-line import/no-extraneous-dependencies
+import { Command } from 'commander'
 
-import releasePackage from './release-package.js'
+const { createReleasePackageCommand, releasePackageCommand } = await import(
+  './release-package.js'
+)
 
-const { action } = releasePackage
+const action = releasePackageCommand
 
 const runSync = jest.spyOn(cliShared, 'runSync').mockImplementation(() => {})
 
-describe('releasePackageCommand', () => {
+describe('createReleasePackageCommand', () => {
+  let program
+
+  beforeEach(() => {
+    program = new Command()
+  })
+
+  afterEach(() => {
+    jest.resetAllMocks()
+  })
+
   it('has the correct command structure', () => {
-    expect(releasePackage).toMatchSnapshot()
+    const command = createReleasePackageCommand(program)
+
+    expect(JSON.stringify(command, null, 2)).toMatchSnapshot()
   })
 
   it('compiles and releases a package with default options', () => {

package/src/commands/sentry-upload-sourcemaps.js

@@ -1,7 +1,6 @@
 import { print, runSync } from '@toptal/davinci-cli-shared'
 
 import { paths } from '../configs/paths.js'
-
 const getReleaseName = () => {
   const { stdout } = runSync(
     'yarn',
@@ -13,14 +12,11 @@ const getReleaseName = () => {
 
   return stdout
 }
-
 const uploadSourceMaps = ({ urlPrefix }) => {
   const releaseName = getReleaseName()
 
   print.yellow('Release name:', releaseName, '\n')
-
   runSync('yarn', ['sentry-cli', 'releases', 'new', releaseName])
-
   const args = [
     'sentry-cli',
     'releases',
@@ -33,12 +29,9 @@ const uploadSourceMaps = ({ urlPrefix }) => {
   if (urlPrefix) {
     args.push('--url-prefix', urlPrefix)
   }
-
   runSync('yarn', args)
-
   runSync('yarn', ['sentry-cli', 'releases', 'finalize', releaseName])
 }
-
 const failureExitIfNoEnvVariable = variableName => {
   if (!process.env[variableName]) {
     print.red(`${variableName} env variable is not defined.`)
@@ -48,34 +41,28 @@ const failureExitIfNoEnvVariable = variableName => {
     process.exit(1)
   }
 }
-
 const sentryUploadSourceMapsCommand = async ({ urlPrefix }) => {
   print.header('Uploading source maps to Sentry')
-
   failureExitIfNoEnvVariable('SENTRY_ORG')
   failureExitIfNoEnvVariable('SENTRY_PROJECT')
   failureExitIfNoEnvVariable('SENTRY_AUTH_TOKEN')
-
   try {
-    await uploadSourceMaps({ urlPrefix })
-
+    await uploadSourceMaps({
+      urlPrefix,
+    })
     print.success('Done!')
   } catch (e) {
     print.red(`${e.stack || e}\n`)
   }
 }
 
-const sentryUploadSourceMapsCommandCreator = {
-  action: sentryUploadSourceMapsCommand,
-  command: 'sentry-upload-source-maps',
-  description: 'Upload source maps to Sentry',
-  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>',
-    },
-  ],
+export const createSentryUploadSourceMapsCommand = program => {
+  return program
+    .createCommand('sentry-upload-source-maps')
+    .description('Upload source maps to Sentry')
+    .action(sentryUploadSourceMapsCommand)
+    .option(
+      '--url-prefix <prefix>',
+      "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'."
+    )
 }
-
-export default sentryUploadSourceMapsCommandCreator

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

@@ -1,7 +1,26 @@
-import sentryUploadSourceMapsCommandCreator from './sentry-upload-sourcemaps.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('sentryUploadSourceMapsCommandCreator', () => {
-  it('has the correct command structure', () => {
-    expect(sentryUploadSourceMapsCommandCreator).toMatchSnapshot()
+const { createSentryUploadSourceMapsCommand } = await import(
+  './sentry-upload-sourcemaps.js'
+)
+
+describe('createSentryUploadSourceMapsCommand', () => {
+  let program
+
+  beforeEach(() => {
+    program = new Command()
+  })
+
+  afterEach(() => {
+    jest.clearAllMocks()
+  })
+
+  it('creates a command with the correct parameters', () => {
+    const command = createSentryUploadSourceMapsCommand(program)
+
+    expect(JSON.stringify(command, null, 2)).toMatchSnapshot()
   })
 })