refactor: consolidate reporter into one helper

Author: geotrev

bin/helpers/cmd.js

@@ -1,15 +1,17 @@
 import { exec } from "./exec-promise.js"
-import { reporter as defaultReporter, exitWithError } from "./reporter.js"
+import { report, exitWithError } from "./reporter.js"
+
+export async function cmd(command, config, indent = false) {
+  const info = { m: command, type: "info", indent }
 
-export async function cmd(command, config, reporter = defaultReporter) {
   if (config.dryRun) {
     if (config.verbose) {
-      reporter.info(command)
+      report(info)
     }
   } else {
     try {
       if (config.verbose) {
-        reporter.info(command)
+        report(info)
       }
 
       await exec(command)
@@ -19,10 +21,10 @@ export async function cmd(command, config, reporter = defaultReporter) {
   }
 }
 
-export async function reportCmd(command, config, reporter = defaultReporter) {
-  reporter.start(config.step)
+export async function reportCmd(command, config, indent = false) {
+  report({ m: config.step, type: "start", indent })
 
-  await cmd(command, config, reporter)
+  await cmd(command, config, indent)
 
-  reporter.succeed(`${config.step} successful`)
+  report({ m: `${config.step} successful`, type: "succeed", indent })
 }

bin/helpers/git-commands.js bin/helpers/commands.jsbin/helpers/git-commands.js renamed to bin/helpers/commands.js

@@ -13,3 +13,11 @@ export function getPushCmd() {
 export function getAddCommand() {
   return "git add . -u"
 }
+
+export function getPublishCommand(name, tag) {
+  return `npm publish -w ${name} --tag ${tag}`
+}
+
+export function getVersionCommand(name, version) {
+  return `npm version -w ${name} ${version} --no-git-tag-version`
+}

bin/helpers/npm-commands.js

@@ -2,18 +2,22 @@
 
 import ora from "ora"
 
-export const reporter = ora()
-export const pkgReporter = ora({ indent: 4 })
+const reporter = ora()
+const indentReporter = ora({ indent: 4 })
+
+export function report({ m, type = "info", indent = false }) {
+  return indent ? indentReporter[type](m) : reporter[type](m)
+}
 
 function newConsoleLine() {
   /* eslint-disable-next-line no-console */
   console.log("")
 }
 
-export function exitWithError(error, message) {
+export function exitWithError(error, m) {
   newConsoleLine()
   /* eslint-disable-next-line no-console */
   console.error("Error:", error)
-  reporter.fail(message)
+  reporter({ m, type: "fail" })
   process.exit(1)
 }

bin/helpers/reporter.js

@@ -8,10 +8,10 @@ import {
   ROOT_PACKAGE_FILE,
 } from "./constants.js"
 import { cmd } from "./cmd.js"
-import { reporter, exitWithError } from "./reporter.js"
+import { report, exitWithError } from "./reporter.js"
 
 export async function setRootVersion(config) {
-  reporter.start("Update root version")
+  report({ m: "Update root version", type: "start" })
 
   let updatePkg = false,
     updateConfig = false
@@ -48,7 +48,7 @@ export async function setRootVersion(config) {
 
     if (config.dryRun) {
       if (config.verbose) {
-        reporter.info(configCmd)
+        report({ m: configCmd, type: "info" })
       }
     } else {
       try {
@@ -72,7 +72,7 @@ export async function setRootVersion(config) {
 
     if (config.dryRun) {
       if (config.verbose) {
-        reporter.info(packageCmd)
+        report({ m: packageCmd, type: "info" })
       }
     } else {
       try {
@@ -93,5 +93,5 @@ export async function setRootVersion(config) {
   const addChangesCommand = "git add . -u"
   await cmd(addChangesCommand, config)
 
-  reporter.succeed()
+  report({ type: "succeed" })
 }

bin/helpers/set-root-version.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 
 import { ReportSteps } from "../helpers/constants.js"
-import { getCommitCmd, getTagCmd, getPushCmd } from "../helpers/git-commands.js"
+import { getCommitCmd, getTagCmd, getPushCmd } from "../helpers/commands.js"
 import { setVersionToString } from "../helpers/transformers.js"
 import { reportCmd } from "../helpers/cmd.js"
 

bin/modules/commit.js

@@ -2,10 +2,10 @@
 
 import fs from "fs"
 import path from "path"
-import { exitWithError, pkgReporter } from "../helpers/reporter.js"
-import { ROOT_PACKAGE_FILE } from "../helpers/constants.js"
+import { getVersionCommand } from "../helpers/commands.js"
+import { exitWithError, report } from "../helpers/reporter.js"
 import { cmd } from "../helpers/cmd.js"
-import { getVersionCommand } from "../helpers/npm-commands.js"
+import { ROOT_PACKAGE_FILE } from "../helpers/constants.js"
 
 function getSemverRangePart(version) {
   let rangePart = ""
@@ -66,12 +66,12 @@ function setDependencies(config, entry) {
 
     if (config.dryRun) {
       if (config.verbose) {
-        pkgReporter.info(writeCommand)
+        report({ m: writeCommand, type: "info", indent: true })
       }
     } else {
       try {
         if (config.verbose) {
-          pkgReporter.info(writeCommand)
+          report({ m: writeCommand, type: "info", indent: true })
         }
 
         fs.writeFileSync(
@@ -87,15 +87,11 @@ function setDependencies(config, entry) {
 }
 
 export async function runIncrement(config, entry) {
-  pkgReporter.start("Version")
+  report({ m: "Version", type: "start", indent: true })
 
-  await cmd(
-    getVersionCommand(entry.name, config.releaseVersion),
-    config,
-    pkgReporter
-  )
+  await cmd(getVersionCommand(entry.name, config.releaseVersion), config, true)
 
   setDependencies(config, entry)
 
-  pkgReporter.succeed("Version successful")
+  report({ m: "Version successful", type: "succeed", indent: true })
 }

bin/modules/increment.js

@@ -1,9 +1,9 @@
 import { normalizeConfig } from "../helpers/normalize-config.js"
 import { checkUnstaged, checkRefStatus } from "../helpers/git-helpers.js"
-import { reporter } from "../helpers/reporter.js"
+import { report } from "../helpers/reporter.js"
 
 export async function initialize(config) {
-  reporter.start("Preparing to release")
+  report({ m: "Preparing to release", type: "start" })
 
   normalizeConfig(config)
 
@@ -12,5 +12,5 @@ export async function initialize(config) {
     await checkRefStatus(config)
   }
 
-  reporter.succeed("Ready to release!")
+  report({ m: "Ready to release!", type: "succeed" })
 }

bin/modules/initialize.js

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 
-import { reporter } from "../helpers/reporter.js"
+import { report } from "../helpers/reporter.js"
 import { runIncrement } from "./increment.js"
 import { runPublish } from "./publish.js"
 
@@ -12,9 +12,12 @@ export async function runNpm(config) {
     const entry = packages[i]
     const { name } = entry
 
-    reporter.stopAndPersist({
-      text: `${name}@${config.releaseVersion}`,
-      symbol: "📦",
+    report({
+      m: {
+        text: `${name}@${config.releaseVersion}`,
+        symbol: "📦",
+      },
+      type: "stopAndPersist",
     })
 
     if (config.npm.increment) {
@@ -26,5 +29,8 @@ export async function runNpm(config) {
     }
   }
 
-  reporter.succeed("All packages versioned/published without errors")
+  report({
+    m: "All packages versioned/published without errors",
+    type: "succeed",
+  })
 }

bin/modules/npm.js

@@ -1,18 +1,17 @@
 #!/usr/bin/env node
 
 import semver from "semver"
-import { getAddCommand } from "../helpers/git-commands.js"
+import { getAddCommand, getPublishCommand } from "../helpers/commands.js"
 import { cmd } from "../helpers/cmd.js"
-import { pkgReporter } from "../helpers/reporter.js"
-import { getPublishCommand } from "../helpers/npm-commands.js"
+import { report } from "../helpers/reporter.js"
 
 function parsePreId(version) {
   const parts = semver.prerelease(version) || []
   return parts[0]
 }
 
 export async function runPublish(config, entry) {
-  pkgReporter.start("Publish")
+  report({ m: "Publish", type: "start", indent: true })
 
   const isPrivate = entry.getPackage().private
   const tag =
@@ -21,12 +20,12 @@ export async function runPublish(config, entry) {
     parsePreId(config.releaseVersion) ||
     "latest"
 
-  if (!isPrivate) {
-    await cmd(getAddCommand(), config, pkgReporter)
-    await cmd(getPublishCommand(entry.name, tag), config, pkgReporter)
-
-    pkgReporter.succeed("Publish successful")
+  if (isPrivate) {
+    report({ m: "Publish skipped (private)", type: "succeed", indent: true })
   } else {
-    pkgReporter.succeed("Publish skipped (private)")
+    await cmd(getAddCommand(), config, true)
+    await cmd(getPublishCommand(entry.name, tag), config, true)
+
+    report({ m: "Publish successful", type: "succeed", indent: true })
   }
 }