Adds eleventyConfig.setServerPassthroughCopyBehavior("copy"); configu…

…ration API method to revert to previous passthrough copy file copy behavior for #2456
11ty · Jun 23, 2022 · 2dc2770 · 2dc2770
1 parent 93ff7cc
commit 2dc2770
Show file tree

Hide file tree

Showing 5 changed files with 53 additions and 26 deletions.
diff --git a/src/Eleventy.js b/src/Eleventy.js
@@ -977,20 +977,22 @@ Arguments:
       await watchRun(path);
     });
 
-    // Separate watcher for passthrough copy, we only want to trigger a server reload for changes to these files
-    this.passthroughWatcher = chokidar.watch(
-      this.eleventyFiles.getGlobWatcherFilesForPassthroughCopy(),
-      this.getChokidarConfig()
-    );
-    this.passthroughWatcher.on("change", async (path) => {
-      this.logger.forceLog(`Passthrough copy file changed: ${path}`);
-      this.triggerServerReload([path]);
-    });
+    if (this.config.serverPassthroughCopyBehavior === "passthrough") {
+      // Separate watcher for passthrough copy, we only want to trigger a server reload for changes to these files
+      this.passthroughWatcher = chokidar.watch(
+        this.eleventyFiles.getGlobWatcherFilesForPassthroughCopy(),
+        this.getChokidarConfig()
+      );
+      this.passthroughWatcher.on("change", async (path) => {
+        this.logger.forceLog(`Passthrough copy file changed: ${path}`);
+        this.triggerServerReload([path]);
+      });
 
-    this.passthroughWatcher.on("add", async (path) => {
-      this.logger.forceLog(`Passthrough copy file added: ${path}`);
-      this.triggerServerReload([path]);
-    });
+      this.passthroughWatcher.on("add", async (path) => {
+        this.logger.forceLog(`Passthrough copy file added: ${path}`);
+        this.triggerServerReload([path]);
+      });
+    }
 
     process.on("SIGINT", () => this.stopWatch());
   }
@@ -999,7 +1001,11 @@ Arguments:
     debug("Cleaning up chokidar and server instances, if they exist.");
     this.eleventyServe.close();
     this.watcher.close();
-    this.passthroughWatcher.close();
+
+    if (this.passthroughWatcher) {
+      this.passthroughWatcher.close();
+    }
+
     process.exit();
   }
 

diff --git a/src/EleventyFiles.js b/src/EleventyFiles.js
@@ -429,10 +429,14 @@ class EleventyFiles {
     // TODO improvement: tie the includes and data to specific file extensions (currently using `**`)
     let directoryGlobs = this._getIncludesAndDataDirs();
 
-    // TODO config API method to revert to previous passthrough copy behavior
-    // return this.validTemplateGlobs.concat(this.passthroughGlobs).concat(directoryGlobs);
+    if (this.config.serverPassthroughCopyBehavior === "passthrough") {
+      return this.validTemplateGlobs.concat(directoryGlobs);
+    }
 
-    return this.validTemplateGlobs.concat(directoryGlobs);
+    // Revert to old passthroughcopy copy files behavior
+    return this.validTemplateGlobs
+      .concat(this.passthroughGlobs)
+      .concat(directoryGlobs);
   }
 
   /* For `eleventy --watch` */

diff --git a/src/EleventyServe.js b/src/EleventyServe.js
@@ -50,15 +50,20 @@ class EleventyServe {
 
   set eleventyConfig(config) {
     this._eleventyConfig = config;
-    this._eleventyConfig.userConfig.events.on(
-      "eleventy.passthrough",
-      ({ map }) => {
-        // for-free passthrough copy
-        if ("setAliases" in this.server) {
-          this.server.setAliases(map);
+    if (
+      this._eleventyConfig.userConfig.serverPassthroughCopyBehavior ===
+      "passthrough"
+    ) {
+      this._eleventyConfig.userConfig.events.on(
+        "eleventy.passthrough",
+        ({ map }) => {
+          // for-free passthrough copy
+          if ("setAliases" in this.server) {
+            this.server.setAliases(map);
+          }
         }
-      }
-    );
+      );
+    }
   }
 
   // TODO this doesn’t seem to be used internally

diff --git a/src/TemplatePassthrough.js b/src/TemplatePassthrough.js
@@ -195,7 +195,10 @@ class TemplatePassthrough {
 
     let promises = fileMap.map((entry) => {
       // For-free passthrough copy
-      if (this.runMode === "serve" || this.runMode === "watch") {
+      if (
+        this.config.serverPassthroughCopyBehavior === "passthrough" &&
+        (this.runMode === "serve" || this.runMode === "watch")
+      ) {
         let aliasMap = {};
         aliasMap[entry.inputPath] = entry.outputPath;
 

diff --git a/src/UserConfig.js b/src/UserConfig.js
@@ -90,6 +90,8 @@ class UserConfig {
     this.dataFilterSelectors = new Set();
 
     this.libraryAmendments = {};
+
+    this.serverPassthroughCopyBehavior = "passthrough";
   }
 
   versionCheck(expected) {
@@ -798,6 +800,12 @@ class UserConfig {
     this.precompiledCollections = collections;
   }
 
+  // "passthrough" is the default, no other value is explicitly required in code
+  // but opt-out via "copy" is suggested
+  setServerPassthroughCopyBehavior(behavior) {
+    this.serverPassthroughCopyBehavior = behavior;
+  }
+
   getMergingConfigObject() {
     return {
       templateFormats: this.templateFormats,
@@ -851,6 +859,7 @@ class UserConfig {
       precompiledCollections: this.precompiledCollections,
       dataFilterSelectors: this.dataFilterSelectors,
       libraryAmendments: this.libraryAmendments,
+      serverPassthroughCopyBehavior: this.serverPassthroughCopyBehavior,
     };
   }
 }