feat: add --peek flag

closes #8

packages/monorepo-release/src/analyze.ts

@@ -8,6 +8,7 @@ import gitLog from "git-log-parser"
 import streamToArray from "stream-to-array"
 import { type Package, getPackages } from "@manypkg/get-packages"
 import { getDependentsGraph } from "@changesets/get-dependents-graph"
+import { exit } from "./index.js"
 
 export async function analyze(config: Config): Promise<PackageToRelease[]> {
 	const { BREAKING_COMMIT_MSG, RELEASE_COMMIT_MSG, RELEASE_COMMIT_TYPES } =
@@ -62,14 +63,14 @@ export async function analyze(config: Config): Promise<PackageToRelease[]> {
 	)
 	log.debug(
 		"Analyzing the following commits:",
-		commitsSinceLatestTag.map((c) => `  ${c.subject}`).join("\n"),
+		...commitsSinceLatestTag.map((c) => `  ${c.subject}`),
 	)
 
 	const lastCommit = commitsSinceLatestTag[0]
 
 	if (lastCommit?.parsed.raw === RELEASE_COMMIT_MSG) {
 		log.debug("Already released.")
-		process.exit(0)
+		exit()
 	}
 
 	log.debug("Identifying commits that modified package code.")
@@ -168,7 +169,7 @@ export async function analyze(config: Config): Promise<PackageToRelease[]> {
 		)
 	} else {
 		log.info("No need to release, exiting.")
-		process.exit(0)
+		exit()
 	}
 
 	const packagesToRelease: Map<string, PackageToRelease> = new Map()
@@ -209,7 +210,19 @@ export async function analyze(config: Config): Promise<PackageToRelease[]> {
 			)
 	}
 
-	return Array.from(packagesToRelease.values())
+	const result = Array.from(packagesToRelease.values())
+
+	if (config.peek) {
+		log.peekInfo(
+			"Following packages can be released:\n",
+			...result.map(
+				(p) => `  - ${bold(p.name)}: ${p.oldVersion} -> ${p.newVersion}`,
+			),
+		)
+		exit()
+	}
+
+	return result
 }
 
 function addToPackagesToRelease(

packages/monorepo-release/src/config.ts

@@ -8,6 +8,7 @@ export interface Config {
 	noVerify: boolean
 	dryRun: boolean
 	verbose: boolean
+	peek: boolean
 }
 
 const json = await pkgJson.read("./")
@@ -23,5 +24,6 @@ export const defaultConfig: Config = {
 		!!process.env.DRY_RUN ||
 		process.argv.includes("--dry-run"),
 	verbose: !!process.env.VERBOSE || process.argv.includes("--verbose"),
+	peek: !!process.env.PEEK || process.argv.includes("--peek"),
 	...json.release,
 }

packages/monorepo-release/src/index.ts

@@ -3,24 +3,29 @@ import { shouldSkip } from "./skip.js"
 import { analyze } from "./analyze.js"
 import { publish } from "./publish.js"
 import { log } from "./utils.js"
-import { bold, green } from "yoctocolors"
+import { bold } from "yoctocolors"
 
 const userConfig = {} // TODO: Allow user config
 const config = { ...defaultConfig, ...userConfig }
 
-console.time(green(bold("Done")))
+const endMsg = bold("Done")
+
+console.time(endMsg)
+export function exit() {
+	console.log()
+	console.timeEnd(endMsg)
+	process.exit(0)
+}
 
 if (config.dryRun) {
-	log.info(bold(green("Performing dry run, no packages will be released!\n")))
+	log.peekInfo(bold("Performing dry run, no packages will be released!\n"))
 } else {
-	log.info(bold(green("Let's release some packages!\n")))
+	log.info(bold("Let's release some packages!\n"))
 }
 
 log.debug("Configuration:", JSON.stringify(config, null, 2))
 
-if (shouldSkip({ releaseBranches: config.releaseBranches })) {
-	process.exit(0)
-}
+if (shouldSkip({ releaseBranches: config.releaseBranches })) exit()
 
 if (config.dryRun) {
 	log.debug("Dry run, skipping token validation...")

packages/monorepo-release/src/publish.ts

@@ -1,8 +1,9 @@
-import { bold, green } from "yoctocolors"
+import { bold } from "yoctocolors"
 import { type Config } from "./config.js"
 import type { Commit, PackageToRelease } from "./types.js"
 
 import { log, pkgJson, execSync } from "./utils.js"
+import { exit } from "./index.js"
 
 /** Make sure that packages that depend on other packages are released last. */
 async function sortByDependency(pkgs: PackageToRelease[]) {
@@ -91,7 +92,7 @@ export async function publish(packages: PackageToRelease[], options: Config) {
 		execSync(`git push`)
 	}
 
-	console.timeEnd(green(bold("Done")))
+	exit()
 }
 
 function createChangelog(pkg: PackageToRelease) {

packages/monorepo-release/src/utils.ts

@@ -43,8 +43,13 @@ export const log = {
 		console.log(gray("[debug]"), `${first}\n${rest.join("\n")}`.trim())
 	},
 	info(...args) {
+		if (defaultConfig.peek) return
 		console.log(blue("[info]"), ...purpleNumber(args))
 	},
+	/** Runs even if `config.peek` is set */
+	peekInfo(...args) {
+		console.log(args.join("\n"))
+	},
 	error(error: Error) {
 		console.error(red("\n[error]"), error, "\n")
 	},