update-workspace-root-version 0.1.0 → 0.3.0

package/README.md

@@ -4,21 +4,54 @@
 
 _Update the workspace root version in a monorepo_
 
+1. [Why use it?](#why-use-it)
+1. [Usage](#usage)
+    - [Arguments](#arguments)
+    - [Limitations](#limitations)
+1. [Compatibility](#compatibility)
+1. [Contributing](#contributing)
+1. [License](#license)
+
+
+## Why use it?
+
+A release tag helps us easily see the project at a past point in time. Naming the release tag can be tricky in a monorepo, because we can release many packages at once.
+
+We can solve the naming problem if the workspace root version represents the state of the project: We simply set the tag name to be the workspace root version.
+
 
 ## Usage
 
-### Arguments
+At the workspace root, install `update-workspace-root-version` as a development dependency. Run the codemod after updating the package versions.
+
+For example, with [changesets](https://github.com/changesets/changesets),
+
+```json5
+/* package.json */
+{
+  "scripts": {
+    "release:changelog": "changeset version; update-workspace-root-version",
+  },
+  "devDependencies": {
+    "@changesets/cli": "...",
+    "update-workspace-root-version": "..."
+  }
+}
+```
 
-[PROVIDE REQUIRED AND OPTIONAL ARGUMENTS.]
 
-<details>
+### Arguments
 
-<summary>Optional: Specify the project root</summary>
+<details>
 
-Pass `--root` to run the codemod somewhere else (i.e. not in the current directory).
+<summary>Optional: Specify the algorithm</summary>
 
 ```sh
-npx update-workspace-root-version --root <path/to/your/project>
+# Highest version (default)
+update-workspace-root-version --algorithm highest-version
+
+# Increment by one
+update-workspace-root-version --algorithm increment-by-one
 ```
 
 </details>

package/dist/bin/update-workspace-root-version.js

@@ -7,12 +7,18 @@ import { runCodemod } from '../src/index.js';
 process.title = 'update-workspace-root-version';
 // Set codemod options
 const argv = yargs(hideBin(process.argv))
+    .option('algorithm', {
+    choices: ['highest-version', 'increment-by-one'],
+    describe: 'How to update the workspace root version',
+    type: 'string',
+})
     .option('root', {
     describe: 'Where to run the codemod',
     type: 'string',
 })
     .parseSync();
 const codemodOptions = {
+    algorithm: argv['algorithm'] ?? 'highest-version',
     projectRoot: argv['root'] ?? process.cwd(),
 };
 runCodemod(codemodOptions);

package/dist/src/index.js

@@ -1,8 +1,8 @@
-import { createOptions, getHighestVersion, getPackageVersions, getWorkspaceRootVersion, updateWorkspaceRootVersion, } from './steps/index.js';
+import { createOptions, getNewVersion, getPackageVersions, getWorkspaceRootVersion, updateWorkspaceRootVersion, } from './steps/index.js';
 export function runCodemod(codemodOptions) {
     const options = createOptions(codemodOptions);
     const packageVersions = getPackageVersions(options);
     const workspaceRootVersion = getWorkspaceRootVersion(options);
-    const highestVersion = getHighestVersion(packageVersions, workspaceRootVersion);
-    updateWorkspaceRootVersion(highestVersion, options);
+    const version = getNewVersion(packageVersions, workspaceRootVersion, options);
+    updateWorkspaceRootVersion(version, options);
 }

package/dist/src/steps/create-options.js

@@ -1,6 +1,7 @@
 export function createOptions(codemodOptions) {
-    const { projectRoot } = codemodOptions;
+    const { algorithm, projectRoot } = codemodOptions;
     return {
+        algorithm,
         projectRoot,
     };
 }

package/dist/src/steps/get-new-version.js

@@ -0,0 +1,12 @@
+import { compare, increment } from '../utils/version/index.js';
+export function getNewVersion(packageVersions, workspaceRootVersion, options) {
+    switch (options.algorithm) {
+        case 'highest-version': {
+            const versions = [...packageVersions, increment(workspaceRootVersion)];
+            return versions.sort(compare)[0];
+        }
+        case 'increment-by-one': {
+            return increment(workspaceRootVersion);
+        }
+    }
+}

package/dist/src/steps/get-package-versions.js

@@ -1,6 +1,7 @@
 import { join } from 'node:path';
 import { findFiles } from '@codemod-utils/files';
 import { readPackageJson } from '@codemod-utils/json';
+import { allow } from '../utils/version/index.js';
 function getPackageRoots(options) {
     const { projectRoot } = options;
     const packageRoots = findFiles('**/package.json', {
@@ -18,8 +19,10 @@ function getPackageRoots(options) {
 }
 export function getPackageVersions(options) {
     const packageRoots = getPackageRoots(options);
-    return packageRoots.map((packageRoot) => {
+    return packageRoots
+        .map((packageRoot) => {
         const packageJson = readPackageJson({ projectRoot: packageRoot });
         return packageJson['version'];
-    });
+    })
+        .filter(allow);
 }

package/dist/src/steps/get-workspace-root-version.js

@@ -2,5 +2,5 @@ import { readPackageJson } from '@codemod-utils/json';
 export function getWorkspaceRootVersion(options) {
     const { projectRoot } = options;
     const packageJson = readPackageJson({ projectRoot });
-    return packageJson['version'];
+    return packageJson['version'] ?? '0.0.0';
 }

package/dist/src/steps/index.js

@@ -1,5 +1,5 @@
 export * from './create-options.js';
-export * from './get-highest-version.js';
+export * from './get-new-version.js';
 export * from './get-package-versions.js';
 export * from './get-workspace-root-version.js';
 export * from './update-workspace-root-version.js';

package/dist/src/utils/version/allow.js

@@ -0,0 +1,6 @@
+export function allow(version) {
+    if (!version) {
+        return false;
+    }
+    return new RegExp(/^\d+\.\d+\.\d+$/).test(version);
+}

package/dist/src/utils/{versions → version}/index.js

@@ -1,2 +1,3 @@
+export * from './allow.js';
 export * from './compare.js';
 export * from './increment.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "update-workspace-root-version",
-  "version": "0.1.0",
+  "version": "0.3.0",
   "description": "Update the workspace root version in a monorepo",
   "keywords": [
     "codemod",

package/dist/src/steps/get-highest-version.js

@@ -1,5 +0,0 @@
-import { compare, increment } from '../utils/versions/index.js';
-export function getHighestVersion(packageVersions, workspaceRootVersion) {
-    const versions = [...packageVersions, increment(workspaceRootVersion)];
-    return versions.sort(compare)[0];
-}