feat: add skipCommentIfEmpty config option

Author: dstaley

.changeset/poor-bats-notice.md

@@ -2,4 +2,4 @@
 'nextjs-bundle-analysis': minor
 ---
 
-Add app name to comment for uniqueness
+Improve monorepo support by adding the `name` from `package.json` to the generated comment. Add support for a `skipCommentIfEmpty` configuration option that will set the comment to an empty string when no pages have changed size.

README.md

@@ -43,6 +43,10 @@ For example, if you build to `dist`, you should:
 
 (Optional, defaults to `0`) The threshold under which pages will be considered unchanged. For example, if `minimumChangeThreshold` was set to `500` and a page's size increased by `300 B`, it will be considered unchanged.
 
+### `skipCommentIfEmpty (boolean)`
+
+(Optional, defaults to `false`) When set to `true`, if no pages have changed size the generated comment will be an empty string.
+
 ## Caveats
 
 - This plugin only analyzes the direct bundle output from next.js. If you have added any other scripts via the `<script>` tag, especially third party scripts and things like analytics or other tracking scripts, these are not included in the analysis. Scripts of this nature should _probably_ be loaded in behind a consent manager and should not make an impact on your initial load, and as long as this is how you handle them it should make no difference, but it's important to be aware of this and account for the extra size added by these scripts if they are present in your app.

compare.js

@@ -4,7 +4,6 @@
  * SPDX-License-Identifier: MPL-2.0
  */
 
-
 const originalFilesize = require('filesize')
 const numberToWords = require('number-to-words')
 const fs = require('fs')
@@ -29,6 +28,7 @@ const SHOW_DETAILS =
   options.showDetails === undefined ? true : options.showDetails
 const BUILD_OUTPUT_DIRECTORY = getBuildOutputDirectory(options)
 const PACKAGE_NAME = options.name
+const SKIP_COMMENT_IF_EMPTY = options.skipCommentIfEmpty
 
 // import the current and base branch bundle stats
 const currentBundle = require(path.join(
@@ -45,7 +45,7 @@ const baseBundle = require(path.join(
 // kick it off
 let output = `## 📦 Next.js Bundle Analysis for ${PACKAGE_NAME}
 
-This analysis was generated by the [next.js bundle analysis action](https://github.com/hashicorp/nextjs-bundle-analysis) 🤖
+This analysis was generated by the [Next.js Bundle Analysis action](https://github.com/hashicorp/nextjs-bundle-analysis). 🤖
 
 `
 
@@ -186,14 +186,21 @@ ${
 }
 
 // and finally, if there are no changes at all, we try to be clear about that
-if (!newPages.length && !changedPages.length && !globalBundleChanges) {
-  output += 'This PR introduced no changes to the javascript bundle 🙌'
+const hasNoChanges =
+  !newPages.length && !changedPages.length && !globalBundleChanges
+if (hasNoChanges) {
+  output += 'This PR introduced no changes to the JavaScript bundle! 🙌'
 }
 
 // we add this tag so that our action can be able to easily and consistently find the
 // right comment to edit as more commits are pushed.
 output += `<!-- __NEXTJS_BUNDLE_${PACKAGE_NAME} -->`
 
+// however, if ignoreIfEmpty is true, set output to an empty string
+if (hasNoChanges && SKIP_COMMENT_IF_EMPTY) {
+  output = ''
+}
+
 // log the output, mostly for testing and debugging. this will show up in the
 // github actions console.
 console.log(output)