fix(semver): 🐞 add --tagPrefix + deprecate --versionTagPrefix

jscutlery · Feb 17, 2022 · 6c22e4c · 6c22e4c
1 parent 03b743d
commit 6c22e4c
Show file tree

Hide file tree

Showing 8 changed files with 50 additions and 39 deletions.
diff --git a/README.md b/README.md
@@ -75,23 +75,23 @@ nx run workspace:version [....options]
 
 #### Available options
 
-| name                         | type       | default     | description                                      |
-| ---------------------------- | ---------- | ----------- | ------------------------------------------------ |
-| **`--dryRun`**               | `boolean`  | `false`     | run with dry mode                                |
-| **`--noVerify`**             | `boolean`  | `false`     | skip git hooks                                   |
-| **`--push`**                 | `boolean`  | `false`     | push the release against git origin              |
-| **`--syncVersions`**         | `boolean`  | `false`     | lock/sync versions between projects              |
-| **`--skipRootChangelog`**    | `boolean`  | `false`     | skip generating root changelog                   |
-| **`--skipProjectChangelog`** | `boolean`  | `false`     | skip generating project changelog                |
-| **`--origin`**               | `string`   | `'origin'`  | push against git remote repository               |
-| **`--baseBranch`**           | `string`   | `'main'`    | push against git base branch                     |
-| **`--changelogHeader`**      | `string`   | `undefined` | custom Markdown header for changelogs            |
-| **`--releaseAs`**            | `string`   | `undefined` | specify the level of change                      |
-| **`--preid`**                | `string`   | `undefined` | prerelease identifier                            |
-| **`--versionTagPrefix`**     | `string`   | `undefined` | specify the tag prefix                           |
-| **`--postTargets`**          | `string[]` | `[]`        | specify a list of target to execute post-release |
-| **`--trackDeps`**            | `boolean`  | `false`     | use dependencies when calculating a version bump |
-| **`--commitMessageFormat`**  | `string`   | `undefined` | format the auto-generated message commit         |
+| name                         | type            | default     | description                                      |
+| ---------------------------- | --------------- | ----------- | ------------------------------------------------ |
+| **`--dryRun`**               | `boolean`       | `false`     | run with dry mode                                |
+| **`--noVerify`**             | `boolean`       | `false`     | skip git hooks                                   |
+| **`--push`**                 | `boolean`       | `false`     | push the release against git origin              |
+| **`--syncVersions`**         | `boolean`       | `false`     | lock/sync versions between projects              |
+| **`--skipRootChangelog`**    | `boolean`       | `false`     | skip generating root changelog                   |
+| **`--skipProjectChangelog`** | `boolean`       | `false`     | skip generating project changelog                |
+| **`--origin`**               | `string`        | `'origin'`  | push against git remote repository               |
+| **`--baseBranch`**           | `string`        | `'main'`    | push against git base branch                     |
+| **`--changelogHeader`**      | `string`        | `undefined` | custom Markdown header for changelogs            |
+| **`--releaseAs`**            | `string`        | `undefined` | specify the level of change                      |
+| **`--preid`**                | `string`        | `undefined` | prerelease identifier                            |
+| **`--tagPrefix`**            | `string | null` | `undefined` | specify the tag prefix                           |
+| **`--postTargets`**          | `string[]`      | `[]`        | specify a list of target to execute post-release |
+| **`--trackDeps`**            | `boolean`       | `false`     | use dependencies when calculating a version bump |
+| **`--commitMessageFormat`**  | `string`        | `undefined` | format the auto-generated message commit         |
 
 #### Configuration using the file
 
@@ -102,7 +102,7 @@ Note that you can define the options you want to customize using the `workspace.
   "executor": "@jscutlery/semver:version",
   "options": {
     "baseBranch": "master",
-    "versionTagPrefix": "${target}@"
+    "tagPrefix": "${target}@"
   }
 }
 ```
@@ -123,7 +123,7 @@ nx run workspace:version --releaseAs=prerelease --preid=beta
 
 #### Tag prefix customization
 
-The **`--versionTagPrefix`** option allows you to customize the tag prefix.
+The **`--tagPrefix`** option allows you to customize the tag prefix.
 
 With the sync mode the tag prefix is set to `"v"` by default, which is resolved to `v0.0.1` for example. Note that only one tag is created for the whole workspace.
 

