fix tests, clenaup

Author: JReinhold

scripts/release/__tests__/version.test.ts

@@ -12,7 +12,19 @@ jest.mock('../../../code/lib/cli/src/versions', () => ({
 }));
 
 jest.mock('../../utils/exec');
-const { execaCommand } = require('../../utils/exec');
+
+jest.mock('../../utils/workspace', () => ({
+  getWorkspaces: jest.fn().mockResolvedValue([
+    {
+      name: '@storybook/addon-a11y',
+      location: 'addons/a11y',
+    },
+  ]),
+}));
+
+jest.spyOn(console, 'log').mockImplementation(() => {});
+jest.spyOn(console, 'warn').mockImplementation(() => {});
+jest.spyOn(console, 'error').mockImplementation(() => {});
 
 beforeEach(() => {
   jest.clearAllMocks();
@@ -29,6 +41,7 @@ describe('Version', () => {
     'version.ts'
   );
   const VERSIONS_PATH = path.join(CODE_DIR_PATH, 'lib', 'cli', 'src', 'versions.ts');
+  const A11Y_PACKAGE_JSON_PATH = path.join(CODE_DIR_PATH, 'addons', 'a11y', 'package.json');
 
   it('should throw when release type is invalid', async () => {
     fsExtra.__setMockFiles({
@@ -152,6 +165,23 @@ describe('Version', () => {
         [CODE_PACKAGE_JSON_PATH]: JSON.stringify({ version: currentVersion }),
         [MANAGER_API_VERSION_PATH]: `export const version = "${currentVersion}";`,
         [VERSIONS_PATH]: `export default { "@storybook/addon-a11y": "${currentVersion}" };`,
+        [A11Y_PACKAGE_JSON_PATH]: JSON.stringify({
+          version: currentVersion,
+          dependencies: {
+            '@storybook/core-server': currentVersion,
+            'unrelated-package-a': '1.0.0',
+          },
+          devDependencies: {
+            'unrelated-package-b': currentVersion,
+            '@storybook/core-common': `^${currentVersion}`,
+          },
+          peerDependencies: {
+            '@storybook/preview-api': `*`,
+            '@storybook/svelte': '0.1.1',
+            '@storybook/manager-api': `~${currentVersion}`,
+          },
+        }),
+        [VERSIONS_PATH]: `export default { "@storybook/addon-a11y": "${currentVersion}" };`,
       });
 
       await version({ releaseType, preId, exact });
@@ -161,18 +191,38 @@ describe('Version', () => {
         { version: expectedVersion },
         { spaces: 2 }
       );
-      expect(fsExtra.writeFile).toHaveBeenCalledWith(
-        path.join(CODE_DIR_PATH, '.yarn', 'versions', 'generated-by-versions-script.yml'),
-        expect.stringContaining(expectedVersion)
-      );
-      expect(execaCommand).toHaveBeenCalledWith('yarn version apply --all', { cwd: CODE_DIR_PATH });
       expect(fsExtra.writeFile).toHaveBeenCalledWith(
         MANAGER_API_VERSION_PATH,
-        expect.stringContaining(expectedVersion)
+        `export const version = "${expectedVersion}";`
       );
       expect(fsExtra.writeFile).toHaveBeenCalledWith(
         VERSIONS_PATH,
-        expect.stringContaining(expectedVersion)
+        `export default { "@storybook/addon-a11y": "${expectedVersion}" };`
+      );
+      expect(fsExtra.writeJson).toHaveBeenCalledWith(
+        A11Y_PACKAGE_JSON_PATH,
+        expect.objectContaining({
+          // should update package version
+          version: expectedVersion,
+          dependencies: {
+            // should update storybook dependencies matching current version
+            '@storybook/core-server': expectedVersion,
+            'unrelated-package-a': '1.0.0',
+          },
+          devDependencies: {
+            // should not update non-storybook dependencies, even if they match current version
+            'unrelated-package-b': currentVersion,
+            // should update dependencies with range modifiers correctly (e.g. ^1.0.0 -> ^2.0.0)
+            '@storybook/core-common': `^${expectedVersion}`,
+          },
+          peerDependencies: {
+            // should not update storybook depenedencies if they don't match current version
+            '@storybook/preview-api': `*`,
+            '@storybook/svelte': '0.1.1',
+            '@storybook/manager-api': `~${expectedVersion}`,
+          },
+        }),
+        { spaces: 2 }
       );
     }
   );

scripts/release/version.ts

@@ -97,48 +97,6 @@ const bumpCodeVersion = async (nextVersion: string) => {
 const bumpAllPackageVersions = async (nextVersion: string, verbose?: boolean) => {
   console.log(`🤜 Bumping version of ${chalk.cyan('all packages')}...`);
 
-  /**
-   * This uses the release workflow outlined by Yarn documentation here:
-   * https://yarnpkg.com/features/release-workflow
-   *
-   * However we build the release YAML file manually instead of using the `yarn version --deferred` command
-   * This is super hacky, but it's also way faster than invoking `yarn version` for each package, which is 1s each
-   *
-   * A simpler alternative is to use Lerna with:
-   * await execaCommand(`yarn lerna version ${nextVersion} --no-git-tag-version --exact`, {
-   *    cwd: CODE_DIR_PATH,
-   *    stdio: verbose ? 'inherit' : undefined,
-   * });
-   * However that doesn't update peer deps. Trade offs
-   */
-  // const yarnVersionsPath = path.join(__dirname, '..', '..', 'code', '.yarn', 'versions');
-  // let yarnDefferedVersionFileContents = dedent`# this file is auto-generated by scripts/release/version.ts
-  // releases:
-
-  // `;
-  // Object.keys(packageVersionMap).forEach((packageName) => {
-  //   yarnDefferedVersionFileContents += `  '${packageName}': ${nextVersion}\n`;
-  // });
-  // await ensureDir(yarnVersionsPath);
-  // await writeFile(
-  //   path.join(yarnVersionsPath, 'generated-by-versions-script.yml'),
-  //   yarnDefferedVersionFileContents
-  // );
-
-  // await execaCommand('yarn version apply --all', {
-  //   cwd: CODE_DIR_PATH,
-  //   stdio: verbose ? 'inherit' : undefined,
-  // });
-  // await execaCommand(`yarn lerna version ${nextVersion} --no-git-tag-version --exact --yes`, {
-  //   cwd: CODE_DIR_PATH,
-  //   stdio: verbose ? 'inherit' : undefined,
-  // });
-  // update lock file
-  // await execaCommand(`yarn task --task install`, {
-  //   cwd: CODE_DIR_PATH,
-  //   stdio: verbose ? 'inherit' : undefined,
-  // });
-
   console.log(`✅ Bumped version of ${chalk.cyan('all packages')}`);
 };
 
@@ -160,7 +118,7 @@ const bumpVersionSources = async (currentVersion: string, nextVersion: string) =
   console.log(`✅ Bumped versions in:\n  ${chalk.cyan(filesToUpdate.join('\n  '))}`);
 };
 
-const bumpPackageJsons = async ({
+const bumpAllPackageJsons = async ({
   currentVersion,
   nextVersion,
   verbose,
@@ -169,8 +127,12 @@ const bumpPackageJsons = async ({
   nextVersion: string;
   verbose?: boolean;
 }) => {
-  console.log(`🤜 Bumping versions and dependencies in ${chalk.cyan('all packages')}...`);
   const allPackages = await getWorkspaces();
+  console.log(
+    `🤜 Bumping versions and dependencies in ${chalk.cyan(
+      `all ${allPackages.length} package.json`
+    )}'s...`
+  );
   // 1. go through all packages in the monorepo
   await Promise.all(
     allPackages.map(async (pkg) => {
@@ -186,7 +148,11 @@ const bumpPackageJsons = async ({
       // 3. bump the version
       packageJson.version = nextVersion;
       const { dependencies, devDependencies, peerDependencies } = packageJson;
-
+      if (verbose) {
+        console.log(
+          `    Bumping ${chalk.blue(pkg.name)}'s version to ${chalk.yellow(nextVersion)}`
+        );
+      }
       // 4. go through all deps in the package.json
       Object.entries({ dependencies, devDependencies, peerDependencies }).forEach(
         ([depType, deps]) => {
@@ -197,7 +163,9 @@ const bumpPackageJsons = async ({
           Object.entries(deps)
             .filter(
               ([depName, depVersion]) =>
-                depName.startsWith('@storybook/') && depVersion.includes(currentVersion)
+                depName.startsWith('@storybook/') &&
+                // ignore storybook dependneices that don't use the current version
+                depVersion.includes(currentVersion)
             )
             .forEach(([depName, depVersion]) => {
               // 6. bump the version of any found storybook dep
@@ -267,9 +235,8 @@ export const run = async (options: unknown) => {
   console.log(`⏭ Bumping all packages to ${chalk.blue(nextVersion)}...`);
 
   await bumpCodeVersion(nextVersion);
-  // await bumpAllPackageVersions(nextVersion, verbose);
   await bumpVersionSources(currentVersion, nextVersion);
-  await bumpPackageJsons({ currentVersion, nextVersion, verbose });
+  await bumpAllPackageJsons({ currentVersion, nextVersion, verbose });
   // update lock file
   await execaCommand(`yarn task --task install`, {
     cwd: CODE_DIR_PATH,