@toptal/davinci-monorepo 8.2.0 → 8.2.1

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @toptal/davinci-monorepo
 
+## 8.2.1
+
+### Patch Changes
+
+- [#2021](https://github.com/toptal/davinci/pull/2021) [`97abce92`](https://github.com/toptal/davinci/commit/97abce922d3a0720e0806ae9cd2f2866f355a1bc) Thanks [@dmaklygin](https://github.com/dmaklygin)!
+
+---
+
+- standardize command syntax for consistency
+- Updated dependencies [[`97abce92`](https://github.com/toptal/davinci/commit/97abce922d3a0720e0806ae9cd2f2866f355a1bc)]:
+  - @toptal/davinci-cli-shared@2.3.1
+
 ## 8.2.0
 
 ### Minor Changes

package/bin/davinci-monorepo.js

@@ -1,22 +1,7 @@
 #!/usr/bin/env node
 
 import cliEngine from '@toptal/davinci-cli-shared'
+import { commands } from '../src/index.js'
 
-import detectCircularityCommand from '../src/commands/detect-circularity.js'
-import { createGraphGenerateCommand } from '../src/commands/graph-generate.js'
-import metricsCommand from '../src/commands/metrics.js'
-// eslint-disable-next-line no-restricted-syntax
-import codeownersCommand from '../src/commands/codeowners/index.js'
-import { createCoverageCommand } from '../src/commands/coverage-command/index.js'
-
-cliEngine.loadCommands(
-  [
-    detectCircularityCommand,
-    createGraphGenerateCommand,
-    metricsCommand,
-    codeownersCommand,
-    createCoverageCommand,
-  ],
-  'davinci-monorepo'
-)
+cliEngine.loadCommands(commands, 'davinci-monorepo')
 cliEngine.bootstrap()

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toptal/davinci-monorepo",
-  "version": "8.2.0",
+  "version": "8.2.1",
   "description": "Monorepo utility tools",
   "publishConfig": {
     "access": "public"
@@ -34,7 +34,7 @@
   },
   "dependencies": {
     "@oclif/core": "^1.16.1",
-    "@toptal/davinci-cli-shared": "2.3.0",
+    "@toptal/davinci-cli-shared": "2.3.1",
     "chalk": "^4.1.2",
     "dependency-cruiser": "^12.5.0",
     "execa": "^5.1.1",

package/src/commands/__snapshots__/detect-circularity.test.js.snap

@@ -0,0 +1,47 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`createDetectCircularityCommand creates a command with the correct parameters 1`] = `
+"{
+  "_events": {},
+  "_eventsCount": 0,
+  "commands": [],
+  "options": [],
+  "parent": null,
+  "_allowUnknownOption": false,
+  "_allowExcessArguments": true,
+  "_args": [],
+  "args": [],
+  "rawArgs": [],
+  "processedArgs": [],
+  "_scriptPath": null,
+  "_name": "detect-circularity",
+  "_optionValues": {},
+  "_optionValueSources": {},
+  "_storeOptionsAsProperties": false,
+  "_executableHandler": false,
+  "_executableFile": null,
+  "_executableDir": null,
+  "_defaultCommandName": null,
+  "_exitCallback": null,
+  "_aliases": [],
+  "_combineFlagAndOptionalValue": true,
+  "_description": "Detects circular dependencies in a monorepo",
+  "_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__/metrics.test.js.snap

@@ -1,29 +1,105 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`metricsCommandCreator has the correct command structure 1`] = `
-{
-  "action": [Function],
-  "command": "metrics",
-  "description": "Calculates and shows monorepo quality metrics. 
-  See: https://github.com/toptal/davinci/wiki/packages:monorepo:docs:metrics",
+exports[`createMetricsCommand creates a command with the correct parameters 1`] = `
+"{
+  "_events": {},
+  "_eventsCount": 4,
+  "commands": [],
   "options": [
     {
-      "label": "set of metrics to calculate separated by commas",
-      "name": "-m, --metric [metrics]",
+      "flags": "-m, --metric [metrics]",
+      "description": "set of metrics to calculate separated by commas",
+      "required": false,
+      "optional": true,
+      "variadic": false,
+      "mandatory": false,
+      "short": "-m",
+      "long": "--metric",
+      "negate": false,
+      "hidden": false,
+      "conflictsWith": []
     },
     {
-      "label": "File pathname to save metrics in",
-      "name": "-o, --output-path <outputPath>",
+      "flags": "-o, --output-path <outputPath>",
+      "description": "File pathname to save metrics in",
+      "required": true,
+      "optional": false,
+      "variadic": false,
+      "mandatory": false,
+      "short": "-o",
+      "long": "--output-path",
+      "negate": false,
+      "hidden": false,
+      "conflictsWith": []
     },
     {
-      "default": "raw",
-      "label": "Supported formats: raw, json, csv",
-      "name": "-f, --format <format>",
+      "flags": "-f, --format <format>",
+      "description": "Supported formats: raw, json, csv",
+      "required": true,
+      "optional": false,
+      "variadic": false,
+      "mandatory": false,
+      "short": "-f",
+      "long": "--format",
+      "negate": false,
+      "defaultValue": "raw",
+      "hidden": false,
+      "conflictsWith": []
     },
     {
-      "label": "List of packages to exclude from calculation separated by commas",
-      "name": "-e, --exclude-packages <excludedPackages>",
-    },
+      "flags": "-e, --exclude-packages <excludedPackages>",
+      "description": "List of packages to exclude from calculation separated by commas",
+      "required": true,
+      "optional": false,
+      "variadic": false,
+      "mandatory": false,
+      "short": "-e",
+      "long": "--exclude-packages",
+      "negate": false,
+      "hidden": false,
+      "conflictsWith": []
+    }
   ],
-}
+  "parent": null,
+  "_allowUnknownOption": false,
+  "_allowExcessArguments": true,
+  "_args": [],
+  "args": [],
+  "rawArgs": [],
+  "processedArgs": [],
+  "_scriptPath": null,
+  "_name": "metrics",
+  "_optionValues": {
+    "format": "raw"
+  },
+  "_optionValueSources": {
+    "format": "default"
+  },
+  "_storeOptionsAsProperties": false,
+  "_executableHandler": false,
+  "_executableFile": null,
+  "_executableDir": null,
+  "_defaultCommandName": null,
+  "_exitCallback": null,
+  "_aliases": [],
+  "_combineFlagAndOptionalValue": true,
+  "_description": "Calculates and shows monorepo quality metrics. \\n  See: https://github.com/toptal/davinci/wiki/packages:monorepo:docs:metrics",
+  "_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/codeowners/index.js

@@ -5,7 +5,7 @@ import listCommand from './commands/list.js'
 import ownersInformationCommand from './commands/owners-information.js'
 import packagesInformationCommand from './commands/packages-information.js'
 
-const codeownersCommand = program => {
+export const createCodeownersCommand = program => {
   const codeowners = program
     .createCommand('codeowners')
     .description(
@@ -23,5 +23,3 @@ const codeownersCommand = program => {
 }
 
 export { asyncCodeownersImport } from './services/async-codeowners-import/async-codeowners-import.js'
-
-export default codeownersCommand

package/src/commands/detect-circularity.js

@@ -5,10 +5,8 @@ import getWorkspaces from '../utils/get-workspaces.js'
 import makeWorkspacesGraph from '../utils/make-workspaces-graph.js'
 import getGraphCyclePaths from '../utils/get-graph-cycle-paths.js'
 import getCircularityErrorMessage from '../utils/get-circularity-error-message.js'
-
 const detectCircularityCommand = () => {
   print.header('Running circular dependencies check')
-
   const workspaces = getWorkspaces(path.resolve())
   const workspacesGraph = makeWorkspacesGraph(workspaces)
   const cyclePaths = getGraphCyclePaths(workspacesGraph)
@@ -17,14 +15,12 @@ const detectCircularityCommand = () => {
     print.red(getCircularityErrorMessage(cyclePaths))
     process.exit(1)
   }
-
   print.success('No circular dependencies found.')
 }
 
-const detectCircularityCommandCreator = {
-  action: detectCircularityCommand,
-  command: 'detect-circularity',
-  description: 'Detects circular dependencies in a monorepo',
+export const createDetectCircularityCommand = program => {
+  return program
+    .createCommand('detect-circularity')
+    .description('Detects circular dependencies in a monorepo')
+    .action(detectCircularityCommand)
 }
-
-export default detectCircularityCommandCreator

package/src/commands/detect-circularity.test.js

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

package/src/commands/metrics.js

@@ -12,11 +12,9 @@ import fs from 'fs'
 import metrics from '../services/metrics/index.js'
 import { raw, csv, json } from '../services/renderers/index.js'
 import { getLernaGraph } from '../utils/index.js'
-
 const defaultMetricKeysList = metrics.reduce((acc, { info }) => {
   return acc.concat(Object.keys(info))
 }, [])
-
 const getSelectedMetrics = (metrics, metricKeys = []) => {
   if (!metricKeys.length) {
     return metrics
@@ -26,7 +24,6 @@ const getSelectedMetrics = (metrics, metricKeys = []) => {
     ({ info }) => length(intersection(keys(info), metricKeys)) > 0
   )
 }
-
 const proceedPackagesMetric = (packagesGraph, metrics, metricKeysList = []) => {
   const packageNames = Object.keys(packagesGraph)
   let packages = {}
@@ -41,7 +38,6 @@ const proceedPackagesMetric = (packagesGraph, metrics, metricKeysList = []) => {
       ),
     }
   })
-
   packages = Object.keys(packages).reduce((acc, packageName) => {
     const packageInfo = packages[packageName]
 
@@ -54,7 +50,6 @@ const proceedPackagesMetric = (packagesGraph, metrics, metricKeysList = []) => {
 
       return acc
     }
-
     acc[packageName] = packageInfo
 
     return acc
@@ -64,7 +59,6 @@ const proceedPackagesMetric = (packagesGraph, metrics, metricKeysList = []) => {
   return metrics.reduce(
     (previousValue, metric) => {
       const { info, calculate } = metric
-
       const filteredMetricList = intersection(metricKeysList, keys(info))
 
       filteredMetricList.forEach(metricKey => {
@@ -77,12 +71,18 @@ const proceedPackagesMetric = (packagesGraph, metrics, metricKeysList = []) => {
         : [calculate]
 
       return reduce(
-        (acc, fn) => mergeDeepRight(acc, { packagesInfo: fn(acc) }),
+        (acc, fn) =>
+          mergeDeepRight(acc, {
+            packagesInfo: fn(acc),
+          }),
         previousValue,
         calculationChain
       )
     },
-    { metricInfo: {}, packagesInfo: packages }
+    {
+      metricInfo: {},
+      packagesInfo: packages,
+    }
   )
 }
 
@@ -92,14 +92,12 @@ const proceedPackagesMetric = (packagesGraph, metrics, metricKeysList = []) => {
  */
 const metricsCommand = options => {
   print.header('Start calculating quality metrics')
-
   const {
     metric: metricKeys = '',
     format,
     outputPath,
     excludedPackages = '',
   } = options
-
   const metricKeysList = metricKeys
     ? metricKeys.split(',')
     : defaultMetricKeysList
@@ -115,7 +113,6 @@ const metricsCommand = options => {
     print.red(err)
     process.exit(1)
   }
-
   print.green('Searching for metrics information...')
   const filteredMetrics = getSelectedMetrics(metrics, metricKeysList)
 
@@ -123,7 +120,6 @@ const metricsCommand = options => {
     print.red('Metric not found')
     process.exit(1)
   }
-
   print.green('Calculating metrics...')
 
   // for each metric procedure, we have to go through the list of packages
@@ -132,7 +128,6 @@ const metricsCommand = options => {
     filteredMetrics,
     metricKeysList
   )
-
   let output
 
   switch (format) {
@@ -145,7 +140,6 @@ const metricsCommand = options => {
     default:
       output = raw(metricInfo, packagesInfo)
   }
-
   if (outputPath) {
     try {
       fs.writeFileSync(outputPath, output)
@@ -159,30 +153,24 @@ const metricsCommand = options => {
   }
 }
 
-const metricsCommandCreator = {
-  action: metricsCommand,
-  command: 'metrics',
-  description:
-    'Calculates and shows monorepo quality metrics. \n  See: https://github.com/toptal/davinci/wiki/packages:monorepo:docs:metrics',
-  options: [
-    {
-      name: '-m, --metric [metrics]',
-      label: 'set of metrics to calculate separated by commas',
-    },
-    {
-      name: '-o, --output-path <outputPath>',
-      label: 'File pathname to save metrics in',
-    },
-    {
-      name: '-f, --format <format>',
-      label: 'Supported formats: raw, json, csv',
-      default: 'raw',
-    },
-    {
-      name: '-e, --exclude-packages <excludedPackages>',
-      label: 'List of packages to exclude from calculation separated by commas',
-    },
-  ],
+export const createMetricsCommand = program => {
+  return program
+    .createCommand('metrics')
+    .description(
+      'Calculates and shows monorepo quality metrics. \n  See: https://github.com/toptal/davinci/wiki/packages:monorepo:docs:metrics'
+    )
+    .action(metricsCommand)
+    .option(
+      '-m, --metric [metrics]',
+      'set of metrics to calculate separated by commas'
+    )
+    .option(
+      '-o, --output-path <outputPath>',
+      'File pathname to save metrics in'
+    )
+    .option('-f, --format <format>', 'Supported formats: raw, json, csv', 'raw')
+    .option(
+      '-e, --exclude-packages <excludedPackages>',
+      'List of packages to exclude from calculation separated by commas'
+    )
 }
-
-export default metricsCommandCreator

package/src/commands/metrics.test.js

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

package/src/index.js

@@ -1,7 +1,7 @@
-import detectCircularityCommandCreator from './commands/detect-circularity.js'
-import metricsCommandCreator from './commands/metrics.js'
+import { createDetectCircularityCommand } from './commands/detect-circularity.js'
+import { createMetricsCommand } from './commands/metrics.js'
 import { createGraphGenerateCommand } from './commands/graph-generate.js'
-import codeownersCommand from './commands/codeowners/index.js'
+import { createCodeownersCommand } from './commands/codeowners/index.js'
 import { createCoverageCommand } from './commands/coverage-command/index.js'
 import checkIfMonorepo from './utils/check-if-monorepo.js'
 import getPackages from './utils/get-packages.js'
@@ -12,10 +12,10 @@ export const utils = {
 }
 
 export const commands = [
-  detectCircularityCommandCreator,
-  metricsCommandCreator,
+  createDetectCircularityCommand,
+  createMetricsCommand,
   createGraphGenerateCommand,
-  codeownersCommand,
+  createCodeownersCommand,
   createCoverageCommand,
 ]