scripts: add version syncing to gitRelease

Author: perf2711

scripts/common/options.ts

@@ -0,0 +1,20 @@
+export function parseOptions<O extends readonly string[]>(options: O, argv?: string[]) {
+    argv ??= process.argv.slice(2);
+    const positional = argv.filter((v) => !options.some((o) => v.startsWith(o)));
+
+    const optionValues = options.reduce(
+        (val, k) => {
+            const opt = argv.find((v) => v.startsWith(`${k}=`));
+            if (opt) {
+                val[k as keyof typeof val] = opt.replace(`${k}=`, '');
+            } else {
+                val[k as keyof typeof val] = argv.includes(k);
+            }
+
+            return val;
+        },
+        {} as Record<(typeof options)[number], boolean | string>,
+    );
+
+    return [positional, optionValues] as const;
+}

scripts/common/packageJson.ts

@@ -67,3 +67,11 @@ export function npmPublish(packageJsonPath: string) {
         cwd: path.dirname(packageJsonPath),
     };
 }
+
+export function npmRun(script: string, options?: { args: string[]; packageJsonPath?: string }) {
+    return {
+        command: 'npm',
+        args: ['run', '--silent', script, '--', ...(options?.args ?? [])],
+        cwd: options?.packageJsonPath && path.dirname(options.packageJsonPath),
+    };
+}

scripts/gitRelease.ts

@@ -24,8 +24,8 @@ import {
     gitRestoreFile,
 } from './common/git';
 import { log } from './common/output';
-import { PackageJson, loadPackageJson, npmInstall, savePackageJson } from './common/packageJson';
-import { TrasnactionFn, noop, transaction } from './common/transaction';
+import { PackageJson, loadPackageJson, npmInstall, npmRun, savePackageJson } from './common/packageJson';
+import { TrasnactionFn, transaction } from './common/transaction';
 
 const rootDir = path.join(__dirname, '..');
 
@@ -60,7 +60,15 @@ function updateVersion(
 }
 
 async function main() {
-    const options = ['--dry-run', '--no-push', '--no-commit', '--no-checkout', '--no-add', '--name'] as const;
+    const options = [
+        '--dry-run',
+        '--no-push',
+        '--no-commit',
+        '--no-checkout',
+        '--no-add',
+        '--no-sync',
+        '--name',
+    ] as const;
 
     const argv = process.argv.slice(2);
     const [packageJsonPath, versionOrRelease, identifier] = argv.filter((v) => !options.some((o) => v.startsWith(o)));
@@ -69,10 +77,6 @@ async function main() {
         throw new Error('first argument must be a package.json path');
     }
 
-    if (!versionOrRelease) {
-        throw new Error('second argument must be a version or release type');
-    }
-
     const optionValues = options.reduce(
         (val, k) => {
             const opt = argv.find((v) => v.startsWith(`${k}=`));
@@ -100,11 +104,15 @@ async function main() {
         typeof optionValues['--name'] === 'string'
             ? optionValues['--name']
             : packageJson.name.replace('@backtrace/', '');
-    const updatedPackageJson = updateVersion(packageJson, versionOrRelease, identifier);
+    const updatedPackageJson = versionOrRelease
+        ? updateVersion(packageJson, versionOrRelease, identifier)
+        : packageJson;
     const currentBranch = execute(gitGetCurrentBranch());
     const branchName = `${packageName}/${updatedPackageJson.version}`;
 
-    log(`updating version from ${packageJson.version} to ${updatedPackageJson.version}`);
+    if (packageJson.version !== updatedPackageJson.version) {
+        log(`updating version from ${packageJson.version} to ${updatedPackageJson.version}`);
+    }
 
     const exit: TrasnactionFn = [
         'exit',
@@ -114,29 +122,32 @@ async function main() {
         },
     ];
 
+    const filesToAdd: string[] = [
+        packageJsonPath,
+        packageLockPath,
+        path.join(path.dirname(packageJsonPath), 'CHANGELOG.md'),
+    ];
+    if (!dryRun) {
+        await savePackageJson(packageJsonPath, updatedPackageJson);
+    }
+
+    if (!optionValues['--no-sync']) {
+        const execute = executor();
+        const args = dryRun ? ['--dry-run'] : [];
+        const syncedPackages = execute(npmRun('syncVersions', { args }))
+            .trim()
+            .split('\n')
+            .filter((f) => !!f);
+        for (const path of syncedPackages) {
+            filesToAdd.push(path);
+        }
+    }
+
     const run = transaction(
-        dryRun
-            ? noop
-            : [
-                  'save package json',
-                  () => savePackageJson(packageJsonPath, updatedPackageJson),
-                  () => savePackageJson(packageJsonPath, packageJson),
-              ],
         ['npm install', () => execute(npmInstall()), () => execute(gitRestoreFile(packageLockPath))],
         optionValues['--no-add']
             ? exit
-            : [
-                  'add package.json to git',
-                  () => execute(gitAdd(packageJsonPath)),
-                  () => execute(gitReset(packageJsonPath)),
-              ],
-        optionValues['--no-add']
-            ? exit
-            : [
-                  'add package-lock.json to git',
-                  () => execute(gitAdd(packageLockPath)),
-                  () => execute(gitReset(packageLockPath)),
-              ],
+            : ['add files to git', () => execute(gitAdd(...filesToAdd)), () => execute(gitReset(...filesToAdd))],
         optionValues['--no-checkout']
             ? exit
             : ['create branch', () => execute(gitCreateBranch(branchName)), () => execute(gitDeleteBranch(branchName))],

scripts/syncVersions.ts

@@ -7,6 +7,7 @@
  */
 
 import path from 'path';
+import { parseOptions } from './common/options';
 import { log } from './common/output';
 import {
     DependencyType,
@@ -58,12 +59,17 @@ function updateVersions(packageJson: PackageJson, currentVersions: Record<string
 }
 
 (async () => {
+    const options = ['--dry-run'] as const;
     const rootPackageJson = await loadPackageJson(path.join(rootDir, 'package.json'));
     const workspacePackageJsonPaths = getWorkspacePackageJsonPaths(rootPackageJson);
     const workspacePackageJsons = await Promise.all(workspacePackageJsonPaths.map(loadPackageJson));
 
-    const args = process.argv.slice(2);
-    const packageJsonPathsToSync = args.length ? args : workspacePackageJsonPaths;
+    const [positionalArgs, { '--dry-run': dryRun }] = parseOptions(options);
+    const packageJsonPathsToSync = positionalArgs.length ? positionalArgs : workspacePackageJsonPaths;
+
+    if (dryRun) {
+        log('dry run enabled');
+    }
 
     const currentVersions = workspacePackageJsons.reduce(
         (obj, pj) => {
@@ -77,7 +83,9 @@ function updateVersions(packageJson: PackageJson, currentVersions: Record<string
         const packageJson = await loadPackageJson(packageJsonPath);
         const updated = updateVersions(packageJson, currentVersions);
         if (updated) {
-            await savePackageJson(packageJsonPath, packageJson);
+            if (!dryRun) {
+                await savePackageJson(packageJsonPath, packageJson);
+            }
             console.log(path.relative(process.cwd(), packageJsonPath));
         }
     }