docs: Edit this page button link to different branches (#19228)

Tanujkanti4441 · web-flow · commit 98c86a99f765 · 2025-01-08T12:08:51.000-05:00
* docs: edit this page link to different branches

* apply suggestion

* update variable names

* get prerelease info from eslintVersion,js
diff --git a/docs/.eleventy.js b/docs/.eleventy.js
@@ -37,14 +37,15 @@ module.exports = function(eleventyConfig) {
      */
 
     let pathPrefix = "/docs/head/";
+    const isNumberVersion = process.env.BRANCH && /^v\d+\.x$/u.test(process.env.BRANCH);
 
     if (process.env.CONTEXT === "deploy-preview") {
         pathPrefix = "/";
     } else if (process.env.BRANCH === "latest") {
         pathPrefix = "/docs/latest/";
     } else if (process.env.BRANCH === "next") {
         pathPrefix = "/docs/next/";
-    } else if (process.env.BRANCH && /^v\d+\.x$/u.test(process.env.BRANCH)) {
+    } else if (isNumberVersion) {
         pathPrefix = `/docs/${process.env.BRANCH}/`; // `/docs/v8.x/`, `/docs/v9.x/`, `/docs/v10.x/` ...
     }
 
@@ -60,6 +61,7 @@ module.exports = function(eleventyConfig) {
     eleventyConfig.addGlobalData("HEAD", process.env.BRANCH === "main");
     eleventyConfig.addGlobalData("NOINDEX", process.env.BRANCH !== "latest");
     eleventyConfig.addGlobalData("PATH_PREFIX", pathPrefix);
+    eleventyConfig.addGlobalData("is_number_version", isNumberVersion);
     eleventyConfig.addDataExtension("yml", contents => yaml.load(contents));
 
     //------------------------------------------------------------------------------
diff --git a/docs/src/_data/eslintVersions.js b/docs/src/_data/eslintVersions.js
@@ -31,6 +31,7 @@ module.exports = async function() {
     const { items } = data;
 
     let foundItemForThisBranch = false;
+    let isPrereleasePhase = false;
 
     for (const item of items) {
         const isItemForThisBranch = item.branch === thisBranch;
@@ -54,6 +55,10 @@ module.exports = async function() {
         if (isItemForThisBranch) {
             item.selected = true;
         }
+
+        if (item.branch === "next") {
+            isPrereleasePhase = true;
+        }
     }
 
     // Add an empty item if this is not a production branch
@@ -67,5 +72,7 @@ module.exports = async function() {
         });
     }
 
+    data.isPrereleasePhase = isPrereleasePhase;
+
     return data;
 };
diff --git a/docs/src/_data/sites/en.yml b/docs/src/_data/sites/en.yml
@@ -121,4 +121,5 @@ footer:
 
 edit_link:
   start_with: https://github.com/eslint/eslint/edit/main/docs/
+  start_with_latest: https://github.com/eslint/eslint/edit/latest/docs/
   text: Edit this page
diff --git a/docs/src/_data/sites/zh-hans.yml b/docs/src/_data/sites/zh-hans.yml
@@ -119,4 +119,5 @@ footer:
 
 edit_link:
   start_with: https://github.com/eslint/eslint/edit/main/docs/
+  start_with_latest: https://github.com/eslint/eslint/edit/latest/docs/
   text: 编辑此页
diff --git a/docs/src/_includes/layouts/doc.html b/docs/src/_includes/layouts/doc.html
@@ -102,7 +102,13 @@ <h1>{{ title }}</h1>
                 {% if edit_link %}
                     {{ edit_link }}
                 {% else %}
-                    {{ site.edit_link.start_with }}{{ page.inputPath }}
+                    {% if eslintVersions.isPrereleasePhase and GIT_BRANCH === 'latest' %}
+                        {{ site.edit_link.start_with_latest }}{{ page.inputPath }}
+                    {% elseif is_number_version %}
+                        https://github.com/eslint/eslint/edit/{{ GIT_BRANCH }}/docs/{{ page.inputPath }}
+                    {% else %}
+                        {{ site.edit_link.start_with }}{{ page.inputPath }}
+                    {% endif %}
                 {% endif %}
                 "
                 class="c-btn c-btn--secondary">{{ site.edit_link.text }}</a>
