update-workspace-root-version 0.1.0

package/LICENSE.md

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Isaac J. Lee
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,56 @@
+[![This project uses GitHub Actions for continuous integration.](https://github.com/ijlee2/update-workspace-root-version/actions/workflows/ci.yml/badge.svg)](https://github.com/ijlee2/update-workspace-root-version/actions/workflows/ci.yml)
+
+# update-workspace-root-version
+
+_Update the workspace root version in a monorepo_
+
+
+## Usage
+
+### Arguments
+
+[PROVIDE REQUIRED AND OPTIONAL ARGUMENTS.]
+
+<details>
+
+<summary>Optional: Specify the project root</summary>
+
+Pass `--root` to run the codemod somewhere else (i.e. not in the current directory).
+
+```sh
+npx update-workspace-root-version --root <path/to/your/project>
+```
+
+</details>
+
+
+### 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>
+```
+
+
+## Compatibility
+
+- Node.js v18 or above
+
+
+## Contributing
+
+See the [Contributing](CONTRIBUTING.md) guide for details.
+
+
+## License
+
+This project is licensed under the [MIT License](LICENSE.md).

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

@@ -0,0 +1,18 @@
+#!/usr/bin/env node
+'use strict';
+import yargs from 'yargs';
+import { hideBin } from 'yargs/helpers';
+import { runCodemod } from '../src/index.js';
+// Provide a title to the process in `ps`
+process.title = 'update-workspace-root-version';
+// Set codemod options
+const argv = yargs(hideBin(process.argv))
+    .option('root', {
+    describe: 'Where to run the codemod',
+    type: 'string',
+})
+    .parseSync();
+const codemodOptions = {
+    projectRoot: argv['root'] ?? process.cwd(),
+};
+runCodemod(codemodOptions);

package/dist/src/index.js

@@ -0,0 +1,8 @@
+import { createOptions, getHighestVersion, 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);
+}

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

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

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

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

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

@@ -0,0 +1,25 @@
+import { join } from 'node:path';
+import { findFiles } from '@codemod-utils/files';
+import { readPackageJson } from '@codemod-utils/json';
+function getPackageRoots(options) {
+    const { projectRoot } = options;
+    const packageRoots = findFiles('**/package.json', {
+        ignoreList: ['**/{dist,node_modules}/**/*'],
+        projectRoot,
+    }).map((filePath) => {
+        return join(projectRoot, filePath.replace(/package\.json$/, ''));
+    });
+    const isMonorepo = packageRoots.length > 1;
+    if (isMonorepo) {
+        // Remove the workspace root
+        return packageRoots.filter((packageRoot) => packageRoot !== projectRoot);
+    }
+    return packageRoots;
+}
+export function getPackageVersions(options) {
+    const packageRoots = getPackageRoots(options);
+    return packageRoots.map((packageRoot) => {
+        const packageJson = readPackageJson({ projectRoot: packageRoot });
+        return packageJson['version'];
+    });
+}

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

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

package/dist/src/steps/index.js

@@ -0,0 +1,5 @@
+export * from './create-options.js';
+export * from './get-highest-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/steps/update-workspace-root-version.js

@@ -0,0 +1,11 @@
+import { writeFileSync } from 'node:fs';
+import { join } from 'node:path';
+import { readPackageJson } from '@codemod-utils/json';
+export function updateWorkspaceRootVersion(version, options) {
+    const { projectRoot } = options;
+    const packageJson = readPackageJson({ projectRoot });
+    packageJson['version'] = version;
+    const destination = join(projectRoot, 'package.json');
+    const file = JSON.stringify(packageJson, null, 2) + '\n';
+    writeFileSync(destination, file, 'utf8');
+}

package/dist/src/types/index.js

@@ -0,0 +1 @@
+export {};

package/dist/src/utils/versions/compare.js

@@ -0,0 +1,15 @@
+export function compare(version1, version2) {
+    const versions1 = version1.split('.');
+    const versions2 = version2.split('.');
+    for (let i = 0; i < 3; i++) {
+        const value1 = Number(versions1[i]);
+        const value2 = Number(versions2[i]);
+        if (value1 > value2) {
+            return -1;
+        }
+        if (value1 < value2) {
+            return 1;
+        }
+    }
+    return 0;
+}

package/dist/src/utils/versions/increment.js

@@ -0,0 +1,8 @@
+export function increment(version) {
+    const versions = version.split('.');
+    return [
+        Number(versions[0]),
+        Number(versions[1]),
+        Number(versions[2]) + 1,
+    ].join('.');
+}

package/dist/src/utils/versions/index.js

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

package/package.json

@@ -0,0 +1,68 @@
+{
+  "name": "update-workspace-root-version",
+  "version": "0.1.0",
+  "description": "Update the workspace root version in a monorepo",
+  "keywords": [
+    "codemod",
+    "versioning",
+    "workspace"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ijlee2/update-workspace-root-version.git"
+  },
+  "license": "MIT",
+  "author": "Isaac J. Lee",
+  "type": "module",
+  "main": "dist/src/index.js",
+  "bin": "dist/bin/update-workspace-root-version.js",
+  "directories": {
+    "test": "tests"
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@codemod-utils/files": "^2.0.4",
+    "@codemod-utils/json": "^1.1.9",
+    "yargs": "^17.7.2"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.25.2",
+    "@changesets/cli": "^2.27.7",
+    "@changesets/get-github-info": "^0.6.0",
+    "@codemod-utils/tests": "^1.1.7",
+    "@sondr3/minitest": "^0.1.2",
+    "@tsconfig/node18": "^18.2.4",
+    "@tsconfig/strictest": "^2.0.5",
+    "@types/node": "^18.19.47",
+    "@types/yargs": "^17.0.33",
+    "@typescript-eslint/eslint-plugin": "^8.3.0",
+    "@typescript-eslint/parser": "^8.3.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-n": "^17.10.2",
+    "eslint-plugin-prettier": "^5.2.1",
+    "eslint-plugin-simple-import-sort": "^12.1.1",
+    "eslint-plugin-typescript-sort-keys": "^3.2.0",
+    "prettier": "^3.3.3",
+    "typescript": "^5.5.4"
+  },
+  "engines": {
+    "node": "18.* || >= 20"
+  },
+  "scripts": {
+    "build": "./build.sh --production",
+    "lint": "concurrently 'pnpm:lint:*(!fix)' --names 'lint:'",
+    "lint:fix": "concurrently 'pnpm:lint:*:fix' --names 'fix:'",
+    "lint:js": "eslint . --cache",
+    "lint:js:fix": "eslint . --fix",
+    "lint:types": "tsc --noEmit",
+    "release:changelog": "changeset version",
+    "release:publish": "pnpm build && changeset publish",
+    "test": "./build.sh --test && mt dist-for-testing --quiet"
+  }
+}