update-workspace-root-version 0.2.0 → 0.3.1

package/README.md

@@ -15,9 +15,11 @@ _Update the workspace root version in a monorepo_
 
 ## 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.
+Git tags mark a specific point in a repo's history and are usually created before release. Thanks to these tags, we can easily send people links and point to specific code. We can also compare tags to see how files have changed.
 
-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.
+Creating tags can be tricky in monorepos, because we can release many packages at once: How do we create just 1 tag (no matter how many packages) and give it a name that resembles a [semantic version](https://semver.org/)?
+
+Solution: We let the workspace root's version indicate the state of the whole project, then set the tag name to be this version. `update-workspace-root-version` helps you update the version automatically.
 
 
 ## Usage
@@ -59,19 +61,7 @@ update-workspace-root-version --algorithm increment-by-one
 
 ### Limitations
 
-The codemod is designed to cover typical cases. It is not designed to cover one-off cases.
-
-To better meet your needs, consider cloning the repo and running the codemod locally.
-
-```sh
-cd <path/to/cloned/repo>
-
-# Compile TypeScript
-pnpm build
-
-# Run codemod
-./dist/bin/update-workspace-root-version.js --root <path/to/your/project>
-```
+The codemod assumes that every package follows semantic versioning. It is designed to cover typical cases.
 
 
 ## Compatibility

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

@@ -1,4 +1,4 @@
-import { compare, increment } from '../utils/versions/index.js';
+import { compare, increment } from '../utils/version/index.js';
 export function getNewVersion(packageVersions, workspaceRootVersion, options) {
     switch (options.algorithm) {
         case 'highest-version': {

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/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.2.0",
+  "version": "0.3.1",
   "description": "Update the workspace root version in a monorepo",
   "keywords": [
     "codemod",
@@ -35,15 +35,15 @@
     "@sondr3/minitest": "^0.1.2",
     "@tsconfig/node18": "^18.2.4",
     "@tsconfig/strictest": "^2.0.5",
-    "@types/node": "^18.19.47",
+    "@types/node": "^18.19.49",
     "@types/yargs": "^17.0.33",
-    "@typescript-eslint/eslint-plugin": "^8.3.0",
-    "@typescript-eslint/parser": "^8.3.0",
+    "@typescript-eslint/eslint-plugin": "^8.4.0",
+    "@typescript-eslint/parser": "^8.4.0",
     "concurrently": "^8.2.2",
     "eslint": "^8.57.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-import-resolver-typescript": "^3.6.3",
-    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-import": "^2.30.0",
     "eslint-plugin-n": "^17.10.2",
     "eslint-plugin-prettier": "^5.2.1",
     "eslint-plugin-simple-import-sort": "^12.1.1",