@toptal/davinci-cli-shared 1.5.2-alpha-FX-2734-upgrade-cypress.125 → 1.5.2

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change Log
 
+## 1.5.2
+
+### Patch Changes
+
+- [#1343](https://github.com/toptal/davinci/pull/1343) [`1212e098`](https://github.com/toptal/davinci/commit/1212e098c668fc1c87ee9b1824edf0bc80509bc4) Thanks [@dmaklygin](https://github.com/dmaklygin)! - - implement custom helper for davinci workflow package
+
 ## 1.5.1
 
 ### Patch Changes

package/dist-package/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "@toptal/davinci-cli-shared",
+  "version": "1.5.2",
+  "description": "Shared CLI code and CLI engine for davinci",
+  "publishConfig": {
+    "access": "public"
+  },
+  "main": "src/index.js",
+  "scripts": {
+    "build:package": "../../bin/build-package.js",
+    "prepublishOnly": "../../bin/prepublish.js",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "Toptal",
+  "license": "ISC",
+  "dependencies": {
+    "chalk": "^4.1.2",
+    "execa": "^5.1.1",
+    "inquirer": "^8.2.0",
+    "js-yaml": "^4.1.0",
+    "vorpal": "^1.12.0"
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toptal/davinci-cli-shared",
-  "version": "1.5.2-alpha-FX-2734-upgrade-cypress.125+ac801e68",
+  "version": "1.5.2",
   "description": "Shared CLI code and CLI engine for davinci",
   "publishConfig": {
     "access": "public"
@@ -19,6 +19,5 @@
     "inquirer": "^8.2.0",
     "js-yaml": "^4.1.0",
     "vorpal": "^1.12.0"
-  },
-  "gitHead": "ac801e68bf3fb45dc8769c859f14632885734b7e"
+  }
 }

package/src/commands.loader.js

@@ -7,15 +7,22 @@ const commandsLoader = (commandCreators, vorpalInstance) => {
       description,
       options = [],
       allowUnknownOptions = false,
-      action
+      action,
+      help
     } = commandCreator
 
     const commandInstance = vorpalInstance
       .command(command)
-      .parse((command, args) => command.replace(args, toVorpalArgs(args)))
+      .parse((commandText, args) =>
+        commandText.replace(args, toVorpalArgs(args))
+      )
 
     options.forEach(option => commandInstance.option(option.name, option.label))
 
+    if (help) {
+      commandInstance.help(help)
+    }
+
     if (allowUnknownOptions) {
       commandInstance.allowUnknownOptions()
     }

package/src/index.js

@@ -3,7 +3,9 @@ const vorpal = require('vorpal')
 const print = require('../src/utils/print')
 const { run, runSync } = require('../src/utils/run')
 const prompt = require('../src/utils/prompt')
-const { convertToCLIParameters } = require('../src/utils/convert-to-cli-parameters')
+const {
+  convertToCLIParameters
+} = require('../src/utils/convert-to-cli-parameters')
 const davinciProjectConfig = require('./utils/davinci-project-config')
 const files = require('./utils/files')
 
@@ -17,11 +19,12 @@ const execCommand = (...args) => {
   return vorpalInstance.exec(...args)
 }
 
-const help = help => {
-  return vorpalInstance.help(help)
+const help = helpText => {
+  return vorpalInstance.help(helpText)
 }
 
 const catchErrorCommand = callback => {
+  /* eslint-disable promise/catch-or-return, promise/valid-params */
   vorpalInstance
     .catch('[commands...]', 'Catches incorrect commands')
     .action((args, cb) => {

package/src/utils/convert-to-cli-parameters.js

@@ -1,11 +1,13 @@
 const convertToCLIParameters = options => {
   const result = []
+
   Object.keys(options).forEach(key => {
-      result.push(`--${key}`)
+    result.push(`--${key}`)
+
+    const hasTrueValue = options[key] === true
+    const optionValue = hasTrueValue ? '' : String(options[key])
 
-      const hasTrueValue = options[key] === true
-      const optionValue = hasTrueValue ? '' : String(options[key])
-      result.push(optionValue)
+    result.push(optionValue)
   })
 
   return result

package/src/utils/davinci-project-config.js

@@ -1,10 +1,12 @@
 const fs = require('fs')
 const yaml = require('js-yaml')
+
 const files = require('./files')
 
 const path = files.getProjectRootFilePath('./davinci.yaml')
 const data = fs.existsSync(path) ? yaml.load(fs.readFileSync(path, 'utf8')) : {}
-const resolve = (sectionName, key) => Boolean(data && resolveKey(data[sectionName], key))
+const resolve = (sectionName, key) =>
+  Boolean(data && resolveKey(data[sectionName], key))
 const resolveKey = (section, key) => section && section[key]
 
 const davinciProjectConfig = {

package/src/utils/davinci-project-config.test.js

@@ -0,0 +1,109 @@
+describe('davinci-project-config', () => {
+  let fs
+
+  beforeEach(() => {
+    jest.resetModules()
+
+    jest.mock('fs')
+    fs = require('fs')
+  })
+
+  it('returns the default config when the file does not exist', () => {
+    fs.existsSync.mockReturnValue(false)
+    const davinciProjectConfig = require('./davinci-project-config')
+
+    expect(davinciProjectConfig.master.deploy).toBe(false)
+    expect(davinciProjectConfig.pr.contractTesting).toBe(false)
+  })
+
+  it('returns the default config when the file is empty', () => {
+    fs.existsSync.mockReturnValue(true)
+    fs.readFileSync.mockReturnValue('')
+    const davinciProjectConfig = require('./davinci-project-config')
+
+    expect(davinciProjectConfig.master.deploy).toBe(false)
+    expect(davinciProjectConfig.pr.contractTesting).toBe(false)
+  })
+
+  it('returns specified options merged with the default config', () => {
+    const data = `
+      master:
+        conventional_commits: true
+    `
+
+    fs.existsSync.mockReturnValue(true)
+    fs.readFileSync.mockReturnValue(data)
+    const davinciProjectConfig = require('./davinci-project-config')
+
+    expect(davinciProjectConfig.master.deploy).toBe(false)
+    expect(davinciProjectConfig.master.conventionalCommits).toBe(true)
+    expect(davinciProjectConfig.pr.contractTesting).toBe(false)
+  })
+
+  it('parses correctly is_progressive_web_app root flag', () => {
+    const data = `
+      is_progressive_web_app: true
+    `
+
+    fs.existsSync.mockReturnValue(true)
+    fs.readFileSync.mockReturnValue(data)
+    const davinciProjectConfig = require('./davinci-project-config')
+
+    expect(davinciProjectConfig.isProgressiveWebApp).toBe(true)
+  })
+
+  it('parses correctly service_worker_filename root flag', () => {
+    const serviceWorkerFileName = 'service-worker-123.js'
+    const data = `
+      service_worker_filename: ${serviceWorkerFileName}
+    `
+
+    fs.existsSync.mockReturnValue(true)
+    fs.readFileSync.mockReturnValue(data)
+    const davinciProjectConfig = require('./davinci-project-config')
+
+    expect(davinciProjectConfig.serviceWorkerFileName).toBe(
+      serviceWorkerFileName
+    )
+  })
+
+  it('when davinci.yml file exists and service_worker_filename is not specified in config', () => {
+    const data = `
+      master:
+        conventional_commits: true
+    `
+
+    fs.existsSync.mockReturnValue(true)
+    fs.readFileSync.mockReturnValue(data)
+    const davinciProjectConfig = require('./davinci-project-config')
+
+    expect(davinciProjectConfig.serviceWorkerFileName).toBeUndefined()
+  })
+
+  it('when davinci.yml file is empty and service_worker_filename is not specified in config', () => {
+    const data = ''
+
+    fs.existsSync.mockReturnValue(true)
+    fs.readFileSync.mockReturnValue(data)
+    const davinciProjectConfig = require('./davinci-project-config')
+
+    expect(davinciProjectConfig.serviceWorkerFileName).toBeUndefined()
+  })
+
+  it('parses correctly safety_workers list', () => {
+    const data = `
+      safety_workers:
+        - service-worker-1.js
+        - service-worker-2.js
+    `
+
+    fs.existsSync.mockReturnValue(true)
+    fs.readFileSync.mockReturnValue(data)
+    const davinciProjectConfig = require('./davinci-project-config')
+
+    expect(davinciProjectConfig.safetyWorkers).toEqual([
+      'service-worker-1.js',
+      'service-worker-2.js'
+    ])
+  })
+})

package/src/utils/files.js

@@ -1,23 +1,21 @@
 const path = require('path')
 
 const getPackageFileContent = (davinciPackageName, filename) =>
-  require(
-    getPackageFilePath(davinciPackageName, filename)
-  )
+  require(getPackageFilePath(davinciPackageName, filename))
 
 const getPackageFilePath = (davinciPackageName, filename) => {
   const packageIndexPath = require.resolve(davinciPackageName)
   const davinciQARoot = path.join(packageIndexPath, '../..')
+
   return path.join(davinciQARoot, filename)
 }
 
 const getProjectRootFileContent = filename =>
-  require(
-    getProjectRootFilePath(filename)
-  )
+  require(getProjectRootFilePath(filename))
 
 const getProjectRootFilePath = filename => {
   const currentRunningDir = process.cwd()
+
   return path.join(currentRunningDir, filename)
 }
 

package/src/utils/print.js

@@ -26,9 +26,42 @@ const grey = (...args) => {
   console.log(chalk.grey(...prettifyObjectIfExist(args)))
 }
 
+const generatePadding = (str, width, delimiter = ' ') => {
+  const len = Math.max(0, Math.floor(width) - str.trim().length)
+
+  return str + Array(len + 1).join(delimiter)
+}
+
+/**
+ * Build a list of commands
+ * @param commands Array<[name, description]>
+ */
+const prettifyCommands = commands => {
+  if (!commands.length) {
+    return ''
+  }
+
+  const width = commands.reduce(
+    (max, commandX) => Math.max(max, commandX[0].length),
+    0
+  )
+
+  return commands
+    .map(([command, description]) => {
+      const prefix =
+        '    ' + chalk.green(generatePadding(command, width)) + '  '
+      const suffix = generatePadding('', width + 6) + description
+
+      return prefix + suffix
+    })
+    .join('\n')
+}
+
 module.exports = {
   green,
   yellow,
   red,
-  grey
+  grey,
+  generatePadding,
+  prettifyCommands
 }

package/src/utils/to-vorpal-args.test.js

@@ -0,0 +1,37 @@
+const toVorpalArgs = require('./to-vorpal-args')
+
+describe('toVorpalArgs', () => {
+  it('transforms numbers', () => {
+    const initialArgs = '--foo=1 --bar=2'
+    const expectedArgs = '--foo 1 --bar 2'
+
+    expect(toVorpalArgs(initialArgs)).toEqual(expectedArgs)
+  })
+
+  it('transforms strings', () => {
+    const initialArgs = '--foo="hello" --bar="world"'
+    const expectedArgs = '--foo "hello" --bar "world"'
+
+    expect(toVorpalArgs(initialArgs)).toEqual(expectedArgs)
+  })
+
+  it('transforms booleans', () => {
+    const initialArgs = '--foo=true --bar=false'
+    const expectedArgs = '--foo true --bar false'
+
+    expect(toVorpalArgs(initialArgs)).toEqual(expectedArgs)
+  })
+
+  it('transforms short arguments', () => {
+    const initialArgs = '-f=1 -b="hello"'
+    const expectedArgs = '-f 1 -b "hello"'
+
+    expect(toVorpalArgs(initialArgs)).toEqual(expectedArgs)
+  })
+
+  it('ignores formatted arguments', () => {
+    const formattedArgs = '--foo 1 --bar "hello" -f true'
+
+    expect(toVorpalArgs(formattedArgs)).toEqual(formattedArgs)
+  })
+})