feat(publish): support full file path for --summary-file (lerna#4039)

Author: Leo Dumon

libs/commands/publish/README.md

@@ -334,7 +334,8 @@ Useful in [Continuous integration (CI)](https://en.wikipedia.org/wiki/Continuous
 lerna publish --canary --yes --summary-file
 # Will create a summary file in the provided directory, i.e. `./some/other/dir/lerna-publish-summary.json`
 lerna publish --canary --yes --summary-file ./some/other/dir
-
+# Will create a summary file with the provided name, i.e. `./some/other/dir/my-summary.json`
+lerna publish --canary --yes --summary-file ./some/other/dir/my-summary.json
 ```
 
 When run with this flag, a json summary report will be generated after all packages have been successfully published (see below for an example).

libs/commands/publish/src/index.ts

@@ -415,16 +415,15 @@ class PublishCommand extends Command {
     output("Successfully published:");
 
     if (this.options.summaryFile !== undefined) {
-      // create a json object and output it to a file location.
-      const filePath = this.options.summaryFile
-        ? `${this.options.summaryFile}/lerna-publish-summary.json`
-        : "./lerna-publish-summary.json";
+      const filePath = this.getSummaryFilePath();
+
       const jsonObject = publishedPackagesSorted.map((pkg) => {
         return {
           packageName: pkg.name,
           version: pkg.version,
         };
       });
+
       output(jsonObject);
       try {
         fs.writeFileSync(filePath, JSON.stringify(jsonObject));
@@ -1220,6 +1219,28 @@ class PublishCommand extends Command {
       }
     }
   }
+
+  private getSummaryFilePath(): string {
+    if (this.options.summaryFile === undefined) {
+      throw new Error("summaryFile options is not defined. Unable to get path.");
+    }
+
+    if (this.options.summaryFile === "") {
+      return path.join(process.cwd(), "./lerna-publish-summary.json");
+    }
+
+    const normalizedPath = path.normalize(this.options.summaryFile);
+
+    if (normalizedPath === "") {
+      throw new Error("summaryFile is not a valid path.");
+    }
+
+    if (normalizedPath.endsWith(".json")) {
+      return path.join(process.cwd(), normalizedPath);
+    }
+
+    return path.join(process.cwd(), normalizedPath, "lerna-publish-summary.json");
+  }
 }
 
 module.exports.PublishCommand = PublishCommand;

libs/commands/publish/src/lib/publish-command.spec.ts

@@ -382,7 +382,7 @@ Map {
       ];
       expect(fsSpy).toHaveBeenCalled();
       expect(fsSpy).toHaveBeenCalledWith(
-        "./outputs/lerna-publish-summary.json",
+        path.join(process.cwd(), "outputs/lerna-publish-summary.json"),
         JSON.stringify(expectedJsonResponse)
       );
     });
@@ -392,6 +392,25 @@ Map {
       const fsSpy = jest.spyOn(fsmain, "writeFileSync");
       await lernaPublish(cwd)("--summary-file");
 
+      const expectedJsonResponse = [
+        { packageName: "package-1", version: "1.0.1" },
+        { packageName: "package-2", version: "1.0.1" },
+        { packageName: "package-3", version: "1.0.1" },
+        { packageName: "package-4", version: "1.0.1" },
+      ];
+
+      expect(fsSpy).toHaveBeenCalled();
+      expect(fsSpy).toHaveBeenCalledWith(
+        path.join(process.cwd(), "./lerna-publish-summary.json"),
+        JSON.stringify(expectedJsonResponse)
+      );
+    });
+
+    it("creates the summary file in the provided file path", async () => {
+      const cwd = await initFixture("normal");
+      const fsSpy = jest.spyOn(fsmain, "writeFileSync");
+      await lernaPublish(cwd)("--summary-file", "./outputs/lerna-publish-summary.json");
+
       const expectedJsonResponse = [
         { packageName: "package-1", version: "1.0.1" },
         { packageName: "package-2", version: "1.0.1" },
@@ -400,7 +419,7 @@ Map {
       ];
       expect(fsSpy).toHaveBeenCalled();
       expect(fsSpy).toHaveBeenCalledWith(
-        "./lerna-publish-summary.json",
+        path.join(process.cwd(), "outputs/lerna-publish-summary.json"),
         JSON.stringify(expectedJsonResponse)
       );
     });