From ff722ab88e21799a6785d8f93df537022ab2e95b Mon Sep 17 00:00:00 2001
From: Milos Djermanovic <milos.djermanovic@gmail.com>
Date: Sun, 5 Jun 2022 02:55:45 +0200
Subject: [PATCH 1/6] chore: avoid generating subdirectories for each page on
 new docs site

Refs #15844
---
 docs/.eleventy.js                             | 19 ++++++++++++++++++-
 docs/src/_includes/components/docs-index.html |  2 +-
 docs/src/_includes/layouts/base.njk           |  4 ++--
 docs/src/src.json                             |  3 +++
 docs/src/static/sitemap.njk                   |  2 +-
 5 files changed, 25 insertions(+), 5 deletions(-)
 create mode 100644 docs/src/src.json

diff --git a/docs/.eleventy.js b/docs/.eleventy.js
index ba0c98d5a34..8e518ed3ad9 100644
--- a/docs/.eleventy.js
+++ b/docs/.eleventy.js
@@ -22,7 +22,7 @@ module.exports = function(eleventyConfig) {
      * The path prefix is turned off for deploy previews so we can properly
      * see changes before deployed.
      */
-    const pathPrefix = process.env.CONTEXT === "deploy-preview" ? "" : "/docs";
+    const pathPrefix = process.env.CONTEXT === "production" ? "/docs" : "";
 
     //------------------------------------------------------------------------------
     // Filters
@@ -91,6 +91,23 @@ module.exports = function(eleventyConfig) {
         return markdown.render(value);
     });
 
+    eleventyConfig.addFilter("prettyURL", url => {
+        if (url.endsWith(".html")) {
+            return url.slice(0, -".html".length);
+        }
+
+        return url;
+    });
+
+    eleventyConfig.setBrowserSyncConfig({
+        server: {
+            baseDir: "_site",
+            serveStaticOptions: {
+                extensions: ["html"]
+            }
+        }
+    });
+
     //------------------------------------------------------------------------------
     // Plugins
     //------------------------------------------------------------------------------
diff --git a/docs/src/_includes/components/docs-index.html b/docs/src/_includes/components/docs-index.html
index c915def4b62..0cdbe7403d0 100644
--- a/docs/src/_includes/components/docs-index.html
+++ b/docs/src/_includes/components/docs-index.html
@@ -1,7 +1,7 @@
 {% set navPages = collections.docs | eleventyNavigation %}
 {% macro renderNavListItem(entry) -%}
 <li class="docs-index__item" {% if entry.children.length %}data-has-children {% endif %}>
-    <a href="{{ entry.url | url }}" {% if entry.url == page.url %} aria-current="true" {% endif %}>{{ entry.title }}</a>
+    <a href="{{ entry.url | url | prettyURL }}" {% if entry.url == page.url %} aria-current="true" {% endif %}>{{ entry.title }}</a>
     {%- if entry.children.length -%}
     <ul data-child-list>
         {%- for child in entry.children %}{{ renderNavListItem(child) }}{% endfor -%}
diff --git a/docs/src/_includes/layouts/base.njk b/docs/src/_includes/layouts/base.njk
index 2291db1e777..71aaccb7444 100644
--- a/docs/src/_includes/layouts/base.njk
+++ b/docs/src/_includes/layouts/base.njk
@@ -9,7 +9,7 @@
     <!-- SEO -->
     <title>{{ title }}</title>
     <meta name="description" content="{{ desc }}">
-    <!--<link rel="canonical" href="https://docs.eslint.org{{ page.url | url }}">-->
+    <!--<link rel="canonical" href="https://docs.eslint.org{{ page.url | url | prettyURL }}">-->
 
     <!-- favicon -->
     <link rel="icon" href="/favicon.ico" sizes="any"><!-- 32×32 -->
@@ -25,7 +25,7 @@
     <meta property="og:image:alt" content="{{ coverAlt }}">
     <meta property="og:locale" content="en_US">
     <meta property="og:type" content="website">
-    <meta property="og:url" content="{{ metadata.url }}{{ page.url }}">
+    <meta property="og:url" content="{{ metadata.url }}{{ page.url | url | prettyURL }}">
     <!-- Twitter -->
     <meta name="twitter:title" content="{{ title }}">
     <meta name="twitter:card" content="summary_large_image">
