Refactored NormalizedOptions to be an interface instead of a class

Author: JamesMessinger

src/get-new-version.ts

@@ -1,10 +1,10 @@
 import * as inquirer from "inquirer";
 import * as semver from "semver";
 import { ReleaseType, SemVer } from "semver"; // tslint:disable-line: no-duplicate-imports
-import { Options } from "./options";
+import { NormalizedOptions } from "./normalize-options";
 import { isPrerelease, isReleaseType, releaseTypes } from "./release-type";
 
-type Params = Options & { oldVersion: string };
+type Params = NormalizedOptions & { oldVersion: string };
 type VersionAndReleaseType = [string, ReleaseType?];
 
 /**

src/get-old-version.ts

@@ -1,13 +1,13 @@
 import * as semver from "semver";
 import { readJsonFile } from "./fs";
 import { isManifest } from "./manifest";
-import { Options } from "./options";
+import { NormalizedOptions } from "./normalize-options";
 
 /**
  * Returns the current version number from files such as package.json.
  * An error is thrown if no version number can be found.
  */
-export async function getOldVersion({ files, cwd }: Options): Promise<string> {
+export async function getOldVersion({ files, cwd }: NormalizedOptions): Promise<string> {
   // Check all JSON files in the files list
   let filesToCheck = files.filter((file) => file.endsWith(".json"));
 

src/git.ts

@@ -1,7 +1,7 @@
 import * as ezSpawn from "ez-spawn";
-import { Options } from "./options";
+import { NormalizedOptions } from "./normalize-options";
 
-type Params = Options & { files: string[]; newVersion: string };
+type Params = NormalizedOptions & { files: string[]; newVersion: string };
 
 /**
  * Commits the modififed files to Git, if the `commit` option is enabled.
@@ -69,7 +69,7 @@ export async function gitTag({ commit, tag, newVersion }: Params): Promise<strin
 /**
  * Pushes the Git commit and tag, if the `push` option is enabled.
  */
-export async function gitPush({ push, tag }: Options): Promise<void> {
+export async function gitPush({ push, tag }: NormalizedOptions): Promise<void> {
   if (!push) {
     return;
   }

src/normalize-options.ts

@@ -0,0 +1,106 @@
+import * as globby from "globby";
+import { isReleaseType, ReleaseType } from "./release-type";
+import { VersionBumpOptions } from "./version-bump-options";
+
+interface Interface {
+  input?: NodeJS.ReadableStream | NodeJS.ReadStream | false;
+  output?: NodeJS.WritableStream | NodeJS.WriteStream | false;
+  [key: string]: unknown;
+}
+
+type Release = "prompt" | ReleaseType | { version: string };
+
+/**
+ * Normalized and sanitized options
+ */
+export interface NormalizedOptions {
+  release: Release;
+  preid: string;
+  commit?: {
+    message: string;
+    noVerify: boolean;
+    all: boolean;
+  };
+  tag?: {
+    name: string;
+  };
+  push: boolean;
+  files: string[];
+  cwd: string;
+  interface: Interface;
+}
+
+/**
+ * Converts raw VersionBumpOptions to a normalized and sanitized Options object.
+ */
+export async function normalizeOptions(raw: VersionBumpOptions): Promise<NormalizedOptions> {
+  // Set the simple properties first
+  let preid = typeof raw.preid === "string" ? raw.preid : "beta";
+  let push = Boolean(raw.push);
+  let all = Boolean(raw.all);
+  let noVerify = Boolean(raw.noVerify);
+  let cwd = raw.cwd || process.cwd();
+
+  let release: Release;
+  if (!raw.release || raw.release === "prompt") {
+    release = "prompt";
+  }
+  else if (isReleaseType(raw.release)) {
+    release = raw.release;
+  }
+  else {
+    release = { version: raw.release };
+  }
+
+  let tag;
+  if (typeof raw.tag === "string") {
+    tag = { name: raw.tag };
+  }
+  else if (raw.tag) {
+    tag = { name: "v" };
+  }
+
+  // NOTE: This must come AFTER `tag` and `push`, because it relies on them
+  let commit;
+  if (typeof raw.commit === "string") {
+    commit = { all, noVerify, message: raw.commit };
+  }
+  else if (raw.commit || tag || push) {
+    commit = { all, noVerify, message: "release v" };
+  }
+
+  let files;
+  if (Array.isArray(raw.files) && raw.files.length > 0) {
+    files = await globby(raw.files, { cwd });
+  }
+  else {
+    files = ["package.json", "package-lock.json"];
+  }
+
+  let ui: Interface;
+  if (raw.interface === false) {
+    ui = { input: false, outut: false };
+  }
+  else if (raw.interface === true || !raw.interface) {
+    ui = { input: process.stdin, output: process.stdout };
+  }
+  else {
+    let { input, output, ...other } = raw.interface;
+
+    if (input === true || (input !== false && !input)) {
+      input = process.stdin;
+    }
+
+    if (output === true || (output !== false && !output)) {
+      output = process.stdout;
+    }
+
+    ui = { input, output, ...other };
+  }
+
+  if (release === "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 };
+}

src/options.ts

@@ -1,9 +1,9 @@
 import * as path from "path";
 import { readJsonFile, readTextFile, writeJsonFile, writeTextFile } from "./fs";
 import { isManifest } from "./manifest";
-import { Options } from "./options";
+import { NormalizedOptions } from "./normalize-options";
 
-type Params = Options & { oldVersion: string; newVersion: string };
+type Params = NormalizedOptions & { oldVersion: string; newVersion: string };
 type FileParams = Params & { name: string };
 
 /**

src/update-files.ts

@@ -1,7 +1,7 @@
 import { getNewVersion } from "./get-new-version";
 import { getOldVersion } from "./get-old-version";
 import { gitCommit, gitPush, gitTag } from "./git";
-import { Options } from "./options";
+import { normalizeOptions } from "./normalize-options";
 import { updateFiles } from "./update-files";
 import { VersionBumpOptions } from "./version-bump-options";
 import { VersionBumpResults } from "./version-bump-results";
@@ -41,7 +41,7 @@ export async function versionBump(arg: VersionBumpOptions | string = {}): Promis
   }
 
   // Validate and normalize the options
-  let options = await Options.normalize(arg);
+  let options = await normalizeOptions(arg);
 
   // Get the old and new version numbers
   let oldVersion = await getOldVersion(options);