docs: dynamical URLs in API docs navigation links.

phillipj · jasnell · commit 55012f3df525 · 2016-10-25T07:14:13.000-07:00
Previously the API docs navigation links displayed on to the left on /:language/docs/ had `v4.x` and `v6.x` hardcoded in their URL. These changes fixes that by using the actual LTS/current major versions based on the https://nodejs.org/download/release/index.json.
diff --git a/locale/de/site.json b/locale/de/site.json
@@ -81,12 +81,12 @@
             "text": "FAQ"
         },
         "api-lts": {
-            "link": "/dist/latest-v4.x/docs/api",
+            "link": "/dist/latest-%ver-major%/docs/api",
             "subtext": "LTS",
             "text": "%ver% API"
         },
         "api-current": {
-            "link": "/dist/latest-v6.x/docs/api",
+            "link": "/dist/latest-%ver-major%/docs/api",
             "text": "%ver% API"
         },
         "guides": {
diff --git a/locale/en/site.json b/locale/en/site.json
@@ -81,12 +81,12 @@
             "text": "FAQ"
         },
         "api-lts": {
-            "link": "/dist/latest-v4.x/docs/api",
+            "link": "/dist/latest-%ver-major%/docs/api",
             "subtext": "LTS",
             "text": "%ver% API"
         },
         "api-current": {
-            "link": "/dist/latest-v6.x/docs/api",
+            "link": "/dist/latest-%ver-major%/docs/api",
             "text": "%ver% API"
         },
         "guides": {
diff --git a/locale/es/site.json b/locale/es/site.json
@@ -81,12 +81,12 @@
             "text": "FAQ"
         },
         "api-lts": {
-            "link": "/dist/latest-v4.x/docs/api",
+            "link": "/dist/latest-%ver-major%/docs/api",
             "subtext": "LTS",
             "text": "%ver% API"
         },
         "api-current": {
-            "link": "/dist/latest-v6.x/docs/api",
+            "link": "/dist/latest-%ver-major%/docs/api",
             "text": "%ver% API"
         },
         "guides": {
diff --git a/locale/it/site.json b/locale/it/site.json
@@ -79,12 +79,12 @@
             "text": "FAQ"
         },
         "api-lts": {
-            "link": "/dist/latest-v4.x/docs/api",
+            "link": "/dist/latest-%ver-major%/docs/api",
             "subtext": "LTS",
             "text": "%ver% API"
         },
         "api-current": {
-            "link": "/dist/latest-v6.x/docs/api",
+            "link": "/dist/latest-%ver-major%/docs/api",
             "text": "%ver% API"
         },
         "guides": {
diff --git a/locale/ja/site.json b/locale/ja/site.json
@@ -81,12 +81,12 @@
             "text": "よくある質問"
         },
         "api-lts": {
-            "link": "/dist/latest-v4.x/docs/api",
+            "link": "/dist/latest-%ver-major%/docs/api",
             "subtext": "LTS",
             "text": "%ver% API"
         },
         "api-current": {
-            "link": "/dist/latest-v6.x/docs/api",
+            "link": "/dist/latest-%ver-major%/docs/api",
             "text": "%ver% API"
         },
         "guides": {
diff --git a/locale/ko/site.json b/locale/ko/site.json
@@ -81,12 +81,12 @@
             "text": "FAQ"
         },
         "api-lts": {
-            "link": "/dist/latest-v4.x/docs/api",
+            "link": "/dist/latest-%ver-major%/docs/api",
             "subtext": "LTS",
             "text": "%ver% API"
         },
         "api-current": {
-            "link": "/dist/latest-v6.x/docs/api",
+            "link": "/dist/latest-%ver-major%/docs/api",
             "text": "%ver% API"
         },
         "guides": {
diff --git a/locale/uk/site.json b/locale/uk/site.json
@@ -77,12 +77,12 @@
             "text": "FAQ"
         },
         "api-lts": {
-            "link": "/dist/latest-v4.x/docs/api",
+            "link": "/dist/latest-%ver-major%/docs/api",
             "subtext": "LTS",
             "text": "%ver% API"
         },
         "api-current": {
-            "link": "/dist/latest-v6.x/docs/api",
+            "link": "/dist/latest-%ver-major%/docs/api",
             "text": "%ver% API"
         },
         "guides": {
diff --git a/locale/zh-cn/site.json b/locale/zh-cn/site.json
@@ -81,12 +81,12 @@
             "text": "FAQ"
         },
         "api-lts": {
-            "link": "/dist/latest-v4.x/docs/api",
+            "link": "/dist/latest-%ver-major%/docs/api",
             "subtext": "LTS",
             "text": "%ver% API"
         },
         "api-current": {
-            "link": "/dist/latest-v6.x/docs/api",
+            "link": "/dist/latest-%ver-major%/docs/api",
             "text": "%ver% API"
         },
         "guides": {
diff --git a/scripts/helpers/latestversion.js b/scripts/helpers/latestversion.js
@@ -4,6 +4,7 @@ const semver = require('semver')
 
 const map = (release) => release && {
   node: release.version,
+  nodeMajor: majorStr(release),
   npm: release.npm,
   v8: release.v8,
   openssl: release.openssl
@@ -15,3 +16,7 @@ exports.current = (releases) => {
 }
 
 exports.lts = (releases) => map(releases.find((release) => release.lts))
+
+function majorStr (release) {
+  return `v${semver.major(release.version)}.x`
+}
diff --git a/scripts/plugins/navigation.js b/scripts/plugins/navigation.js
@@ -19,9 +19,11 @@ module.exports = function buildNavigation (latestVersions) {
           // Insert latest versions for API docs
           if (key === 'api-current') {
             obj[key].text = obj[key].text.replace(/%ver%/, latestVersions.current.node)
+            obj[key].link = obj[key].link.replace(/%ver-major%/, latestVersions.current.nodeMajor)
           }
           if (key === 'api-lts') {
             obj[key].text = obj[key].text.replace(/%ver%/, latestVersions.lts.node)
+            obj[key].link = obj[key].link.replace(/%ver-major%/, latestVersions.lts.nodeMajor)
           }
 
           meta.nav[level] = meta.nav[level] || parent
diff --git a/tests/scripts/latestversion.test.js b/tests/scripts/latestversion.test.js
@@ -5,7 +5,7 @@ const test = require('tape')
 const latestversion = require('../../scripts/helpers/latestversion')
 
 test('latestversion.current()', (t) => {
-  t.test('should be greater equal/greater than v5.0.0', (t) => {
+  t.test('should be equal/greater than v5.0.0', (t) => {
     const currentVersion = latestversion.current([
       { version: 'v4.2.1', lts: true },
       { version: 'v0.12.7', lts: false }
@@ -26,6 +26,15 @@ test('latestversion.current()', (t) => {
     t.end()
   })
 
+  t.test('should generate major version string', (t) => {
+    const currentVersion = latestversion.current([
+      { version: 'v7.0.0', lts: false }
+    ])
+
+    t.equal(currentVersion.nodeMajor, 'v7.x')
+    t.end()
+  })
+
   t.end()
 })
 

Original file line number	Diff line number	Diff line change
`@@ -19,9 +19,11 @@ module.exports = function buildNavigation (latestVersions) {`
`19`	`19`	`// Insert latest versions for API docs`
`20`	`20`	`if (key === 'api-current') {`
`21`	`21`	`obj[key].text = obj[key].text.replace(/%ver%/, latestVersions.current.node)`
	`22`	`+ obj[key].link = obj[key].link.replace(/%ver-major%/, latestVersions.current.nodeMajor)`
`22`	`23`	`}`
`23`	`24`	`if (key === 'api-lts') {`
`24`	`25`	`obj[key].text = obj[key].text.replace(/%ver%/, latestVersions.lts.node)`
	`26`	`+ obj[key].link = obj[key].link.replace(/%ver-major%/, latestVersions.lts.nodeMajor)`
`25`	`27`	`}`
`26`	`28`
`27`	`29`	`meta.nav[level] = meta.nav[level] \|\| parent`