diff --git a/docs/src/src.json b/docs/src/src.json
new file mode 100644
index 00000000000..be7b6160852
--- /dev/null
+++ b/docs/src/src.json
@@ -0,0 +1,3 @@
+{
+    "permalink": "{{ page.filePathStem }}.html"
+}
diff --git a/docs/src/static/sitemap.njk b/docs/src/static/sitemap.njk
index d3cd92e1096..3b02013f499 100644
--- a/docs/src/static/sitemap.njk
+++ b/docs/src/static/sitemap.njk
@@ -6,7 +6,7 @@ eleventyExcludeFromCollections: true
 <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
     {% for page in collections.all %}
         <url>
-            <loc>{{ site.url }}{{ page.url | url }}</loc>
+            <loc>{{ site.url }}{{ page.url | url | prettyURL }}</loc>
             <lastmod>{{ page.date.toISOString() }}</lastmod>
             <changefreq>{{ page.data.changeFreq or &quot;monthly&quot; }}</changefreq>
         </url>

From 1e2a42c2b85deac07fc0fb9fdd4aadf4f8b5cbe3 Mon Sep 17 00:00:00 2001
From: Milos Djermanovic <milos.djermanovic@gmail.com>
Date: Mon, 6 Jun 2022 01:15:27 +0200
Subject: [PATCH 2/6] add comments

---
 docs/.eleventy.js | 38 +++++++++++++++++++++++++++++---------
 1 file changed, 29 insertions(+), 9 deletions(-)

diff --git a/docs/.eleventy.js b/docs/.eleventy.js
index 8e518ed3ad9..4fb7b22d167 100644
--- a/docs/.eleventy.js
+++ b/docs/.eleventy.js
@@ -91,6 +91,11 @@ module.exports = function(eleventyConfig) {
         return markdown.render(value);
     });
 
