Merge branch 'main' into gzip-diff-option

kaitlynnefuery · web-flow · commit d0374a3ac89d · 2025-09-15T09:53:01.000-07:00
diff --git a/.changeset/README.md b/.changeset/README.md
@@ -0,0 +1,8 @@
+# Changesets
+
+Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
+with multi-package repos, or single-package repos to help you version and publish your code. You can
+find the full documentation for it [in our repository](https://github.com/changesets/changesets)
+
+We have a quick list of common questions to get you started engaging with this project in
+[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)
diff --git a/.changeset/config.json b/.changeset/config.json
@@ -0,0 +1,17 @@
+{
+  "$schema": "https://unpkg.com/@changesets/config@2.3.0/schema.json",
+  "changelog": [
+    "@changesets/changelog-github",
+    { "repo": "hashicorp/nextjs-bundle-analysis" }
+  ],
+  "commit": false,
+  "linked": [],
+  "access": "public",
+  "baseBranch": "main",
+  "updateInternalDependencies": "patch",
+  "ignore": [],
+  "___experimentalUnsafeOptions_WILL_CHANGE_IN_PATCH": {
+    "useCalculatedVersionForSnapshots": true,
+    "onlyUpdatePeerDependentsWhenOutOfRange": true
+  }
+}
diff --git a/.github/workflows/canary-release.yml b/.github/workflows/canary-release.yml
@@ -0,0 +1,16 @@
+name: Canary Release
+
+on:
+  pull_request:
+    types:
+      - opened
+      - synchronize
+      - reopened
+      - labeled
+
+jobs:
+  release-canary:
+    uses: hashicorp/web-platform-packages/.github/workflows/canary-release.yml@5eee43c8a4a8f311e08f473132c617f757a8c6b5
+    secrets:
+      CHANGESETS_PAT: ${{ secrets.CHANGESETS_PAT }}
+      NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -0,0 +1,13 @@
+name: Release
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  release:
+    uses: hashicorp/web-platform-packages/.github/workflows/release.yml@5eee43c8a4a8f311e08f473132c617f757a8c6b5
+    secrets:
+      CHANGESETS_PAT: ${{ secrets.CHANGESETS_PAT }}
+      NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,7 @@
+# nextjs-bundle-analysis
+
+## 0.5.0
+
+### Minor Changes
+
+- [#44](https://github.com/hashicorp/nextjs-bundle-analysis/pull/44) [`067cb5d`](https://github.com/hashicorp/nextjs-bundle-analysis/commit/067cb5de682d51ad30b8aac2f69437303825c3b8) Thanks [@dstaley](https://github.com/dstaley)! - 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.
diff --git a/LICENSE b/LICENSE
@@ -1,3 +1,5 @@
+Copyright (c) 2021 HashiCorp, Inc.
+
 # Mozilla Public License Version 2.0
 
 1. Definitions
diff --git a/README.md b/README.md
@@ -47,6 +47,10 @@ For example, if you build to `dist`, you should:
 
 (Optional, defaults to `false`) If set, the display table will show the gzip size difference for routes even when a budget is set.
 
+### `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.
diff --git a/__tests__/__fixtures__/basic/pages/index.jsx b/__tests__/__fixtures__/basic/pages/index.jsx
@@ -1,3 +1,8 @@
+/**
+ * Copyright (c) HashiCorp, Inc.
+ * SPDX-License-Identifier: MPL-2.0
+ */
+
 export default function IndexPage() {
   return <p>hello world</p>
 }
diff --git a/__tests__/__fixtures__/custom-output-directory/next.config.js b/__tests__/__fixtures__/custom-output-directory/next.config.js
@@ -1,3 +1,8 @@
+/**
+ * Copyright (c) HashiCorp, Inc.
+ * SPDX-License-Identifier: MPL-2.0
+ */
+
 module.exports = {
   distDir: 'dist',
 }
diff --git a/__tests__/__fixtures__/custom-output-directory/pages/index.jsx b/__tests__/__fixtures__/custom-output-directory/pages/index.jsx
@@ -1,3 +1,8 @@
+/**
+ * Copyright (c) HashiCorp, Inc.
+ * SPDX-License-Identifier: MPL-2.0
+ */
+
 export default function IndexPage() {
   return <p>hello world</p>
 }
diff --git a/__tests__/index.js b/__tests__/index.js
@@ -1,3 +1,8 @@
+/**
+ * Copyright (c) HashiCorp, Inc.
+ * SPDX-License-Identifier: MPL-2.0
+ */
+
 const path = require('path')
 const fs = require('fs')
 const { execSync } = require('child_process')
diff --git a/compare.js b/compare.js
@@ -1,4 +1,8 @@
 #!/usr/bin/env node
+/**
+ * Copyright (c) HashiCorp, Inc.
+ * SPDX-License-Identifier: MPL-2.0
+ */
 
 const originalFilesize = require('filesize')
 const numberToWords = require('number-to-words')
@@ -23,6 +27,8 @@ const BUDGET_PERCENT_INCREASE_RED = options.budgetPercentIncreaseRed
 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(
@@ -37,9 +43,9 @@ const baseBundle = require(path.join(
 ))
 
 // kick it off
-let output = `## 📦 Next.js Bundle Analysis
+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). 🤖
 
 `
 
@@ -180,13 +186,20 @@ ${
 }
 
 // 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 -->'
+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.
diff --git a/generate.js b/generate.js
@@ -1,4 +1,9 @@
 #!/usr/bin/env node
+/**
+ * Copyright (c) HashiCorp, Inc.
+ * SPDX-License-Identifier: MPL-2.0
+ */
+
 
 const path = require('path')
 const fs = require('fs')
@@ -31,7 +36,7 @@ inquirer
     {
       type: 'number',
       name: 'minimumChangeThreshold',
-      message: `If a page's size change is below this threshold (in bytes), it will be considered unchanged'`,
+      message: `If a page's size change is below this threshold (in bytes), it will be considered unchanged`,
       default: 0,
     },
   ])
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
diff --git a/report.js b/report.js
diff --git a/template.yml b/template.yml
diff --git a/utils.js b/utils.js

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+Copyright (c) 2021 HashiCorp, Inc.`
	`2`	`+`
`1`	`3`	`# Mozilla Public License Version 2.0`
`2`	`4`
`3`	`5`	`1. Definitions`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,8 @@`
	`1`	`+/**`
	`2`	`+ * Copyright (c) HashiCorp, Inc.`
	`3`	`+ * SPDX-License-Identifier: MPL-2.0`
	`4`	`+ */`
	`5`	`+`
`1`	`6`	`export default function IndexPage() {`
`2`	`7`	`return <p>hello world</p>`
`3`	`8`	`}`