Make pathPrefix available to plugins as eleventyConfig.pathPrefix

Fixes #2526

cmd.js

@@ -68,10 +68,11 @@ try {
     console.log(Eleventy.getHelp());
   } else {
     let elev = new Eleventy(argv.input, argv.output, {
+      source: "cli",
       // --quiet and --quiet=true both resolve to true
       quietMode: argv.quiet,
       configPath: argv.config,
-      source: "cli",
+      pathPrefix: argv.pathprefix,
     });
 
     // reuse ErrorHandler instance in Eleventy
@@ -82,7 +83,6 @@ try {
       elev.setIsVerbose(false);
     }
 
-    elev.setPathPrefix(argv.pathprefix);
     elev.setDryRun(argv.dryrun);
     elev.setIncrementalBuild(argv.incremental);
     elev.setPassthroughAll(argv.passthroughall);

package.json

@@ -94,7 +94,7 @@
   },
   "dependencies": {
     "@11ty/dependency-tree": "^2.0.1",
-    "@11ty/eleventy-dev-server": "^1.0.0-canary.13",
+    "@11ty/eleventy-dev-server": "^1.0.0-canary.14",
     "@11ty/eleventy-utils": "^1.0.1",
     "@iarna/toml": "^2.2.5",
     "@sindresorhus/slugify": "^1.1.2",

src/Eleventy.js

@@ -70,6 +70,16 @@ class Eleventy {
     this.env = this.getEnvironmentVariableValues();
     this.initializeEnvironmentVariables(this.env);
 
+    /**
+     * @member {String} - The top level directory the site pretends to reside in
+     * @default "/"
+     */
+    this.pathPrefix = options.pathPrefix || "/";
+
+    if (this.pathPrefix || this.pathPrefix === "") {
+      this.eleventyConfig.setPathPrefix(this.pathPrefix);
+    }
+
     /**
      * @member {Object} - Initialize Eleventy’s configuration, including the user config file
      */

src/Filters/Url.js

@@ -21,7 +21,7 @@ module.exports = function (url, pathPrefix) {
 
   if (pathPrefix === undefined || typeof pathPrefix !== "string") {
     // When you retrieve this with config.getFilter("url") it
-    // grabs the pathPrefix argument from your config for you.
+    // grabs the pathPrefix argument from your config for you (see defaultConfig.js)
     throw new Error("pathPrefix (String) is required in the `url` filter.");
   }
 

src/TemplateConfig.js

@@ -166,11 +166,6 @@ class TemplateConfig {
   setPathPrefix(pathPrefix) {
     debug("Setting pathPrefix to %o", pathPrefix);
     this.overrides.pathPrefix = pathPrefix;
-
-    if (!this.hasConfigMerged) {
-      this.forceReloadConfig();
-    }
-    this.config.pathPrefix = pathPrefix;
   }
 
   /**
@@ -179,6 +174,10 @@ class TemplateConfig {
    *  @returns {String} - The path prefix string
    */
   getPathPrefix() {
+    if (this.overrides.pathPrefix || this.overrides.pathPrefix === "") {
+      return this.overrides.pathPrefix;
+    }
+
     if (!this.hasConfigMerged) {
       this.getConfig();
     }
@@ -203,8 +202,9 @@ class TemplateConfig {
    *
    * @param {Object} - the return Object from the user’s config file.
    */
-  processPlugins({ dir }) {
+  processPlugins({ dir, pathPrefix }) {
     this.userConfig.dir = dir;
+    this.userConfig.pathPrefix = pathPrefix;
 
     if (this.logger) {
       this.userConfig.logger = this.logger;
@@ -314,6 +314,12 @@ class TemplateConfig {
 
     // Temporarily restore templateFormats
     mergedConfig.templateFormats = templateFormats;
+
+    // Setup pathPrefix set via command line for plugin consumption
+    if (this.overrides.pathPrefix || this.overrides.pathPrefix === "") {
+      mergedConfig.pathPrefix = this.overrides.pathPrefix;
+    }
+
     this.processPlugins(mergedConfig);
     delete mergedConfig.templateFormats;
 

test/TemplateConfigTest.js

@@ -545,3 +545,26 @@ test("Nested .addPlugin calls. More complex order", (t) => {
 
   templateCfg.getConfig();
 });
+
+test(".addPlugin has access to pathPrefix", (t) => {
+  t.plan(1);
+  let templateCfg = new TemplateConfig();
+
+  templateCfg.userConfig.addPlugin(function (eleventyConfig) {
+    t.is(eleventyConfig.pathPrefix, "/");
+  });
+
+  templateCfg.getConfig();
+});
+
+test(".addPlugin has access to pathPrefix (override method)", (t) => {
+  t.plan(1);
+  let templateCfg = new TemplateConfig();
+  templateCfg.setPathPrefix("/test/");
+
+  templateCfg.userConfig.addPlugin(function (eleventyConfig) {
+    t.is(eleventyConfig.pathPrefix, "/test/");
+  });
+
+  templateCfg.getConfig();
+});