@toptal/davinci-monorepo 8.1.4-alpha-CRT-5891-create-coverage-command-5071adf7.9 → 8.1.4-alpha-CRT-5891-create-coverage-command-1b2c7953.12

package/docs/coverage.md

@@ -8,10 +8,10 @@ Streamline code coverage analysis and reporting by organizing coverage reports b
 codeowners group-coverage-by-codeowners
 ```
 
-#### `generage-team-coverage`
+#### `generate-team-coverage`
 
 ```sh
-coverage generage-team-coverage [options]
+coverage generate-team-coverage [options]
 
 Options:
   -r, --repository <repository_name>         specify repository name

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toptal/davinci-monorepo",
-  "version": "8.1.4-alpha-CRT-5891-create-coverage-command-5071adf7.9+5071adf7",
+  "version": "8.1.4-alpha-CRT-5891-create-coverage-command-1b2c7953.12+1b2c7953",
   "description": "Monorepo utility tools",
   "publishConfig": {
     "access": "public"
@@ -35,7 +35,7 @@
   "dependencies": {
     "@nodelib/fs.walk": "^1.2.6",
     "@oclif/core": "^1.16.1",
-    "@toptal/davinci-cli-shared": "2.3.1-alpha-CRT-5891-create-coverage-command-5071adf7.41+5071adf7",
+    "@toptal/davinci-cli-shared": "2.3.1-alpha-CRT-5891-create-coverage-command-1b2c7953.44+1b2c7953",
     "chalk": "^4.1.2",
     "codeowners": "5.1.1",
     "dependency-cruiser": "^12.5.0",
@@ -54,5 +54,5 @@
   "devDependencies": {
     "@jest/globals": "^29.4.2"
   },
-  "gitHead": "5071adf786fc0f9eaf34275fe751c75f403dacfa"
+  "gitHead": "1b2c79534c7559b73b39c067ab0480eadccf0ebc"
 }

package/src/commands/coverage-command/__snapshots__/create-generate-team-coverage-command.test.js.snap

@@ -0,0 +1,74 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`createGenerateTeamCoverageCommand has the correct command structure 1`] = `
+"{
+  "_events": {},
+  "_eventsCount": 2,
+  "commands": [],
+  "options": [
+    {
+      "flags": "-r, --repository <repository_name>",
+      "description": "specify repository name",
+      "required": true,
+      "optional": false,
+      "variadic": false,
+      "mandatory": true,
+      "short": "-r",
+      "long": "--repository",
+      "negate": false,
+      "hidden": false,
+      "conflictsWith": []
+    },
+    {
+      "flags": "-o, --output-file-name <output_file_name>",
+      "description": "specify output file name",
+      "required": true,
+      "optional": false,
+      "variadic": false,
+      "mandatory": true,
+      "short": "-o",
+      "long": "--output-file-name",
+      "negate": false,
+      "hidden": false,
+      "conflictsWith": []
+    }
+  ],
+  "parent": null,
+  "_allowUnknownOption": false,
+  "_allowExcessArguments": true,
+  "_args": [],
+  "args": [],
+  "rawArgs": [],
+  "processedArgs": [],
+  "_scriptPath": null,
+  "_name": "generate-team-coverage",
+  "_optionValues": {},
+  "_optionValueSources": {},
+  "_storeOptionsAsProperties": false,
+  "_executableHandler": false,
+  "_executableFile": null,
+  "_executableDir": null,
+  "_defaultCommandName": null,
+  "_exitCallback": null,
+  "_aliases": [],
+  "_combineFlagAndOptionalValue": true,
+  "_description": "Generates team-specific coverage reports by copying and processing coverage data from Jest and Cypress reports.\\nThe resulting coverage reports provide insights into the code coverage metrics for each team.",
+  "_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/coverage-command/__snapshots__/create-group-coverage-by-codeowners-command.test.js.snap

@@ -0,0 +1,47 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`createGroupCoverageByCodeownersCommand has the correct command structure 1`] = `
+"{
+  "_events": {},
+  "_eventsCount": 0,
+  "commands": [],
+  "options": [],
+  "parent": null,
+  "_allowUnknownOption": false,
+  "_allowExcessArguments": true,
+  "_args": [],
+  "args": [],
+  "rawArgs": [],
+  "processedArgs": [],
+  "_scriptPath": null,
+  "_name": "group-coverage-by-codeowners",
+  "_optionValues": {},
+  "_optionValueSources": {},
+  "_storeOptionsAsProperties": false,
+  "_executableHandler": false,
+  "_executableFile": null,
+  "_executableDir": null,
+  "_defaultCommandName": null,
+  "_exitCallback": null,
+  "_aliases": [],
+  "_combineFlagAndOptionalValue": true,
+  "_description": "Reads code coverage reports for Jest and Cypress, groups the coverage data based on code owners, and writes separate coverage reports for each team.\\nThe command utilizes the Codeowners class, which is responsible for identifying the code owners associated with each file.",
+  "_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/coverage-command/create-generate-team-coverage-command.js