diff --git a/packages/semver/src/executors/version/index.spec.ts b/packages/semver/src/executors/version/index.spec.ts
@@ -195,7 +195,7 @@ describe('@jscutlery/semver:version', () => {
 
     it('should run standard-version with a custom tag', async () => {
       const { success } = await version(
-        { ...options, versionTagPrefix: 'custom-tag-prefix/${target}-' },
+        { ...options, tagPrefix: 'custom-tag-prefix/${target}-' },
         context
       );
 

diff --git a/packages/semver/src/executors/version/index.ts b/packages/semver/src/executors/version/index.ts
@@ -14,7 +14,7 @@ import {
 } from './utils/get-project-dependencies';
 import { tryPushToGitRemote } from './utils/git';
 import { runPostTargets } from './utils/post-target';
-import { formatTag, resolveTagPrefix } from './utils/tag';
+import { formatTag, formatTagPrefix } from './utils/tag';
 import { tryBump } from './utils/try-bump';
 import { getProjectRoot } from './utils/workspace';
 import { versionProject, versionWorkspace } from './version';
@@ -48,7 +48,7 @@ export default async function version(
   const projectName = context.projectName as string;
   const preset = 'angular';
 
-  const tagPrefix = resolveTagPrefix({
+  const tagPrefix = formatTagPrefix({
     versionTagPrefix,
     projectName,
     syncVersions,
@@ -75,7 +75,6 @@ export default async function version(
     tagPrefix,
     releaseType: releaseAs,
     preid,
-    versionTagPrefix,
     syncVersions,
   });
 
@@ -199,5 +198,6 @@ function normalizeOptions(options: VersionBuilderSchema) {
     skipProjectChangelog: options.skipProjectChangelog as boolean,
     releaseAs: options.releaseAs ?? options.version,
     changelogHeader: options.changelogHeader ?? defaultHeader,
+    versionTagPrefix: options.tagPrefix ?? options.versionTagPrefix,
   };
 }
diff --git a/packages/semver/src/executors/version/schema.d.ts b/packages/semver/src/executors/version/schema.d.ts
@@ -22,7 +22,12 @@ export interface VersionBuilderSchema {
   releaseAs?: ReleaseIdentifier;
   preid?: string;
   changelogHeader?: string;
-  versionTagPrefix?: string;
+  tagPrefix?: string | null;
+  /**
+   * @deprecated Use the alias tagPrefix (--tagPrefix) instead.
+   * @sunset 3.0.0
+   */
+  versionTagPrefix?: string | null;
   postTargets: string[];
   commitMessageFormat?: string;
 }
diff --git a/packages/semver/src/executors/version/schema.json b/packages/semver/src/executors/version/schema.json
@@ -51,7 +51,7 @@
       "default": false
     },
     "version": {
-      "description": "Manually increment the version by that keyword.",
+      "description": "(Deprecated) Manually increment the version by that keyword.",
       "type": "string"
     },
     "releaseAs": {
@@ -62,10 +62,14 @@
       "description": "Use the next semantic prerelease version with a specific prerelease identifier.",
       "type": "string"
     },
-    "versionTagPrefix": {
+    "tagPrefix": {
       "description": "Version tag prefix. Defaults are 'v' and '${target}-' for sync and independent modes. ${target} will be replaced with context target value for independent mode.",
       "oneOf": [{ "type": "string" }, { "type": "null" }]
     },
+    "versionTagPrefix": {
+      "description": "(Deprecated) Version tag prefix. Defaults are 'v' and '${target}-' for sync and independent modes. ${target} will be replaced with context target value for independent mode.",
+      "oneOf": [{ "type": "string" }, { "type": "null" }]
+    },
     "postTargets": {
       "description": "Specify the targets to run after a new version was successfully created.",
       "type": "array",

diff --git a/packages/semver/src/executors/version/utils/tag.spec.ts b/packages/semver/src/executors/version/utils/tag.spec.ts
@@ -1,19 +1,19 @@
-import { resolveTagPrefix } from './tag';
+import { formatTagPrefix } from './tag';
 
-describe(resolveTagPrefix.name, () => {
+describe(formatTagPrefix.name, () => {
   it('should resolve interpolated string', () => {
     expect(
-      resolveTagPrefix({
-        versionTagPrefix: 'testVersionTagPrefix',
+      formatTagPrefix({
+        versionTagPrefix: 'testtagPrefix',
         projectName: 'testProjectName',
         syncVersions: true,
       })
-    ).toBe('testVersionTagPrefix');
+    ).toBe('testtagPrefix');
   });
 
   it('should resolve syncVersions', () => {
     expect(
-      resolveTagPrefix({
+      formatTagPrefix({
         versionTagPrefix: undefined,
         projectName: 'testProjectName',
         syncVersions: true,
@@ -23,7 +23,7 @@ describe(resolveTagPrefix.name, () => {
 
   it('should resolve default tag', () => {
     expect(
-      resolveTagPrefix({
+      formatTagPrefix({
         versionTagPrefix: undefined,
         projectName: 'testProjectName',
         syncVersions: false,

diff --git a/packages/semver/src/executors/version/utils/tag.ts b/packages/semver/src/executors/version/utils/tag.ts
@@ -1,6 +1,6 @@
 import { resolveInterpolation } from './resolve-interpolation';
 
-export function resolveTagPrefix({
+export function formatTagPrefix({
   versionTagPrefix,
   projectName,
   syncVersions,
@@ -10,15 +10,16 @@ export function resolveTagPrefix({
   syncVersions: boolean;
 }): string {
   if (versionTagPrefix !== undefined) {
-    const resolvingContest = {
+    return resolveInterpolation(versionTagPrefix as string, {
       target: projectName,
       projectName: projectName,
-    };
-    return resolveInterpolation(versionTagPrefix as string, resolvingContest) as string;
+    }) as string;
   }
+
   if (syncVersions) {
     return 'v';
   }
+
   return `${projectName}-`;
 }
 

diff --git a/packages/semver/src/executors/version/utils/try-bump.ts b/packages/semver/src/executors/version/utils/try-bump.ts
@@ -7,11 +7,12 @@ import { promisify } from 'util';
 
 import { getLastVersion } from './get-last-version';
 import { getCommits, getFirstCommitRef } from './git';
-import { formatTag, resolveTagPrefix } from './tag';
+import { formatTag, formatTagPrefix } from './tag';
 
 import type { Observable } from 'rxjs';
 import type { ReleaseIdentifier } from '../schema';
 import type { DependencyRoot } from './get-project-dependencies';
+
 export type Version =
   | {
       type: 'project';
@@ -248,7 +249,7 @@ export function _getDependencyVersions({
   return forkJoin(
     dependencyRoots.map(({ path: projectRoot, name: projectName }) => {
       /* Get dependency version changes since last project version */
-      const tagPrefix = resolveTagPrefix({
+      const tagPrefix = formatTagPrefix({
         versionTagPrefix,
         projectName,
         syncVersions: !!syncVersions,