i18n plugin: Pass url (not input path) to locale_links allows us to delete a bunch of code

src/Plugins/I18nPlugin.js

@@ -91,83 +91,6 @@ function normalizeInputPath(inputPath, extensionMap) {
   return inputPath;
 }
 
-/*
- * Input: {
- *   './test/stubs-i18n/en-us/index.11ty.js': [ '/en-us/' ],
- *   './test/stubs-i18n/en/index.liquid': [ '/en/' ],
- *   './test/stubs-i18n/non-lang-file.njk': [ '/non-lang-file/' ],
- *   './test/stubs-i18n/es/index.njk': [ '/es/' ]
- * }
- *
- * Output: {
- *   "./test/stubs-i18n/en-us/index.11ty.js": [
- *     { "url": "/en/", "lang": "en", "label": "English" },
- *     { "url": "/es/", "lang": "es", "label": "Español" }
- *   ],
- *   "./test/stubs-i18n/en/index.liquid": [
- *     { "url": "/en-us/", "lang": "en-us", "label": "English" },
- *     { "url": "/es/", "lang": "es", "label": "Español" }
- *   ],
- *   "./test/stubs-i18n/es/index.njk": [
- *     { "url": "/en/", "lang": "en", "label": "English" },
- *     { "url": "/en-us/", "lang": "en-us", "label": "English" }
- *   ]
- * }
- */
-function getLocaleMap(inputPathToUrl, extensionMap) {
-  // map of input paths => array of localized urls
-  let localeMap = {};
-  let inputPaths = Object.keys(inputPathToUrl);
-
-  // map of input paths without extensions
-  let inputPathsWithoutTemplateExtensionsMap = {};
-  for (let path of inputPaths) {
-    inputPathsWithoutTemplateExtensionsMap[path] = normalizeInputPath(
-      path,
-      extensionMap
-    );
-  }
-
-  for (let comparisonInputPath of inputPaths) {
-    for (let inputPath of inputPaths) {
-      // Compare *without* template extensions: `/en/about.liquid` should match `/es/about.11ty.js`
-      let matched = Comparator.matchLanguageFolder(
-        inputPathsWithoutTemplateExtensionsMap[comparisonInputPath],
-        inputPathsWithoutTemplateExtensionsMap[inputPath]
-      );
-      if (matched) {
-        if (!localeMap[comparisonInputPath]) {
-          localeMap[comparisonInputPath] = [];
-        }
-
-        let [, langCode] = matched;
-        for (let url of inputPathToUrl[inputPath]) {
-          localeMap[comparisonInputPath].push({
-            url,
-            lang: langCode,
-            label: iso639.getNativeName(langCode.split("-")[0]),
-          });
-        }
-      }
-    }
-  }
-
-  // Default sorted by lang code
-  for (let key in localeMap) {
-    localeMap[key].sort(function (a, b) {
-      if (a.lang < b.lang) {
-        return -1;
-      }
-      if (a.lang > b.lang) {
-        return 1;
-      }
-      return 0;
-    });
-  }
-
-  return localeMap;
-}
-
 /*
  * Input: {
  *   '/en-us/': './test/stubs-i18n/en-us/index.11ty.js',
@@ -210,14 +133,27 @@ function getLocaleUrlsMap(urlToInputPath, extensionMap) {
           urlMap[comparisonUrl] = [];
         }
 
-        urlMap[comparisonUrl].push(url);
+        let [, langCode] = matched;
+        urlMap[comparisonUrl].push({
+          url,
+          lang: langCode,
+          label: iso639.getNativeName(langCode.split("-")[0]),
+        });
       }
     }
   }
 
   // Default sorted by lang code
-  for (let url in urlMap) {
-    urlMap[url].sort();
+  for (let key in urlMap) {
+    urlMap[key].sort(function (a, b) {
+      if (a.lang < b.lang) {
+        return -1;
+      }
+      if (a.lang > b.lang) {
+        return 1;
+      }
+      return 0;
+    });
   }
 
   return urlMap;
@@ -254,7 +190,6 @@ function EleventyPlugin(eleventyConfig, opts = {}) {
       contentMaps.inputPathToUrl = inputPathToUrl;
       contentMaps.urlToInputPath = urlToInputPath;
 
-      contentMaps.localeLinksMap = getLocaleMap(inputPathToUrl, extensionMap);
       contentMaps.localeUrlsMap = getLocaleUrlsMap(
         urlToInputPath,
         extensionMap
@@ -278,16 +213,19 @@ function EleventyPlugin(eleventyConfig, opts = {}) {
       }
 
       // Already has a language code on it and has a relevant url with the target language code
-      // TODO trailing slash
-      if (contentMaps.localeUrlsMap[url]) {
-        for (let existingUrl of contentMaps.localeUrlsMap[url]) {
-          if (Comparator.urlHasLangCode(existingUrl, langCode)) {
-            return existingUrl;
+      if (
+        contentMaps.localeUrlsMap[url] ||
+        (!url.endsWith("/") && contentMaps.localeUrlsMap[`${url}/`])
+      ) {
+        for (let existingUrlObj of contentMaps.localeUrlsMap[url] ||
+          contentMaps.localeUrlsMap[`${url}/`]) {
+          if (Comparator.urlHasLangCode(existingUrlObj.url, langCode)) {
+            return existingUrlObj.url;
           }
         }
       }
 
-      // Prepend language code to URL
+      // Needs the language code prepended to the URL
       let prependedLangCodeUrl = `/${langCode}${url}`;
       if (
         contentMaps.localeUrlsMap[prependedLangCodeUrl] ||
@@ -304,13 +242,13 @@ function EleventyPlugin(eleventyConfig, opts = {}) {
         // this is not a localized file (independent of a language code)
         if (options.errorMode === "strict") {
           throw new Error(
-            `Localized file for URL ${prependedLangCodeUrl} was not found in your project. A non-localized version does exist—are you sure you meant to use the \`${options.filters.url}\` filter for this? You can bypass this error using the \`errorMode\` option in the I18N plugin (currently: ${options.errorMode}).`
+            `Localized file for URL ${prependedLangCodeUrl} was not found in your project. A non-localized version does exist—are you sure you meant to use the \`${options.filters.url}\` filter for this? You can bypass this error using the \`errorMode\` option in the I18N plugin (current value: "${options.errorMode}").`
           );
         }
       } else if (options.errorMode === "allow-fallback") {
         // You’re linking to a localized file that doesn’t exist!
         throw new Error(
-          `Localized file for URL ${prependedLangCodeUrl} was not found in your project! You will need to add it if you want to link to it using the \`${options.filters.url}\` filter. You can bypass this error using the \`errorMode\` option in the I18N plugin (currently: ${options.errorMode}).`
+          `Localized file for URL ${prependedLangCodeUrl} was not found in your project! You will need to add it if you want to link to it using the \`${options.filters.url}\` filter. You can bypass this error using the \`errorMode\` option in the I18N plugin (current value: "${options.errorMode}").`
         );
       }
 
@@ -318,10 +256,11 @@ function EleventyPlugin(eleventyConfig, opts = {}) {
     }
   );
 
+  // Refactor to use url
   // Find the links that are localized alternates to the inputPath argument
-  eleventyConfig.addFilter(options.filters.links, function (inputPathOverride) {
-    let inputPath = inputPathOverride || getPageInFilter(this)?.inputPath;
-    return contentMaps.localeLinksMap[inputPath] || [];
+  eleventyConfig.addFilter(options.filters.links, function (urlOverride) {
+    let url = urlOverride || getPageInFilter(this)?.url;
+    return contentMaps.localeUrlsMap[url] || [];
   });
 
   // If paginated, returns first result only
@@ -329,9 +268,9 @@ function EleventyPlugin(eleventyConfig, opts = {}) {
     "locale_page", // This is not exposed in `options` because it is an Eleventy internals filter (used in get*CollectionItem filters)
     function (pageOverride) {
       let page = pageOverride || getPageInFilter(this);
-      let url;
-      if (contentMaps.localeLinksMap[page.inputPath]) {
-        for (let entry of contentMaps.localeLinksMap[page.inputPath]) {
+      let url; // new url
+      if (contentMaps.localeUrlsMap[page.url]) {
+        for (let entry of contentMaps.localeUrlsMap[page.url]) {
           if (entry.lang === options.defaultLanguage) {
             url = entry.url;
           }

test/I18nPluginTest.js

@@ -154,6 +154,8 @@ test("locale_url and locale_links Filters", async (t) => {
   t.is(
     getContentFor(results, "/es/index.njk"),
     `/es/
+/es/
+/es/
 /en-us/
 /non-lang-file/
 [{"url":"/en/","lang":"en","label":"English"},{"url":"/en-us/","lang":"en-us","label":"English"}]
@@ -163,6 +165,8 @@ test("locale_url and locale_links Filters", async (t) => {
   t.is(
     getContentFor(results, "/en/index.liquid"),
     `/en/
+/en/
+/en/
 /en-us/
 /non-lang-file/
 [{"url":"/en-us/","lang":"en-us","label":"English"},{"url":"/es/","lang":"es","label":"Español"}]
@@ -172,6 +176,8 @@ test("locale_url and locale_links Filters", async (t) => {
   t.is(
     getContentFor(results, "/en-us/index.11ty.js"),
     `/en-us/
+/en-us/
+/en-us/
 /es/
 /non-lang-file/
 [{"url":"/en/","lang":"en","label":"English"},{"url":"/es/","lang":"es","label":"Español"}]

test/stubs-i18n/en-us/index.11ty.js

 module.exports = function (data) {
   return `${this.locale_url("/")}
+${this.locale_url("/en-us/")}
+${this.locale_url("/es/")}
 ${this.locale_url("/", "es")}
 ${this.locale_url("/non-lang-file/")}
-${JSON.stringify(this.locale_links(data.page.inputPath).sort())}
+${JSON.stringify(this.locale_links(data.page.url).sort())}
 ${JSON.stringify(this.locale_links().sort())}`;
 };

test/stubs-i18n/en/index.liquid

 {{ "/" | locale_url }}
+{{ "/en-us/" | locale_url }}
+{{ "/es/" | locale_url }}
 {{ "/" | locale_url: "en-us" }}
 {{ "/non-lang-file/" | locale_url }}
-{{ page.inputPath | locale_links | json }}
+{{ page.url | locale_links | json }}
 {{ "" | locale_links | json }}
\ No newline at end of file

test/stubs-i18n/es/index.njk

 {{ "/" | locale_url }}
+{{ "/en-us/" | locale_url }}
+{{ "/es/" | locale_url }}
 {{ "/" | locale_url("en-us") }}
 {{ "/non-lang-file/" | locale_url }}
-{{ page.inputPath | locale_links | dump | safe }}
+{{ page.url | locale_links | dump | safe }}
 {{ "" | locale_links | dump | safe }}
\ No newline at end of file

test/stubs-i18n/non-lang-file.njk

 {{ "/" | locale_url }}
 {{ "/" | locale_url("en-us") }}
 {{ "/non-lang-file/" | locale_url }}
-{{ page.inputPath | locale_links | dump | safe }}
+{{ page.url | locale_links | dump | safe }}
 {{ "" | locale_links | dump | safe }}
\ No newline at end of file