@@ -2,9 +2,10 @@ import path from 'path'
 import execa from 'execa'
 import { print } from '@toptal/davinci-cli-shared'
 import { readFile, writeFile, mkdir, cp, rm } from 'fs/promises'
+import { existsSync } from 'fs'
 
 import { sanitizeTeamName } from './services/sanitize-team-name/sanitize-team-name.js'
-import { JEST_COVERAGE_PATH, TEAMS_COVERAGE_PATH } from './config.js'
+import { TEAMS_COVERAGE_PATH } from './config.js'
 import { getUniqueTeams } from './services/get-unique-teams/get-unique-teams.js'
 import { asyncCodeownersImport } from '../codeowners/index.js'
 
@@ -16,15 +17,28 @@ const generateNycReport = async ({
   sanitizedTeamPath,
   sanitizedTeam,
 }) => {
-  await mkdir(`${sanitizedTeamPath}/${type}`)
+  const sanitizedTeamPathWithType = path.join(sanitizedTeamPath, type)
+
+  await mkdir(sanitizedTeamPathWithType)
+
+  const fullCoverageTeamPath = path.join(
+    'coverage',
+    type,
+    `coverage-final-${sanitizedTeam}.json`
+  )
+
+  if (!existsSync(fullCoverageTeamPath)) {
+    print.red(`Make sure that '${fullCoverageTeamPath}' exists`)
+    process.exit(1)
+  }
 
   await cp(
-    `${JEST_COVERAGE_PATH}/coverage-final-${sanitizedTeam}.json`,
-    `${sanitizedTeamPath}/${type}/coverage-final.json`
+    path.join(fullCoverageTeamPath),
+    path.join(sanitizedTeamPathWithType, 'coverage-final.json')
   )
 
   await execa.command(
-    `yarn nyc report --temp-dir ${sanitizedTeamPath}/${type} --reporter json-summary --reporter html --report-dir ${sanitizedTeamPath}/${type}`
+    `yarn nyc report --temp-dir ${sanitizedTeamPathWithType} --reporter json-summary --reporter html --report-dir ${sanitizedTeamPathWithType}`
   )
 }
 
