Switch redirecting over to something more principled

Author: tmeasday

_config.yml

@@ -8,18 +8,32 @@
 
 var _ = require('underscore');
 var nameToId = require('../scripts/nameToId.js');
+var idToName = {};
+_.each(nameToId, function(id, name) {
+  idToName[id] = name;
+});
 var oldToc = require('./old-toc.js');
 
+// these point to X.html
+var idsToPagesWithNoHash = {};
+// these point to X.html#name where name is generated from id below
 var idsToPages = {};
 
 runList = (dir, as) => {
   _.each(as, a => {
+    var aId;
     if (!_.isArray(a) && _.isObject(a)){
+      aId = a.id;
       a = a.name;
     }
 
     if (_.isString(a)) {
-      currFile = `${dir}/${a.toLowerCase()}.html`;
+      var name = a.toLowerCase();
+      currFile = `${dir}/${name}.html`;
+      idsToPagesWithNoHash[name] = currFile;
+      if (aId) {
+        idsToPagesWithNoHash[aId] = currFile;
+      }
     } else {
       addIds = (ids) => {
         _.each(ids, (id) => {
@@ -32,7 +46,8 @@ runList = (dir, as) => {
               }
               id = id.id || id.name;
             }
-            idsToPages[nameToId[id] || id] = currFile;
+            var ourId = (nameToId[id] || id).toLowerCase();
+            idsToPages[ourId] = currFile;
           }
         });
       }
@@ -42,10 +57,24 @@ runList = (dir, as) => {
 };
 
 runList('api', oldToc[2]);
-runList('packages', oldToc[4]);
+
+_.each(oldToc[4][0], id => {
+  var name = id.name || id;
+  idsToPagesWithNoHash[name] = 'packages/' + name + '.html';
+});
 
 _.each(oldToc[6][0], id => {
   idsToPages[id.replace(/\s|\-|\//g, '')] = 'commandline.html';
 });
 
-console.log(JSON.stringify(idsToPages, null, 2));
+_.each(_.union(_.keys(idsToPages), _.keys(idsToPagesWithNoHash)), id => {
+  if (idsToPages[id]) {
+    var page = idsToPages[id];
+    var name = idToName[id] || id;
+    var nameId = name.replace(/[.#]/g, "-");
+    console.log(`  full/${id}: '${page}#${nameId}'`);
+  } else {
+    var page = idsToPagesWithNoHash[id];
+    console.log(`  full/${id}: '${page}'`);
+  }
+});

conversion/convert-toc-to-redirects.js

@@ -305,7 +305,7 @@ module.exports = [
       {name: "Assets.getBinary", id: "assets_getBinary"}
     ],
 
-    {name: "package.js", id: "packagejs"}, [
+    "packagejs", [
       {name: "Package.describe", id: "packagedescription"},
       {name: "Package.onUse", id: "packagedefinition"}, [
         {name: "api.versionsFrom", id: "pack_versions"},
@@ -324,7 +324,7 @@ module.exports = [
       ]
     ],
 
-    {name: "mobile-config.js", id: "mobileconfigjs"}, [
+    "mobile-config", [
       {name: "App.info", id: "App-info"},
       {name: "App.setPreference", id: "App-setPreference"},
       {name: "App.accessRule", id: "App-accessRule"},

conversion/old-toc.js

@@ -30,12 +30,7 @@ hexo.extend.tag.register('apibox', function(args) {
   };
   var data = _.extend({}, defaults, options, apiData({ name: name }));
 
-  if (nameToId[data.longname]) {
-    data.id = nameToId[data.longname];
-  } else {
-    // fallback
-    data.id = data.longname.replace(/[.#]/g, "-");
-  }
+  data.id = data.longname.replace(/[.#]/g, "-");
 
   data.signature = signature(data, { short: false});
   data.title = signature(data, {

scripts/api-box.js

@@ -1,6 +1,5 @@
 // These are the redirects that were previously setup for the docs
-
-module.exports = function() {
+var oldRedirects = function() {
   // make links backwards compatible - for example, #deps -> #tracker
 
   // Links from the old basic API into the closest full-api section
@@ -145,3 +144,10 @@ module.exports = function() {
     window.location = "#" + redirect;
   }
 }
+
+hexo.extend.tag.register('oldRedirects', function(args) {
+  return '<script>\n' +
+    'var oldRedirects = ' + oldRedirects + ';\n' +
+    'oldRedirects();\n' +
+    '</script>';
+});