checkpoint

rickkas7 · rickkas7 · commit d2887c47783f · 2024-09-27T12:12:26.000-04:00
- conversion tool (not fully working)
diff --git a/scripts/fix-anchors/app.js b/scripts/fix-anchors/app.js
@@ -0,0 +1,112 @@
+#!/usr/bin/env node
+
+const fs = require('fs');
+const path = require('path');
+
+const util = require('util');
+const exec = util.promisify(require('child_process').exec);
+
+const topDir = path.normalize(path.join(__dirname, '..', '..'));
+const srcDir = path.join(topDir, 'src');
+const contentDir = path.join(srcDir, 'content');
+const assetsDir = path.join(srcDir, 'assets');
+const redirectsFile = path.join(topDir, 'config', 'redirects.json');
+
+const firmwareMdPath = path.join(contentDir, 'reference', 'device-os', 'firmware.md');
+
+
+async function run() {
+    const redirectsJson = JSON.parse(fs.readFileSync(redirectsFile, 'utf8'));
+
+    const origStr = fs.readFileSync(firmwareMdPath, 'utf8');
+    let lineArray = [];
+
+    let anchors = {};
+    let sections = ['', ''];
+
+    let lineNum = 0;
+    for(let line of origStr.split('\n')) {
+        lineNum++;
+        if (line.startsWith('## Device OS versions')) {
+            // This is no longer included in the index as it's huge and doesn't render properly either
+            // It must be the last thing in the file, as everything after it is ignored!
+            break;
+        }
+
+        if (line.startsWith('##')) {
+            // Any L2 or higher is an an anchor
+            const m1 = line.match(/^(#+) /);
+            const level = m1[1].length;
+            const spaceIndex = line.indexOf(' ');
+
+            const origPrefix = line.substring(0, spaceIndex + 1);
+            const origTitle = line.substring(spaceIndex + 1).trim().replace(/&/g, '&amp;');
+
+            let origClassName;
+            const m2 = line.match(/ - (.+)$/);
+            if (m2) {
+                origClassName = m2[1];
+            }
+
+            let shortTitle = origTitle;
+            {
+                const offset1 = shortTitle.indexOf('[');
+                if (offset1 > 0) {
+                    shortTitle = shortTitle.substring(0, offset1).trim();
+                }
+                const offset2 = shortTitle.indexOf('(');
+                if (offset2 > 0) {
+                    shortTitle = shortTitle.substring(0, offset2).trim();
+                }                
+            }
+
+            if (level < sections.length) {
+                sections = sections.slice(0, level);
+            }
+            sections[level] = shortTitle;
+
+            let newClassName;
+            if (sections[level - 1].length > 0) {
+                newClassName = sections[level - 1];
+            }
+
+            let origAnchor = origTitle.toLowerCase().replace(/<[^>]+>/g, '').replace(/[^\w]+/g, '-');
+            if (origAnchor === 'constructor') {
+                origAnchor += '-';
+            }
+
+            const origAnchorNoTrailingDash = origAnchor.replace(/[-]+$/g, '');
+
+            /*
+            if (typeof origClassName != 'undefined' && typeof newClassName != 'undefined' && origClassName != newClassName) {
+                console.log('class name changed', {origClassName, newClassName});
+            }
+            */
+
+            if (typeof origClassName == 'undefined') {
+                if (sections[level - 1].length > 0) {
+                    const newTitle = origTitle + ' - ' + sections[level - 1];
+                    line = origPrefix + newTitle;   
+                    console.log('updated title', {newTitle, origTitle, line});    
+                }
+            }
+            else {
+                if (typeof anchors[origAnchor] != 'undefined') {
+                    anchors[origAnchor].push(lineNum);
+                    console.log('non-unique anchor', {origAnchor, level, section: sections[level - 1], lines:anchors[origAnchor], });
+                }
+                else {
+                    anchors[origAnchor] = [lineNum];
+                }    
+            }
+
+        }
+
+        lineArray.push(line);
+    }
+
+    // fs.writeFileSync(firmwareMdPath, lineArray.join('\n'));
+    fs.writeFileSync(redirectsFile, JSON.stringify(redirectsJson, null, 2));
+}
+
+run();
diff --git a/scripts/fix-anchors/package.json b/scripts/fix-anchors/package.json
@@ -0,0 +1,14 @@
+{
+    "name": "fix-amchors",
+    "version": "0.0.1",
+    "description": "",
+    "private": true,
+    "scripts": {},
+    "contributors": [],
+    "license": "MIT",
+    "dependencies": {
+    },
+    "engines": {
+        "node": ">=12.14.0"
+    }
+}
