add apply logic and tests

Author: JReinhold

code/__mocks__/fs-extra.js

@@ -20,6 +20,9 @@ const readJsonSync = (filePath = '') => JSON.parse(mockFiles[filePath]);
 const lstatSync = (filePath) => ({
   isFile: () => !!mockFiles[filePath],
 });
+const writeJson = jest.fn((filePath, json, { spaces } = {}) => {
+  mockFiles[filePath] = JSON.stringify(json, null, spaces);
+});
 
 // eslint-disable-next-line no-underscore-dangle
 fs.__setMockFiles = __setMockFiles;
@@ -29,5 +32,6 @@ fs.readJson = readJson;
 fs.readJsonSync = readJsonSync;
 fs.existsSync = existsSync;
 fs.lstatSync = lstatSync;
+fs.writeJson = writeJson;
 
 module.exports = fs;

scripts/release/__tests__/version.test.ts

@@ -184,11 +184,6 @@ describe('Version', () => {
           "code": "custom",
           "message": "--deferred cannot be combined with --apply",
           "path": []
-        },
-        {
-          "code": "custom",
-          "message": "Combining --exact with --release-type is invalid, but having one of them is required",
-          "path": []
         }
       ]"
     `);
@@ -221,11 +216,21 @@ describe('Version', () => {
     { releaseType: 'patch', currentVersion: '1.1.1-rc.10', expectedVersion: '1.1.1' },
     // prettier-ignore
     { exact: '4.2.0-canary.69', currentVersion: '1.1.1-rc.10', expectedVersion: '4.2.0-canary.69' },
+    // prettier-ignore
+    { apply: true, currentVersion: '1.0.0', deferredNextVersion: '1.2.0', expectedVersion: '1.2.0' },
   ])(
-    'bump with type: "$releaseType", pre id "$preId" or exact "$exact", from: $currentVersion, to: $expectedVersion',
-    async ({ releaseType, preId, exact, currentVersion, expectedVersion }) => {
+    'bump with type: "$releaseType", pre id "$preId" or exact "$exact" or apply $apply, from: $currentVersion, to: $expectedVersion',
+    async ({
+      releaseType,
+      preId,
+      exact,
+      apply,
+      currentVersion,
+      expectedVersion,
+      deferredNextVersion,
+    }) => {
       fsExtra.__setMockFiles({
-        [CODE_PACKAGE_JSON_PATH]: JSON.stringify({ version: currentVersion }),
+        [CODE_PACKAGE_JSON_PATH]: JSON.stringify({ version: currentVersion, deferredNextVersion }),
         [MANAGER_API_VERSION_PATH]: `export const version = "${currentVersion}";`,
         [VERSIONS_PATH]: `export default { "@storybook/addon-a11y": "${currentVersion}" };`,
         [A11Y_PACKAGE_JSON_PATH]: JSON.stringify({
@@ -247,7 +252,17 @@ describe('Version', () => {
         [VERSIONS_PATH]: `export default { "@storybook/addon-a11y": "${currentVersion}" };`,
       });
 
-      await version({ releaseType, preId, exact });
+      await version({ releaseType, preId, exact, apply });
+      expect(fsExtra.writeJson).toHaveBeenCalledTimes(apply ? 3 : 2);
+      if (apply) {
+        // eslint-disable-next-line jest/no-conditional-expect -- guarded against problems with the assertion above
+        expect(fsExtra.writeJson).toHaveBeenCalledWith(
+          CODE_PACKAGE_JSON_PATH,
+          // this call is the write that removes the "deferredNextVersion" property
+          { version: currentVersion },
+          { spaces: 2 }
+        );
+      }
 
       expect(fsExtra.writeJson).toHaveBeenCalledWith(
         CODE_PACKAGE_JSON_PATH,

scripts/release/version.ts

@@ -64,7 +64,7 @@ const optionsSchema = z
           '--apply cannot be combined with --exact or --release-type, as it will always read from code/package.json#deferredNextVersion',
       });
     }
-    if ((hasExact && hasReleaseType) || (!hasExact && !hasReleaseType)) {
+    if (!hasApply && ((hasExact && hasReleaseType) || (!hasExact && !hasReleaseType))) {
       ctx.addIssue({
         code: z.ZodIssueCode.custom,
         message:
@@ -211,9 +211,9 @@ const bumpAllPackageJsons = async ({
 
 const bumpDeferred = async (nextVersion: string) => {
   console.log(
-    `⏳ Setting a ${chalk.cyan(
-      'deferred'
-    )} version bump with code/package.json#deferredNextVersion = ${chalk.yellow(nextVersion)}...`
+    `⏳ Setting a ${chalk.cyan('deferred')} version bump with ${chalk.blue(
+      'code/package.json#deferredNextVersion'
+    )} = ${chalk.yellow(nextVersion)}...`
   );
   const codePkgJson = await readJson(CODE_PACKAGE_JSON_PATH);
 
@@ -223,14 +223,40 @@ const bumpDeferred = async (nextVersion: string) => {
   console.log(`✅ Set a ${chalk.cyan('deferred')} version bump. Not bumping any packages.`);
 };
 
+const applyDeferredVersionBump = async () => {
+  console.log(
+    `⏩ Applying previously deferred version bump set at ${chalk.blue(
+      'code/package.json#deferredNextVersion'
+    )}...`
+  );
+  const codePkgJson = await readJson(CODE_PACKAGE_JSON_PATH);
+
+  const { deferredNextVersion } = codePkgJson;
+
+  if (!deferredNextVersion) {
+    throw new Error(
+      "The 'deferredNextVersion' property in code/package.json is unset. This is necessary to apply a deferred version bump"
+    );
+  }
+
+  delete codePkgJson.deferredNextVersion;
+  await writeJson(CODE_PACKAGE_JSON_PATH, codePkgJson, { spaces: 2 });
+
+  console.log(
+    `✅ Extracted and removed deferred version ${chalk.green(
+      deferredNextVersion
+    )} from ${chalk.blue('code/package.json#deferredNextVersion')}`
+  );
+
+  return deferredNextVersion;
+};
+
 export const run = async (options: unknown) => {
   if (!validateOptions(options)) {
     return;
   }
   const { verbose } = options;
 
-  // TODO: if apply, set next version from deferred and removed deferred version
-
   console.log(`🚛 Finding Storybook packages...`);
 
   const [packages, currentVersion] = await Promise.all([getWorkspaces(), getCurrentVersion()]);
@@ -248,7 +274,9 @@ export const run = async (options: unknown) => {
 
   let nextVersion: string;
 
-  if ('exact' in options && options.exact) {
+  if ('apply' in options && options.apply) {
+    nextVersion = await applyDeferredVersionBump();
+  } else if ('exact' in options && options.exact) {
     console.log(`📈 Exact version selected: ${chalk.green(options.exact)}`);
     nextVersion = options.exact;
   } else {