Refactored the NormalizedOptions.release type to be more explicit

Author: JamesMessinger

src/get-new-version.ts

@@ -1,8 +1,8 @@
 import * as inquirer from "inquirer";
 import * as semver from "semver";
 import { ReleaseType, SemVer } from "semver"; // tslint:disable-line: no-duplicate-imports
-import { NormalizedOptions } from "./normalize-options";
-import { isPrerelease, isReleaseType, releaseTypes } from "./release-type";
+import { BumpRelease, NormalizedOptions } from "./normalize-options";
+import { isPrerelease, releaseTypes } from "./release-type";
 
 type Params = NormalizedOptions & { oldVersion: string };
 type VersionAndReleaseType = [string, ReleaseType?];
@@ -15,29 +15,32 @@ type VersionAndReleaseType = [string, ReleaseType?];
 export async function getNewVersion(params: Params): Promise<VersionAndReleaseType> {
   let { release } = params;
 
-  if (release === "prompt") {
-    return promptForNewVersion(params);
-  }
-  else if (isReleaseType(release)) {
-    return [getNextVersion(params), release];
-  }
-  else {
-    let newSemVer = new SemVer(release.version, true);
-    return [newSemVer.version];
+  switch (release.type) {
+    case "prompt":
+      return promptForNewVersion(params);
+
+    case "version":
+      let newSemVer = new SemVer(release.version, true);
+      return [newSemVer.version];
+
+    default:
+      return [getNextVersion(params), release.type];
   }
 }
 
 /**
  * Returns the next version number of the specified type.
  */
-function getNextVersion({ oldVersion, release, preid }: Params): string {
+function getNextVersion({ oldVersion, release }: Params): string {
+  let bump = release as BumpRelease;
+
   let oldSemVer = new SemVer(oldVersion);
-  let newSemVer = oldSemVer.inc(release as ReleaseType, preid);
+  let newSemVer = oldSemVer.inc(bump.type as ReleaseType, bump.preid);
 
   if (
     isPrerelease(release) &&
     newSemVer.prerelease.length === 2 &&
-    newSemVer.prerelease[0] === preid &&
+    newSemVer.prerelease[0] === bump.preid &&
     String(newSemVer.prerelease[1]) === "0"
   ) {
     // This is a special case when going from a non-prerelease version to a prerelease version.
@@ -54,10 +57,11 @@ function getNextVersion({ oldVersion, release, preid }: Params): string {
  * Returns the next version number for all release types.
  */
 function getNextVersions(params: Params): Record<ReleaseType, string> {
+  let release = params.release as BumpRelease;
   let next: Record<string, string> = {};
 
-  for (let release of releaseTypes) {
-    next[release] = getNextVersion({ ...params, release });
+  for (let type of releaseTypes) {
+    next[type] = getNextVersion({ ...params, release: { ...release, type }});
   }
 
   return next;

src/normalize-options.ts

@@ -8,14 +8,32 @@ interface Interface {
   [key: string]: unknown;
 }
 
-type Release = "prompt" | ReleaseType | { version: string };
+/**
+ * A specific version release.
+ */
+export interface VersionRelease {
+  type: "version";
+  version: string;
+}
+
+/**
+ * A bump release (prompted or otherwise), relative to the current version number.
+ */
+export interface BumpRelease {
+  type: "prompt" | ReleaseType;
+  preid: string;
+}
+
+/**
+ * One of the possible Release types.
+ */
+export type Release = VersionRelease | BumpRelease;
 
 /**
  * Normalized and sanitized options
  */
 export interface NormalizedOptions {
   release: Release;
-  preid: string;
   commit?: {
     message: string;
     noVerify: boolean;
@@ -43,13 +61,13 @@ export async function normalizeOptions(raw: VersionBumpOptions): Promise<Normali
 
   let release: Release;
   if (!raw.release || raw.release === "prompt") {
-    release = "prompt";
+    release = { type: "prompt", preid };
   }
   else if (isReleaseType(raw.release)) {
-    release = raw.release;
+    release = { type: raw.release, preid };
   }
   else {
-    release = { version: raw.release };
+    release = { type: "version", version: raw.release };
   }
 
   let tag;
@@ -98,9 +116,9 @@ export async function normalizeOptions(raw: VersionBumpOptions): Promise<Normali
     ui = { input, output, ...other };
   }
 
-  if (release === "prompt" && !(ui.input && ui.output)) {
+  if (release.type === "prompt" && !(ui.input && ui.output)) {
     throw new Error(`Cannot prompt for the version number because input or output has been disabled.`);
   }
 
-  return { release, preid, commit, tag, push, files, cwd, interface: ui };
+  return { release, commit, tag, push, files, cwd, interface: ui };
 }