ci: add webpack circular deps plugin

guildxyz · Jul 3, 2024 · 49fcd8f · 49fcd8f
1 parent 98078b5
commit 49fcd8f
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 43 deletions.
diff --git a/next.config.js b/next.config.js
@@ -1,6 +1,7 @@
 // @ts-check
 
 const { BugsnagSourceMapUploaderPlugin } = require("webpack-bugsnag-plugins")
+const CircularDependencyPlugin = require("circular-dependency-plugin")
 
 /** @type {import("next").NextConfig} */
 const nextConfig = {
@@ -21,8 +22,8 @@ const nextConfig = {
       ],
     })
 
+    if (!config.plugins) config.plugins = []
     if (process.env.VERCEL_ENV === "production") {
-      if (!config.plugins) config.plugins = []
       config.plugins.push(
         new BugsnagSourceMapUploaderPlugin({
           apiKey: process.env.NEXT_PUBLIC_BUGSNAG_KEY ?? "",
@@ -32,6 +33,16 @@ const nextConfig = {
       )
     }
 
+    config.plugins.push(
+      new CircularDependencyPlugin({
+        exclude: /.next|node_modules/,
+        include: /src/,
+        // TODO: if all circular dependencies are resolved, set this argument to true
+        failOnError: false,
+        allowAsyncCycles: false,
+      })
+    )
+
     return config
   },
   productionBrowserSourceMaps: true,

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -56,6 +56,7 @@
     "@zag-js/combobox": "^0.16.0",
     "@zag-js/react": "^0.16.0",
     "chakra-react-select": "^4.7.6",
+    "circular-dependency-plugin": "^5.2.2",
     "color": "^4.2.3",
     "colorthief": "^2.3.2",
     "events": "^3.3.0",