feat(transpile): add ignoreModules option

lightbasenl · Jul 8, 2021 · 346a432 · 346a432
1 parent 11ef3ba
commit 346a432
Show file tree

Hide file tree

Showing 5 changed files with 71 additions and 55 deletions.
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@lightbase/next-preset",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "main": "dist/index.js",
   "repository": "https://github.com/lightbasenl/next-preset",
   "author": "Rody Molenaar <[email protected]>",

diff --git a/src/index.ts b/src/index.ts
@@ -11,14 +11,17 @@ export function withPreset(nextConfig: ExportedNextConfig): NextConfigFunction {
       ? nextConfig(phase, defaults)
       : nextConfig;
 
-    let config = baseConfig ?? {};
+    let newConfig = baseConfig ?? {};
 
     // Set misc. defaults
-    config.poweredByHeader = config.poweredByHeader ?? false;
-    config.pageExtensions = config.pageExtensions ?? ["api.ts", "page.tsx"];
+    newConfig.poweredByHeader = newConfig.poweredByHeader ?? false;
+    newConfig.pageExtensions = newConfig.pageExtensions ?? [
+      "api.ts",
+      "page.tsx",
+    ];
 
     // Set default headers
-    config.headers = async () => {
+    newConfig.headers = async () => {
       return [
         {
           source: "/:path*{/}?",
@@ -54,28 +57,30 @@ export function withPreset(nextConfig: ExportedNextConfig): NextConfigFunction {
     };
 
     if (preset?.transpileModules) {
-      config = withTM(preset.transpileModules)(config);
+      newConfig = withTM(preset.transpileModules)(newConfig);
     }
 
-    config.webpack = extendWebpackConfig((config, options) => {
+    newConfig.webpack = extendWebpackConfig((config, options) => {
       if (!options.dev) {
         // Next.js doesn't let you change this is dev even if you want to - see
         // https://github.com/vercel/next.js/blob/master/errors/improper-devtool.md
         config.devtool = "source-map";
 
-        config.plugins?.push(new BrowserCompatibilityWebpackPlugin());
+        config.plugins?.push(
+          new BrowserCompatibilityWebpackPlugin(preset?.ignoreModules)
+        );
       }
 
       return config;
-    }, config.webpack);
+    }, newConfig.webpack);
 
     if (preset?.sentry?.enabled) {
-      config = withSentryConfig(config, preset?.sentry?.webpackPluginOptions)(
-        phase,
-        defaults
-      );
+      newConfig = withSentryConfig(
+        newConfig,
+        preset?.sentry?.webpackPluginOptions
+      )(phase, defaults);
     }
 
-    return config;
+    return newConfig;
   };
 }
diff --git a/src/lib/checkForOffendingOutput.ts b/src/lib/checkForOffendingOutput.ts
@@ -4,7 +4,9 @@ import { promises as fs } from "fs";
 import { SourceMapConsumer } from "source-map";
 import _ from "lodash";
 
-export default async function checkForOffendingOutput() {
+export default async function checkForOffendingOutput(
+  ignoreModules: string[] = []
+) {
   const ecmaVersion = 5;
   const paths = ["./.next/static/**/*.js"];
   const useEsModules = false;
@@ -94,51 +96,21 @@ export default async function checkForOffendingOutput() {
     })
   );
 
-  console.log();
+  const filteredOffenders = _.uniq(
+    offenders.map((offender) => formatEntry(offender))
+  ).filter((offender) => !ignoreModules.includes(offender));
+
+  if (filteredOffenders.length === 0) {
+    return;
+  }
+
   console.log("[PRESET]");
   console.log(
     "You might want to add the following entries to `preset.transpileModules` in `next.config.js`:"
   );
   console.log();
 
-  for (const offender of _.uniq(
-    offenders.map((offender) => {
-      return offender
-        .replace("webpack://_N_E/", "")
-        .split("/")
-        .reduce<string[]>((parts, part, index) => {
-          if (parts.length === 0 && part === "node_modules" && index === 0) {
-            return parts;
-          }
-
-          if (parts[parts.length - 1] === "node_modules") {
-            parts.push(part);
-            return parts;
-          }
-
-          if (
-            parts[parts.length - 1] &&
-            parts[parts.length - 1].startsWith("@")
-          ) {
-            parts.push(part);
-            return parts;
-          }
-
-          if (parts.length === 0) {
-            parts.push(part);
-            return parts;
-          }
-
-          if (part === "node_modules") {
-            parts.push(part);
-            return parts;
-          }
-
-          return parts;
-        }, [])
-        .join("/");
-    })
-  )) {
+  for (const offender of filteredOffenders) {
     console.log(`- ${offender}`);
   }
 
@@ -150,3 +122,37 @@ export default async function checkForOffendingOutput() {
 
   process.exit(1);
 }
+
+function formatEntry(entry: string) {
+  return entry
+    .replace("webpack://_N_E/", "")
+    .split("/")
+    .reduce<string[]>((parts, part, index) => {
+      if (parts.length === 0 && part === "node_modules" && index === 0) {
+        return parts;
+      }
+
+      if (parts[parts.length - 1] === "node_modules") {
+        parts.push(part);
+        return parts;
+      }
+
+      if (parts[parts.length - 1] && parts[parts.length - 1].startsWith("@")) {
+        parts.push(part);
+        return parts;
+      }
+
+      if (parts.length === 0) {
+        parts.push(part);
+        return parts;
+      }
+
+      if (part === "node_modules") {
+        parts.push(part);
+        return parts;
+      }
+
+      return parts;
+    }, [])
+    .join("/");
+}
diff --git a/src/lib/plugins/BrowserCompatibilityWebpackPlugin.js b/src/lib/plugins/BrowserCompatibilityWebpackPlugin.js
@@ -1,6 +1,10 @@
 import checkForOffendingOutput from "../checkForOffendingOutput";
 
 class BrowserCompatibilityWebpackPlugin {
+  constructor(ignoreModules = []) {
+    this.ignoreModules = ignoreModules;
+  }
+
   apply(compiler) {
     /**
      * Determines whether plugin should be applied not more than once during whole webpack run.
@@ -17,7 +21,7 @@ class BrowserCompatibilityWebpackPlugin {
     compiler.hooks.afterEmit.tapAsync(
       "next-preset",
       async (compilation, callback) => {
-        await checkForOffendingOutput();
+        await checkForOffendingOutput(this.ignoreModules);
 
         callback();
       }

diff --git a/src/types/config.ts b/src/types/config.ts
@@ -12,6 +12,7 @@ export type NextConfigObject = {
       webpackPluginOptions?: unknown;
     };
     transpileModules?: string[];
+    ignoreModules?: string[];
   };
   webpack?: WebpackConfigFunction;
 } & {