@toptal/davinci-ci 4.0.9-alpha-CRT-5891-create-coverage-command-3e3ae146.46 → 4.0.9-alpha-chore-standardize-command-syntax-for-consistency-5feafaf6.44

package/bin/davinci-ci.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 import cliEngine from '@toptal/davinci-cli-shared'
 
-import dangerCommand from '../src/commands/danger.js'
+import { createDangerCommand } from '../src/commands/danger.js'
 
-cliEngine.loadCommands([dangerCommand], 'davinci-ci')
+cliEngine.loadCommands([createDangerCommand], 'davinci-ci')
 cliEngine.bootstrap()

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toptal/davinci-ci",
-  "version": "4.0.9-alpha-CRT-5891-create-coverage-command-3e3ae146.46+3e3ae146",
+  "version": "4.0.9-alpha-chore-standardize-command-syntax-for-consistency-5feafaf6.44+5feafaf6",
   "description": "Continuos integrations tools for frontend projects",
   "publishConfig": {
     "access": "public"
@@ -38,12 +38,12 @@
   "dependencies": {
     "@commitlint/cli": "^17.4.0",
     "@commitlint/config-conventional": "^17.1.0",
-    "@toptal/davinci-cli-shared": "2.3.1-alpha-CRT-5891-create-coverage-command-3e3ae146.46+3e3ae146",
+    "@toptal/davinci-cli-shared": "2.3.1-alpha-chore-standardize-command-syntax-for-consistency-5feafaf6.44+5feafaf6",
     "danger": "^11.2.2",
     "markdown-table": "^2.0.0"
   },
   "devDependencies": {
     "@jest/globals": "^29.4.2"
   },
-  "gitHead": "3e3ae146eca363a09b91658e20d7295f9934b977"
+  "gitHead": "5feafaf623abc6ee68d727143d0ed1f387b79da1"
 }

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

@@ -1,24 +1,84 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`dangerCommandCreator has the correct command structure 1`] = `
-{
-  "action": [Function],
-  "allowUnknownOptions": true,
-  "command": "danger",
-  "description": "Run danger check",
+exports[`createDangerCommand creates a command with the correct parameters 1`] = `
+"{
+  "_events": {},
+  "_eventsCount": 3,
+  "commands": [],
   "options": [
     {
-      "label": "check only, without fixing the code",
-      "name": "--check",
+      "flags": "--check",
+      "description": "check only, without fixing the code",
+      "required": false,
+      "optional": false,
+      "variadic": false,
+      "mandatory": false,
+      "long": "--check",
+      "negate": false,
+      "hidden": false,
+      "conflictsWith": []
     },
     {
-      "label": "checks commit message quality locally",
-      "name": "--local",
+      "flags": "--local",
+      "description": "checks commit message quality locally",
+      "required": false,
+      "optional": false,
+      "variadic": false,
+      "mandatory": false,
+      "long": "--local",
+      "negate": false,
+      "hidden": false,
+      "conflictsWith": []
     },
     {
-      "label": "specify custom danger file",
-      "name": "--dangerfile <dangerfile>",
-    },
+      "flags": "--dangerfile <dangerfile>",
+      "description": "specify custom danger file",
+      "required": true,
+      "optional": false,
+      "variadic": false,
+      "mandatory": false,
+      "long": "--dangerfile",
+      "negate": false,
+      "hidden": false,
+      "conflictsWith": []
+    }
   ],
-}
+  "parent": null,
+  "_allowUnknownOption": true,
+  "_allowExcessArguments": true,
+  "_args": [],
+  "args": [],
+  "rawArgs": [],
+  "processedArgs": [],
+  "_scriptPath": null,
+  "_name": "danger",
+  "_optionValues": {},
+  "_optionValueSources": {},
+  "_storeOptionsAsProperties": false,
+  "_executableHandler": false,
+  "_executableFile": null,
+  "_executableDir": null,
+  "_defaultCommandName": null,
+  "_exitCallback": null,
+  "_aliases": [],
+  "_combineFlagAndOptionalValue": true,
+  "_description": "Run danger check",
+  "_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/danger.js

@@ -6,26 +6,9 @@ import {
   files,
 } from '@toptal/davinci-cli-shared'
 
-const commandOptions = [
-  {
-    label: 'check only, without fixing the code',
-    name: '--check',
-  },
-  {
-    label: 'checks commit message quality locally',
-    name: '--local',
-  },
-  {
-    label: 'specify custom danger file',
-    name: '--dangerfile <dangerfile>',
-  },
-]
-
-const dangerCommand = options => {
+export const dangerCommand = options => {
   print.header('Running danger check')
-
   const { local, dangerfile, ...rest } = options
-
   const conventionalCommitsDangerfilePath = files.getPackageFilePath(
     '@toptal/davinci-ci',
     'src/configs/danger/conventional-commits/dangerfile.cjs'
@@ -34,7 +17,6 @@ const dangerCommand = options => {
     '@toptal/davinci-ci',
     'src/configs/danger/toptal/dangerfile.cjs'
   )
-
   let dangerfilePath = dangerfile
 
   if (!dangerfilePath) {
@@ -42,7 +24,6 @@ const dangerCommand = options => {
       ? conventionalCommitsDangerfilePath
       : toptalCommitsDangerfilePath
   }
-
   runSync(
     'yarn',
     [
@@ -56,12 +37,13 @@ const dangerCommand = options => {
   )
 }
 
-const dangerCommandCreator = {
-  action: dangerCommand,
-  allowUnknownOptions: true,
-  command: 'danger',
-  description: 'Run danger check',
-  options: commandOptions,
+export const createDangerCommand = program => {
+  return program
+    .createCommand('danger')
+    .allowUnknownOption()
+    .description('Run danger check')
+    .option('--check', 'check only, without fixing the code')
+    .option('--local', 'checks commit message quality locally')
+    .option('--dangerfile <dangerfile>', 'specify custom danger file')
+    .action(dangerCommand)
 }
-
-export default dangerCommandCreator

package/src/commands/danger.test.js

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