@toptal/davinci-monorepo 8.1.4-alpha-CRT-5891-create-coverage-command-23386c1d.2 → 8.1.4-alpha-CRT-5891-create-coverage-command-c72932eb.4

package/bin/davinci-monorepo.js

@@ -7,7 +7,7 @@ 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 { coverageCommand } from '../src/commands/coverage.js'
+import { coverageCommand } from '../src/commands/coverage-command/index.js'
 
 cliEngine.loadCommands(
   [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toptal/davinci-monorepo",
-  "version": "8.1.4-alpha-CRT-5891-create-coverage-command-23386c1d.2+23386c1d",
+  "version": "8.1.4-alpha-CRT-5891-create-coverage-command-c72932eb.4+c72932eb",
   "description": "Monorepo utility tools",
   "publishConfig": {
     "access": "public"
@@ -35,13 +35,15 @@
   "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-23386c1d.34+23386c1d",
+    "@toptal/davinci-cli-shared": "2.3.1-alpha-CRT-5891-create-coverage-command-c72932eb.36+c72932eb",
     "chalk": "^4.1.2",
     "codeowners": "5.1.1",
+    "commander": "^10.0.0",
     "dependency-cruiser": "^12.5.0",
     "ervy": "^1.0.7",
     "execa": "^5.1.1",
     "find-up": "5.0.0",
+    "find-yarn-workspace-root": "^2.0.0",
     "glob": "^8.0.3",
     "ignore": "^5.2.0",
     "is-directory": "^0.3.1",
@@ -53,5 +55,5 @@
   "devDependencies": {
     "@jest/globals": "^29.4.2"
   },
-  "gitHead": "23386c1d709c03d921ae81f6e8ede8bbaccd64aa"
+  "gitHead": "c72932ebed3392a4ffb196fb2e6a21b9c5e8c3f1"
 }

package/src/commands/codeowners/core/codeowners/codeowners.js

@@ -62,9 +62,6 @@ Codeowners.prototype.getOwner =
    * @param {string} filePath
    */
   function getOwner(filePath) {
-    console.log({ filePath })
-    console.log({ entries: this.ownerEntries })
-
     for (const entry of this.ownerEntries) {
       if (entry.match(filePath)) {
         return entry.usernames

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

@@ -0,0 +1,3 @@
+export const JEST_COVERAGE_PATH = 'coverage/jest'
+export const CYPRESS_COVERAGE_PATH = 'coverage/cypress'
+export const TEAMS_COVERAGE_PATH = 'coverage/teams'

package/src/commands/{generate-team-coverage.js → coverage-command/generate-team-coverage.js}

@@ -1,24 +1,28 @@
 import path from 'path'
-import * as url from 'url'
 import execa from 'execa'
 import fs from 'fs'
 import { print } from '@toptal/davinci-cli-shared'
+import getWorkspaceRoot from 'find-yarn-workspace-root'
 
-import Codeowners from './codeowners/core/codeowners/codeowners.js'
+// eslint-disable-next-line no-restricted-syntax
+import Codeowners from '../codeowners/core/codeowners/codeowners.js'
+import { sanitizeTeamName } from './services/sanitize-team-name/sanitize-team-name.js'
+import {
+  CYPRESS_COVERAGE_PATH,
+  JEST_COVERAGE_PATH,
+  TEAMS_COVERAGE_PATH,
+} from './config.js'
 
-const __dirname = url.fileURLToPath(new URL('.', import.meta.url))
-const rootProjectPath = path.join(__dirname, '../../')
-
-const sanitizeTeamName = team => team.replace('/', '-').replace('@', '')
+const workspaceRoot = getWorkspaceRoot()
 
 const sanitizeNycPercentage = percentage =>
   percentage === 'Unknown' ? 0 : percentage
 
 // eslint-disable-next-line max-statements
 const generateTeamCoverage = async options => {
-  print.header('generateTeamCoverage')
+  print.header('Generating team coverage')
 
-  const codeowners = new Codeowners(rootProjectPath)
+  const codeowners = new Codeowners(workspaceRoot)
 
   const ownerEntries = codeowners.ownerEntries
   const uniqueTeams = ownerEntries
@@ -26,43 +30,40 @@ const generateTeamCoverage = async options => {
     // eslint-disable-next-line id-length
     .filter((v, i, a) => a.indexOf(v) === i)
 
-  // eslint-disable-next-line no-console
-  console.log('Teams:', uniqueTeams)
+  print.grey('Teams: ', uniqueTeams)
 
   const teams = uniqueTeams
 
-  await execa.command(`rm -rf coverage/teams`)
-  await execa.command(`mkdir coverage/teams`)
+  await execa.command(`rm -rf ${TEAMS_COVERAGE_PATH}`)
+  await execa.command(`mkdir ${TEAMS_COVERAGE_PATH}`)
 
   for await (const team of teams) {
     const sanitizedTeam = sanitizeTeamName(team)
+    const sanitizedTeamPath = path.join(TEAMS_COVERAGE_PATH, sanitizedTeam)
 
-    await execa.command(`mkdir coverage/teams/${sanitizedTeam}`)
-    await execa.command(`mkdir coverage/teams/${sanitizedTeam}/jest`)
-    await execa.command(`mkdir coverage/teams/${sanitizedTeam}/cypress`)
+    await execa.command(`mkdir ${sanitizedTeamPath}`)
+    await execa.command(`mkdir ${sanitizedTeamPath}/jest`)
+    await execa.command(`mkdir ${sanitizedTeamPath}/cypress`)
   }
 
   for await (const team of teams) {
-    // eslint-disable-next-line no-console
-    console.log('Team coverage:', team)
+    print.gray('Team coverage: ', team)
 
     const sanitizedTeam = sanitizeTeamName(team)
+    const sanitizedTeamPath = path.join(TEAMS_COVERAGE_PATH, sanitizedTeam)
 
     await execa.command(
-      `cp coverage/jest/coverage-final-${sanitizedTeam}.json coverage/teams/${sanitizedTeam}/jest/coverage-final.json`
+      `cp ${JEST_COVERAGE_PATH}/coverage-final-${sanitizedTeam}.json ${sanitizedTeamPath}/jest/coverage-final.json`
     )
-
-    // TODO add nyc as deps?
     await execa.command(
-      `yarn nyc report --temp-dir coverage/teams/${sanitizedTeam}/jest --reporter json-summary --reporter html --report-dir coverage/teams/${sanitizedTeam}/jest`
+      `yarn nyc report --temp-dir ${sanitizedTeamPath}/jest --reporter json-summary --reporter html --report-dir ${sanitizedTeamPath}/jest`
     )
 
     await execa.command(
-      `cp coverage/cypress/coverage-final-${sanitizedTeam}.json coverage/teams/${sanitizedTeam}/cypress/coverage-final.json`
+      `cp ${CYPRESS_COVERAGE_PATH}/coverage-final-${sanitizedTeam}.json ${sanitizedTeamPath}/cypress/coverage-final.json`
     )
-
     await execa.command(
-      `yarn nyc report --temp-dir coverage/teams/${sanitizedTeam}/cypress --reporter json-summary --reporter html --report-dir coverage/teams/${sanitizedTeam}/cypress`
+      `yarn nyc report --temp-dir ${sanitizedTeamPath}/cypress --reporter json-summary --reporter html --report-dir ${sanitizedTeamPath}/cypress`
     )
   }
 
@@ -71,6 +72,8 @@ const generateTeamCoverage = async options => {
 
   for await (const team of teams) {
     const sanitizedTeam = sanitizeTeamName(team)
+    const sanitizedTeamPath = path.join(TEAMS_COVERAGE_PATH, sanitizedTeam)
+
     const result = {
       created_at,
       team,
@@ -78,10 +81,7 @@ const generateTeamCoverage = async options => {
     }
 
     const jestCoverageSummary = JSON.parse(
-      fs.readFileSync(
-        `coverage/teams/${sanitizedTeam}/jest/coverage-summary.json`,
-        'utf8'
-      )
+      fs.readFileSync(`${sanitizedTeamPath}/jest/coverage-summary.json`, 'utf8')
     )
 
     result.jest_lines_coverage = sanitizeNycPercentage(
@@ -99,7 +99,7 @@ const generateTeamCoverage = async options => {
 
     const cypressCoverageSummary = JSON.parse(
       fs.readFileSync(
-        `coverage/teams/${sanitizedTeam}/cypress/coverage-summary.json`,
+        `${sanitizedTeamPath}/cypress/coverage-summary.json`,
         'utf8'
       )
     )
@@ -120,21 +120,19 @@ const generateTeamCoverage = async options => {
     results.push(result)
   }
 
-  fs.writeFileSync(
-    'team-tests-coverage-results.json',
-    JSON.stringify(results, null, 2)
-  )
+  fs.writeFileSync(options.outputFileName, JSON.stringify(results, null, 2))
 }
 
-export const generateTeamCoverageCommand = program => {
-  print.header('generateTeamCoverageCommand')
-
-  return program
+export const generateTeamCoverageCommand = program =>
+  program
     .command('generate-team-coverage')
     .description('TODO: generate-team-coverage')
     .requiredOption(
       '-r, --repository <repository_name>',
       'specify repository name'
     )
-    .action(options => generateTeamCoverage(options))
-}
+    .requiredOption(
+      '-o, --output-file-name <output_file_name>',
+      'specify output file name'
+    )
+    .action(generateTeamCoverage)

package/src/commands/{group-coverage-by-codeowners.js → coverage-command/group-coverage-by-codeowners.js}

@@ -1,17 +1,20 @@
 import path from 'path'
 import fs from 'fs'
-import * as url from 'url'
 import { print } from '@toptal/davinci-cli-shared'
+import getWorkspaceRoot from 'find-yarn-workspace-root'
 
-import Codeowners from './codeowners/core/codeowners/codeowners.js'
+// eslint-disable-next-line no-restricted-syntax
+import Codeowners from '../codeowners/core/codeowners/codeowners.js'
+import { CYPRESS_COVERAGE_PATH, JEST_COVERAGE_PATH } from './config.js'
+import { sanitizeTeamName } from './services/sanitize-team-name/sanitize-team-name.js'
 
-const __dirname = url.fileURLToPath(new URL('.', import.meta.url))
-const rootProjectPath = path.join(__dirname, '../../')
+const workspaceRoot = getWorkspaceRoot()
 
 const readJestCoverageReport = () => {
   const jestCoverageReportPath = path.join(
-    rootProjectPath,
-    'coverage/jest/coverage-final-jest.json'
+    workspaceRoot,
+    JEST_COVERAGE_PATH,
+    'coverage-final-jest.json'
   )
 
   const data = fs.readFileSync(jestCoverageReportPath, 'utf8')
@@ -21,8 +24,9 @@ const readJestCoverageReport = () => {
 
 const readCypressCoverageReport = () => {
   const cypressCoverageReportPath = path.join(
-    rootProjectPath,
-    'coverage/cypress/coverage-final-cypress.json'
+    workspaceRoot,
+    CYPRESS_COVERAGE_PATH,
+    'coverage-final-cypress.json'
   )
 
   const data = fs.readFileSync(cypressCoverageReportPath, 'utf8')
@@ -30,16 +34,19 @@ const readCypressCoverageReport = () => {
   return JSON.parse(data)
 }
 
-const sanitizeTeamName = team => team.replace('/', '-').replace('@', '')
-
-const splitReportIntoTeams = (reportObj, teams, codeowners, coveragePath) => {
+const splitReportIntoTeams = ({
+  reportObj,
+  teams,
+  codeowners,
+  coveragePath,
+}) => {
   const teamsReport = {}
 
   Object.entries(reportObj).forEach(([reportPathKey, report]) => {
     const file = report.path
-    const relativePath = path.relative(rootProjectPath, file)
+    const relativeWorkspacePath = path.relative(workspaceRoot, file)
 
-    const owners = codeowners.getOwner(relativePath)
+    const owners = codeowners.getOwner(relativeWorkspacePath)
 
     owners.forEach(owner => {
       teamsReport[owner] = {
@@ -54,8 +61,9 @@ const splitReportIntoTeams = (reportObj, teams, codeowners, coveragePath) => {
     const sanitizedTeamPath = sanitizeTeamName(team)
 
     const reportPath = path.join(
-      rootProjectPath,
-      `${coveragePath}/coverage-final-${sanitizedTeamPath}.json`
+      workspaceRoot,
+      coveragePath,
+      `coverage-final-${sanitizedTeamPath}.json`
     )
 
     fs.writeFileSync(reportPath, JSON.stringify(teamReport, null, 2))
@@ -69,34 +77,36 @@ const getAllTeams = codeowners => {
     // eslint-disable-next-line id-length
     .filter((v, i, a) => a.indexOf(v) === i)
 
-  // eslint-disable-next-line no-console
-  console.log('Teams:', uniqueTeams)
+  print.gray('Teams: ', uniqueTeams)
 
   return uniqueTeams
 }
 
 const groupCoverageByCodeowners = async () => {
-  print.header('groupCoverageByCodeowners')
+  print.header('Grouping coverage by codeowners')
 
   const jestReport = readJestCoverageReport()
   const cypressReport = readCypressCoverageReport()
 
-  const codeowners = new Codeowners(rootProjectPath)
+  const codeowners = new Codeowners(workspaceRoot)
   const teams = getAllTeams(codeowners)
 
-  splitReportIntoTeams(jestReport, teams, codeowners, 'coverage/jest')
-  splitReportIntoTeams(cypressReport, teams, codeowners, 'coverage/cypress')
+  splitReportIntoTeams({
+    report: jestReport,
+    teams,
+    codeowners,
+    coveragePath: JEST_COVERAGE_PATH,
+  })
+  splitReportIntoTeams({
+    report: cypressReport,
+    teams,
+    codeowners,
+    coveragePath: CYPRESS_COVERAGE_PATH,
+  })
 }
 
-export const groupCoverageByCodeownersCommand = program => {
-  print.header('groupCoverageByCodeownersCommand')
-
-  return program
+export const groupCoverageByCodeownersCommand = program =>
+  program
     .command('group-coverage-by-codeowners')
     .description('TODO: group-coverage-by-codeowners')
-    .requiredOption(
-      '-r, --repository <repository_name>',
-      'specify repository name'
-    )
     .action(groupCoverageByCodeowners)
-}

package/src/commands/coverage-command/services/sanitize-team-name/sanitize-team-name.js

@@ -0,0 +1 @@
+export const sanitizeTeamName = team => team.replace('/', '-').replace('@', '')

package/src/index.js

@@ -2,7 +2,7 @@ import detectCircularityCommandCreator from './commands/detect-circularity.js'
 import metricsCommandCreator from './commands/metrics.js'
 import { createGraphGenerateCommand } from './commands/graph-generate.js'
 import codeownersCommand from './commands/codeowners/index.js'
-import { coverageCommand } from './commands/coverage.js'
+import { coverageCommand } from './commands/coverage-command/index.js'
 import checkIfMonorepo from './utils/check-if-monorepo.js'
 import getPackages from './utils/get-packages.js'
 

package/src/commands/{coverage.js → coverage-command/index.js}

@@ -4,8 +4,8 @@ import { groupCoverageByCodeownersCommand } from './group-coverage-by-codeowners
 export const coverageCommand = program => {
   const coverage = program.createCommand('coverage').description('TODO ..')
 
-  generateTeamCoverageCommand(coverage)
   groupCoverageByCodeownersCommand(coverage)
+  generateTeamCoverageCommand(coverage)
 
   return coverage
 }