@revoloo/cypress6/npm/create-cypress-tests/src/utils.ts

Cypress.io end to end testing tool

import semver from 'semver'
import chalk from 'chalk'
import ora from 'ora'
import util from 'util'
import { exec } from 'child_process'

/**
 * Compare available version range with the provided version from package.json
 * @param packageName Package name used to display a helper message to user.
 */
export function validateSemverVersion (
  version: string,
  allowedVersionRange: string,
  packageName?: string,
) {
  let isValid: boolean

  try {
    const minAvailableVersion = semver.minVersion(version)?.raw

    isValid = Boolean(
      minAvailableVersion &&
        semver.satisfies(minAvailableVersion, allowedVersionRange),
    )
  } catch (e) {
    // handle not semver versions like "latest", "git:" or "file:"
    isValid = false
  }

  if (!isValid && packageName) {
    const packageNameSymbol = chalk.green(packageName)

    console.warn(
      `It seems like you are using ${packageNameSymbol} with version ${chalk.bold(
        version,
      )}, however we support only ${packageNameSymbol} projects with version ${chalk.bold(
        allowedVersionRange,
      )}. \n`,
    )
  }

  return isValid
}

export async function installDependency (name: string, options: { useYarn: boolean}) {
  const commandToRun = options.useYarn ? `yarn add ${name} --dev` : `npm install -D ${name}`
  let cliSpinner = ora(`Installing ${name} ${chalk.gray(`(${commandToRun})`)}`).start()

  try {
    // do this inside function for test stubbing
    const execAsync = util.promisify(exec)

    await execAsync(commandToRun)
  } catch (e) {
    cliSpinner.fail(`Can not install ${name} using ${chalk.inverse(commandToRun)})}`)
    console.log(e)

    process.exit(1)
  }

  cliSpinner.succeed()
}