@@ -32,7 +46,7 @@ const getCoverageSummary = async (type, teamPath) => {
   const result = {}
 
   const coverageSummary = JSON.parse(
-    await readFile(`${teamPath}/${type}/coverage-summary.json`, 'utf8')
+    await readFile(path.join(teamPath, type, 'coverage-summary.json'), 'utf8')
   )
 
   result[`${type}_lines_coverage`] = sanitizeNycPercentage(
@@ -111,7 +125,7 @@ const generateTeamCoverage = async options => {
 
 export const createGenerateTeamCoverageCommand = program =>
   program
-    .command('generate-team-coverage')
+    .createCommand('generate-team-coverage')
     .description(
       `Generates team-specific coverage reports by copying and processing coverage data from Jest and Cypress reports.
 The resulting coverage reports provide insights into the code coverage metrics for each team.`

package/src/commands/coverage-command/create-generate-team-coverage-command.test.js

@@ -0,0 +1,25 @@
+import { jest } from '@jest/globals'
+// eslint-disable-next-line import/no-extraneous-dependencies
+import { Command } from 'commander'
+
+const { createGenerateTeamCoverageCommand } = await import(
+  './create-generate-team-coverage-command.js'
+)
+
+describe('createGenerateTeamCoverageCommand', () => {
+  let program
+
+  beforeEach(() => {
+    program = new Command()
+  })
+
+  afterEach(() => {
+    jest.clearAllMocks()
+  })
+
+  it('has the correct command structure', () => {
+    const command = createGenerateTeamCoverageCommand(program)
+
+    expect(JSON.stringify(command, null, 2)).toMatchSnapshot()
+  })
+})

package/src/commands/coverage-command/create-group-coverage-by-codeowners-command.js

@@ -2,6 +2,7 @@ import path from 'path'
 import { print } from '@toptal/davinci-cli-shared'
 import getWorkspaceRoot from 'find-yarn-workspace-root'
 import { readFile, writeFile } from 'fs/promises'
+import { existsSync } from 'fs'
 
 import { CYPRESS_COVERAGE_PATH, JEST_COVERAGE_PATH } from './config.js'
 import { sanitizeTeamName } from './services/sanitize-team-name/sanitize-team-name.js'
@@ -11,7 +12,14 @@ import { asyncCodeownersImport } from '../codeowners/index.js'
 const workspaceRoot = getWorkspaceRoot()
 
 const readCoverageReport = async reportPathName => {
-  const data = await readFile(path.join(workspaceRoot, reportPathName), 'utf8')
+  const fullPath = path.join(workspaceRoot, reportPathName)
+
+  if (!existsSync(fullPath)) {
+    print.red(`Make sure that '${fullPath}' exists`)
+    process.exit(1)
+  }
+
+  const data = await readFile(fullPath, 'utf8')
 
   return JSON.parse(data)
 }
@@ -87,7 +95,7 @@ const groupCoverageByCodeowners = async () => {
 
 export const createGroupCoverageByCodeownersCommand = program =>
   program
-    .command('group-coverage-by-codeowners')
+    .createCommand('group-coverage-by-codeowners')
     .description(
       `Reads code coverage reports for Jest and Cypress, groups the coverage data based on code owners, and writes separate coverage reports for each team.
 The command utilizes the Codeowners class, which is responsible for identifying the code owners associated with each file.`

package/src/commands/coverage-command/create-group-coverage-by-codeowners-command.test.js

@@ -0,0 +1,25 @@
+import { jest } from '@jest/globals'
+// eslint-disable-next-line import/no-extraneous-dependencies
+import { Command } from 'commander'
+
+const { createGroupCoverageByCodeownersCommand } = await import(
+  './create-group-coverage-by-codeowners-command.js'
+)
+
+describe('createGroupCoverageByCodeownersCommand', () => {
+  let program
+
+  beforeEach(() => {
+    program = new Command()
+  })
+
+  afterEach(() => {
+    jest.clearAllMocks()
+  })
+
+  it('has the correct command structure', () => {
+    const command = createGroupCoverageByCodeownersCommand(program)
+
+    expect(JSON.stringify(command, null, 2)).toMatchSnapshot()
+  })
+})

package/src/commands/coverage-command/index.js

@@ -1,15 +1,11 @@
 import { createGroupCoverageByCodeownersCommand } from './create-group-coverage-by-codeowners-command.js'
 import { createGenerateTeamCoverageCommand } from './create-generate-team-coverage-command.js'
 
-export const createCoverageCommand = program => {
-  const coverageCommand = program
+export const createCoverageCommand = program =>
+  program
     .createCommand('coverage')
     .description(
       'Provides code coverage analysis, including organizing coverage reports by code owners and generating team-specific reports'
     )
-
-  createGroupCoverageByCodeownersCommand(coverageCommand)
-  createGenerateTeamCoverageCommand(coverageCommand)
-
-  return coverageCommand
-}
+    .addCommand(createGroupCoverageByCodeownersCommand(program))
+    .addCommand(createGenerateTeamCoverageCommand(program))