Add support for different version formats when using regexp (#60)

* add support for variant version formats along with regexp

* Per PR comments, added VariantKey enum, updated to use key instead of if block, applied deno fmt

* added missing variant.ts file

* update unit tests

Author: rslayman

.editorconfig

@@ -0,0 +1,11 @@
+root = true
+
+[*]
+charset = utf-8
+tab_width = 2
+indent_size = 2
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+continuation_indent_size = 4
+trim_trailing_whitespace = true

src/context.ts

@@ -1,4 +1,5 @@
 import { patch, regexp, replace } from "./hooks/mod.ts";
+import { VariantKey } from "./util/variant.ts";
 
 export interface IContext {
   output?: string;
@@ -16,6 +17,7 @@ export interface IContext {
       current: string,
       pattern: string,
       flags?: string,
+      variant?: VariantKey,
     ) => Promise<void>;
   };
 }

src/hooks/hooks.interfaces.ts

@@ -1,3 +1,5 @@
+import { VariantKey } from "../util/variant.ts";
+
 export enum PostHookKind {
   Replace = "replace",
   Patch = "patch",
@@ -17,6 +19,7 @@ export type RegExpPostHook = {
   file: string;
   pattern: string;
   flags?: string;
+  variant?: VariantKey;
 };
 
 export type PostHook =

src/hooks/post.ts

@@ -42,6 +42,7 @@ export async function postVersionHook(
             current,
             hook.pattern,
             hook.flags,
+            hook.variant,
           );
           break;
         default:

src/hooks/regexp.ts

@@ -1,14 +1,20 @@
+import { variantByKey } from "../util/version.ts";
+import { VariantKey } from "../util/variant.ts";
+
 export async function regexp(
   file: string,
   current: string,
   pattern: string,
   flags?: string,
+  variant?: VariantKey,
 ) {
   const regexp = new RegExp(pattern, flags);
   const contents = await Deno.readTextFile(file);
   const match = contents.match(regexp);
-  const updated = contents.replace(regexp, current);
-
-  console.log(`replacing [${match?.[0] || ""}] -> ${current} in ${file}`);
+  const applicableVersion = variantByKey(current, variant);
+  console.log(
+    `replacing [${match?.[0] || ""}] -> ${applicableVersion} in ${file}`,
+  );
+  const updated = contents.replace(regexp, applicableVersion);
   await Deno.writeTextFile(file, updated);
 }

src/util/variant.ts

@@ -0,0 +1,5 @@
+export enum VariantKey {
+  Default = "version_default",
+  Dotnet = "version_dotnet",
+  Docker = "version_docker",
+}

src/util/version.test.ts

@@ -151,7 +151,7 @@ Deno.test({
     const appendTextFile = stub(
       Deno,
       "writeTextFile",
-      resolvesNext(new Array(8)),
+      resolvesNext(new Array(9)),
     );
     try {
       const version = parse("1.2.3-pre.0+1");
@@ -201,11 +201,18 @@ Deno.test({
       assertSpyCall(appendTextFile, 6, {
         args: [
           "/test/output",
-          "version_dotnet=1.2.3-pre.0-1\n",
+          "version_default=1.2.3-pre.0+1\n",
           { create: true, append: true },
         ],
       });
       assertSpyCall(appendTextFile, 7, {
+        args: [
+          "/test/output",
+          "version_dotnet=1.2.3-pre.0-1\n",
+          { create: true, append: true },
+        ],
+      });
+      assertSpyCall(appendTextFile, 8, {
         args: [
           "/test/output",
           "version_docker=1.2.3-pre.0-1\n",

src/util/version.ts

@@ -1,6 +1,7 @@
 import { path } from "../../deps/std.ts";
 import { format, parse, SemVer } from "../../deps/semver.ts";
 import { IContext } from "../context.ts";
+import { VariantKey } from "./variant.ts";
 
 export const DEFAULT_VERSION = parse("0.1.0");
 
@@ -58,11 +59,19 @@ export function variants(version: string) {
   const kabobBuild = version.replace(/[+]/g, "-");
   // todo: add any other platform specific variants here.
   return {
+    version_default: version,
     version_dotnet: kabobBuild,
     version_docker: kabobBuild,
   };
 }
 
+export function variantByKey(
+  version: string,
+  variantKey: VariantKey = VariantKey.Default,
+) {
+  return variants(version)[variantKey];
+}
+
 /**
  * This reads the current version file found at $CWD/VERSION and parses it as a
  * valid SemVer. If the file is not found, is empty, or contains an invalid

test/dotnet/VERSION

@@ -1 +1 @@
-0.1.0
+0.4.0-lambda.2+ghi.789

test/dotnet/example.csproj

@@ -4,7 +4,7 @@
     <TargetFramework>net7.0</TargetFramework>
     <Nullable>enable</Nullable>
     <PackageId>example</PackageId>
-    <Version>0.1.0</Version>
+    <Version>0.4.0-lambda.2-ghi.789</Version>
     <Authors>Justin Chase</Authors>
     <Company>Optum</Company>
     <PackageOutputPath>./nupkg</PackageOutputPath>