Pass packageInfos into prepublish, postpublish, and postbump hooks

change/beachball-b16e6b4f-dc7c-47e6-bd0f-3722b5c2c112.json

@@ -0,0 +1,7 @@
+{
+  "type": "minor",
+  "comment": "Beachball passes packageInfos as 4th param of prepublish, postpublish, and postbump hooks",
+  "packageName": "beachball",
+  "email": "tronguye@microsoft.com",
+  "dependentChangeType": "patch"
+}

src/__e2e__/bump.test.ts

@@ -574,20 +574,22 @@ describe('version bumping', () => {
 
     let postBumpCalled = false;
 
+    const hooks: BeachballOptions['hooks'] = {
+      postbump: (packagePath, name, version) => {
+        postBumpCalled = true;
+        expect(packagePath.endsWith(path.join('packages', 'pkg-1'))).toBeTruthy();
+        expect(name).toBe('pkg-1');
+        expect(version).toBe('1.1.0');
+
+        const jsonPath = path.join(packagePath, 'package.json');
+        expect(fs.readJSONSync(jsonPath).version).toBe('1.1.0');
+      },
+    }
+
     await bump({
       path: repo.rootPath,
       bumpDeps: false,
-      hooks: {
-        postbump: (packagePath, name, version) => {
-          postBumpCalled = true;
-          expect(packagePath.endsWith(path.join('packages', 'pkg-1'))).toBeTruthy();
-          expect(name).toBe('pkg-1');
-          expect(version).toBe('1.1.0');
-
-          const jsonPath = path.join(packagePath, 'package.json');
-          expect(fs.readJSONSync(jsonPath).version).toBe('1.1.0');
-        },
-      },
+      hooks
     } as BeachballOptions);
 
     expect(postBumpCalled).toBe(true);
@@ -607,10 +609,7 @@ describe('version bumping', () => {
 
     let postbumpCalled = false;
 
-    await bump({
-      path: repo.rootPath,
-      bumpDeps: false,
-      hooks: {
+    const hooks: BeachballOptions['hooks'] = {
         postbump: async (packagePath, name, version) => {
           postbumpCalled = true;
           expect(packagePath.endsWith(path.join('packages', 'pkg-1'))).toBeTruthy();
@@ -620,7 +619,12 @@ describe('version bumping', () => {
           const jsonPath = path.join(packagePath, 'package.json');
           expect((await fs.readJSON(jsonPath)).version).toBe('1.1.0');
         },
-      },
+      }
+
+    await bump({
+      path: repo.rootPath,
+      bumpDeps: false,
+      hooks,
     } as BeachballOptions);
 
     expect(postbumpCalled).toBe(true);
@@ -638,14 +642,17 @@ describe('version bumping', () => {
 
     repo.push();
 
-    const bumpResult = bump({
-      path: repo.rootPath,
-      bumpDeps: false,
-      hooks: {
+
+    const hooks: BeachballOptions['hooks'] = {
         postbump: async (_packagePath, _name, _version): Promise<void> => {
           throw new Error('Foo');
         },
-      },
+    }
+
+    const bumpResult = bump({
+      path: repo.rootPath,
+      bumpDeps: false,
+      hooks
     } as BeachballOptions);
 
     await expect(bumpResult).rejects.toThrow('Foo');

src/bump/callHook.ts

@@ -16,6 +16,8 @@ export async function callHook(
 
   for (const pkg of affectedPackages) {
     const packageInfo = packageInfos[pkg];
-    await hook(path.dirname(packageInfo.packageJsonPath), packageInfo.name, packageInfo.version);
+    const packagePath = path.dirname(packageInfo.packageJsonPath);
+
+    await hook(packagePath, packageInfo.name, packageInfo.version, packageInfos);
   }
 }

src/types/BeachballOptions.ts

@@ -2,6 +2,7 @@ import { AuthType } from './Auth';
 import { ChangeInfo, ChangeInfoMultiple, ChangeType } from './ChangeInfo';
 import { ChangeFilePromptOptions } from './ChangeFilePrompt';
 import { ChangelogOptions } from './ChangelogOptions';
+import { PackageInfos } from './PackageInfo';
 
 export type BeachballOptions = CliOptions & RepoOptions & PackageOptions;
 
@@ -197,26 +198,45 @@ export interface HooksOptions {
    *
    * This allows for file modifications which will be reflected in the published package but not be reflected in the
    * repository.
+   *
+   * @param packagePath The path to the package directory
+   * @param name The name of the package as defined in package.json
+   * @param version The post-bump version of the package to be published
+   * @param packageInfos Metadata about other packages processed by Beachball. Computed post-bump. Readonly.
    */
-  prepublish?: (packagePath: string, name: string, version: string) => void | Promise<void>;
+  prepublish?: (packagePath: string, name: string, version: string, packageInfos: Readonly<PackageInfos>) => void | Promise<void>;
 
   /**
    * Runs for each package after the publish command.
    * Any file changes made in this step will **not** be committed automatically.
+   *
+   * @param packagePath The path to the package directory
+   * @param name The name of the package as defined in package.json
+   * @param version The post-bump version of the package to be published
+   * @param packageInfos Metadata about other packages processed by Beachball. Computed post-bump. Readonly.
    */
-  postpublish?: (packagePath: string, name: string, version: string) => void | Promise<void>;
+  postpublish?: (packagePath: string, name: string, version: string, packageInfos: Readonly<PackageInfos>) => void | Promise<void>;
 
   /**
    * Runs for each package, before writing changelog and package.json updates
    * to the filesystem. May be called multiple times during publish.
+   *
+   * @param packagePath The path to the package directory
+   * @param name The name of the package as defined in package.json
+   * @param version The pre-bump version of the package to be published
    */
   prebump?: (packagePath: string, name: string, version: string) => void | Promise<void>;
 
   /**
    * Runs for each package, after writing changelog and package.json updates
    * to the filesystem. May be called multiple times during publish.
+   *
+   * @param packagePath The path to the package directory
+   * @param name The name of the package as defined in package.json
+   * @param version The post-bump version of the package to be published
+   * @param packageInfos Metadata about other packages processed by Beachball. Computed post-bump. Readonly.
    */
-  postbump?: (packagePath: string, name: string, version: string) => void | Promise<void>;
+  postbump?: (packagePath: string, name: string, version: string, packageInfos: Readonly<PackageInfos>) => void | Promise<void>;
 
   /**
    * Runs once after all bumps to all packages before committing changes