+    /*
+     * Removes `.html` suffix from the given url.
+     * `page.url` will include the `.html` suffix for all documents
+     * except for those written as `index.html` (their `page.url` ends with a `/`).
+     */
     eleventyConfig.addFilter("prettyURL", url => {
         if (url.endsWith(".html")) {
             return url.slice(0, -".html".length);
@@ -99,15 +104,6 @@ module.exports = function(eleventyConfig) {
         return url;
     });
 
-    eleventyConfig.setBrowserSyncConfig({
-        server: {
-            baseDir: "_site",
-            serveStaticOptions: {
-                extensions: ["html"]
-            }
-        }
-    });
-
     //------------------------------------------------------------------------------
     // Plugins
     //------------------------------------------------------------------------------
@@ -362,6 +358,30 @@ module.exports = function(eleventyConfig) {
 
     // END, eleventy-img
 
+    //------------------------------------------------------------------------------
+    // Settings
+    //------------------------------------------------------------------------------
+
+    /*
+     * When we run `eleventy --serve`, Eleventy 1.x uses browser-sync to serve the content.
+     * By default, browser-sync will not serve `foo/bar.html` when we request `foo/bar`.
+     * Thus, we need to specify "html" in `server.serveStaticOptions.extensions` so that
+     * pretty links without `.html` can work in a local development environment.
+     *
+     * Note that eleventy is doing a shallow merge into its own browser-sync config,
+     * so this will unfortunately completely overwrite `server` settings.
+     * https://github.com/11ty/eleventy/blob/v1.0.1/src/EleventyServe.js#L78-L91
+     * Therefore, we also have to specify `baseDir` here.
+     */
+    eleventyConfig.setBrowserSyncConfig({
+        server: {
+            baseDir: "_site",
+            serveStaticOptions: {
+                extensions: ["html"]
+            }
+        }
+    });
+
 
     return {
         passthroughFileCopy: true,

From 587511f9831986cb26829636f4069cfbf65f96e3 Mon Sep 17 00:00:00 2001
From: Milos Djermanovic <milos.djermanovic@gmail.com>
Date: Mon, 6 Jun 2022 01:35:00 +0200
Subject: [PATCH 3/6] refactor pathPrefix

---
 docs/.eleventy.js | 4 ++--
 docs/package.json | 3 ++-
 2 files changed, 4 insertions(+), 3 deletions(-)

diff --git a/docs/.eleventy.js b/docs/.eleventy.js
index 4fb7b22d167..1683ebc6164 100644
--- a/docs/.eleventy.js
+++ b/docs/.eleventy.js
@@ -19,10 +19,10 @@ module.exports = function(eleventyConfig) {
      * The site is loaded from /docs on eslint.org and so we need to adjust
      * the path prefix so URLs are evaluated correctly.
      *
-     * The path prefix is turned off for deploy previews so we can properly
+     * The path prefix is turned off for `npm start` and deploy previews so we can properly
      * see changes before deployed.
      */
-    const pathPrefix = process.env.CONTEXT === "production" ? "/docs" : "";
+    const pathPrefix = ["local-serve", "deploy-preview"].includes(process.env.CONTEXT) ? "" : "/docs";
 
     //------------------------------------------------------------------------------
     // Filters
diff --git a/docs/package.json b/docs/package.json
index ba963f8e767..84bb061823a 100644
--- a/docs/package.json
+++ b/docs/package.json
@@ -14,7 +14,7 @@
         "watch:eleventy": "eleventy --serve --port=2023",
         "build:sass": "sass --style=compressed src/assets/scss:src/assets/css --no-source-map",
         "build:eleventy": "npx @11ty/eleventy",
-        "start": "npm-run-all build:sass --parallel watch:*  --parallel images",
+        "start": "cross-env CONTEXT=local-serve npm-run-all build:sass --parallel watch:*  --parallel images",
         "build": "npm-run-all build:sass --parallel build:*   --parallel images"
     },
     "devDependencies": {
@@ -24,6 +24,7 @@
         "@11ty/eleventy-plugin-rss": "^1.1.1",
         "@11ty/eleventy-plugin-syntaxhighlight": "^3.1.2",
         "algoliasearch": "^4.12.1",
+        "cross-env": "^7.0.3",
         "dom-parser": "^0.1.6",
         "eleventy-plugin-nesting-toc": "^1.3.0",
         "eleventy-plugin-page-assets": "^0.3.0",

From c5ba8c172faae8657f54c6120edc1fd6c5325ecc Mon Sep 17 00:00:00 2001
From: Milos Djermanovic <milos.djermanovic@gmail.com>
Date: Mon, 6 Jun 2022 02:11:59 +0200
Subject: [PATCH 4/6] update component library permalinks

---
 docs/src/_includes/layouts/components.html | 2 +-
 docs/src/library/library.json              | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/docs/src/_includes/layouts/components.html b/docs/src/_includes/layouts/components.html
index 07670f8e0dc..f4f22cd50b3 100644
--- a/docs/src/_includes/layouts/components.html
+++ b/docs/src/_includes/layouts/components.html
@@ -27,7 +27,7 @@
             <ul class="index__list" id="js-index-list">
                 {% for item in collections.library %}
                 <li class="index__item">
-                    <a href="{{ item.url | url }}" {{ helpers.getLinkActiveState(item.url,
+                    <a href="{{ item.url | url | prettyURL }}" {{ helpers.getLinkActiveState(item.url,
                     page.url) | safe }}>{{ item.data.title }}</a>
                 </li>
                 {% endfor %}
diff --git a/docs/src/library/library.json b/docs/src/library/library.json
index b9cc8311a04..dd622a721c6 100644
--- a/docs/src/library/library.json
+++ b/docs/src/library/library.json
@@ -1,4 +1,4 @@
 {
     "layout": "components.html",
-    "permalink": "/component-library/{{ page.fileSlug }}/index.html"
+    "permalink": "/component-library/{{ page.fileSlug }}.html"
 }

From 59c867bfbc2c075432e80435f01b2a80087cabd7 Mon Sep 17 00:00:00 2001
From: Milos Djermanovic <milos.djermanovic@gmail.com>
Date: Fri, 10 Jun 2022 19:31:26 +0200
Subject: [PATCH 5/6] rewrite URLs

---
 docs/.eleventy.js | 26 ++++++++++++--------------
 docs/package.json |  8 +++++---
 2 files changed, 17 insertions(+), 17 deletions(-)

diff --git a/docs/.eleventy.js b/docs/.eleventy.js
index 1683ebc6164..ed1ffb83162 100644
--- a/docs/.eleventy.js
+++ b/docs/.eleventy.js
@@ -19,10 +19,10 @@ module.exports = function(eleventyConfig) {
      * The site is loaded from /docs on eslint.org and so we need to adjust
      * the path prefix so URLs are evaluated correctly.
      *
-     * The path prefix is turned off for `npm start` and deploy previews so we can properly
+     * The path prefix is turned off for deploy previews so we can properly
      * see changes before deployed.
      */
-    const pathPrefix = ["local-serve", "deploy-preview"].includes(process.env.CONTEXT) ? "" : "/docs";
+    const pathPrefix = process.env.CONTEXT === "deploy-preview" ? "" : "/docs";
 
     //------------------------------------------------------------------------------
     // Filters
@@ -364,25 +364,23 @@ module.exports = function(eleventyConfig) {
 
     /*
      * When we run `eleventy --serve`, Eleventy 1.x uses browser-sync to serve the content.
-     * By default, browser-sync will not serve `foo/bar.html` when we request `foo/bar`.
-     * Thus, we need to specify "html" in `server.serveStaticOptions.extensions` so that
-     * pretty links without `.html` can work in a local development environment.
+     * By default, browser-sync (more precisely, underlying serve-static) will not serve
+     * `foo/bar.html` when we request `foo/bar`. Thus, we need to rewrite URLs to append `.html`
+     * so that pretty links without `.html` can work in a local development environment.
      *
-     * Note that eleventy is doing a shallow merge into its own browser-sync config,
-     * so this will unfortunately completely overwrite `server` settings.
-     * https://github.com/11ty/eleventy/blob/v1.0.1/src/EleventyServe.js#L78-L91
-     * Therefore, we also have to specify `baseDir` here.
+     * There's no need to rewrite URLs that end with `/`, because that already works well
+     * (server will return the content of `index.html` in the directory).
+     * URLs with a file extension, like main.css, main.js, sitemap.xml, etc. should not be rewritten
      */
     eleventyConfig.setBrowserSyncConfig({
-        server: {
-            baseDir: "_site",
-            serveStaticOptions: {
-                extensions: ["html"]
+        middleware: (req, res, next) => {
+            if (!/(?:\.[^/]+|\/)$/u.test(req.url)) {
+                req.url += ".html";
             }
+            return next();
         }
     });
 
-
     return {
         passthroughFileCopy: true,
 
diff --git a/docs/package.json b/docs/package.json
index 84bb061823a..cea6e81c072 100644
--- a/docs/package.json
+++ b/docs/package.json
@@ -14,7 +14,7 @@
         "watch:eleventy": "eleventy --serve --port=2023",
         "build:sass": "sass --style=compressed src/assets/scss:src/assets/css --no-source-map",
         "build:eleventy": "npx @11ty/eleventy",
-        "start": "cross-env CONTEXT=local-serve npm-run-all build:sass --parallel watch:*  --parallel images",
+        "start": "npm-run-all build:sass --parallel watch:*  --parallel images",
         "build": "npm-run-all build:sass --parallel build:*   --parallel images"
     },
     "devDependencies": {
@@ -24,7 +24,6 @@
         "@11ty/eleventy-plugin-rss": "^1.1.1",
         "@11ty/eleventy-plugin-syntaxhighlight": "^3.1.2",
         "algoliasearch": "^4.12.1",
-        "cross-env": "^7.0.3",
         "dom-parser": "^0.1.6",
         "eleventy-plugin-nesting-toc": "^1.3.0",
         "eleventy-plugin-page-assets": "^0.3.0",
@@ -39,5 +38,8 @@
         "rimraf": "^3.0.2",
         "sass": "^1.52.1",
         "slugify": "^1.6.3"
-    }
+    },
+    "engines": {
+        "node": ">=14.0.0"
+      }
 }

From 8f6793aaa79063d8ef9e2112a81411739ef3b0a7 Mon Sep 17 00:00:00 2001
From: Milos Djermanovic <milos.djermanovic@gmail.com>
Date: Fri, 10 Jun 2022 19:35:55 +0200
Subject: [PATCH 6/6] fix indentation in package.json

---
 docs/package.json | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/docs/package.json b/docs/package.json
index cea6e81c072..a42c33aa68f 100644
--- a/docs/package.json
+++ b/docs/package.json
@@ -41,5 +41,5 @@
     },
     "engines": {
         "node": ">=14.0.0"
-      }
+    }
 }