Parse <page> links into markdown links, and fixup local URLs

Author: robotboy655

src/scrapers/wiki-page-markup-scraper.ts

@@ -1,6 +1,6 @@
 import { ScrapeCallback, Scraper } from './scraper.js';
 import { deserializeXml } from '../utils/xml.js';
-import { AnyNode, CheerioAPI } from 'cheerio';
+import { AnyNode, Cheerio, CheerioAPI } from 'cheerio';
 import { Element as DOMElement } from 'domhandler';
 
 export type WikiFunctionType = 'panelfunc' | 'classfunc' | 'libraryfunc' | 'hook';
@@ -140,7 +140,31 @@ export function isClass(page: WikiPage): page is TypePage {
   return page.type === 'class';
 }
 
-// Handle <callback> in a description of an argument/return
+// Handle things like <page> tags, <warning>, etc.
+function markdownifyDescription($: CheerioAPI, e: Cheerio<AnyNode>): string {
+  // <page> => markdown []()
+  for (const page of $(e).find('page')) {
+    const $p = $(page);
+    const url = $p.text();
+    const text = $p.attr("text") || url;
+    $p.replaceWith( `[${text}](${url})` );
+  }
+
+  let description = $(e).text();
+
+  // Fixup []() that use local URLs. This is not exclusive to the result of <page> conversions
+  description = description.replace(/\[([^\]]+)\]\(([^)"]+)(?: \"([^\"]+)\")?\)/g, function(match, text, url) {
+    if (url.indexOf("://") == -1) {
+      return `[${text}](https://wiki.facepunch.com/gmod/${url})`;
+    }
+
+    return match;
+  });
+
+  return description;
+};
+
+// Extract <callback> in a description of an argument/return
 function handleCallbackInDescription($: CheerioAPI, e: AnyNode): [string?, FunctionCallback?] {
   let description: string = "";
   let callback: FunctionCallback = undefined!;
@@ -181,7 +205,7 @@ function handleCallbackInDescription($: CheerioAPI, e: AnyNode): [string?, Funct
         }
       }
     } else {
-      description += $(node).text();
+      description += markdownifyDescription($, $(node));
     }
   }
 
@@ -231,7 +255,7 @@ export class WikiPageMarkupScraper extends Scraper<WikiPage> {
             return <EnumValue>{
               key: $el.attr('key')!,
               value: $el.attr('value')!,
-              description: $el.text(),
+              description: markdownifyDescription($, $el),
               deprecated: deprecated || undefined,
             };
           }).get();
@@ -240,7 +264,7 @@ export class WikiPageMarkupScraper extends Scraper<WikiPage> {
             type: 'enum',
             name: address,
             address: address,
-            description: $('description').text(),
+            description: markdownifyDescription($, $('description')),
             realm: $('realm').text() as Realm,
             items
           };
@@ -270,7 +294,7 @@ export class WikiPageMarkupScraper extends Scraper<WikiPage> {
             type: 'struct',
             name: address,
             address: address,
-            description: $('structure description').text(),
+            description: markdownifyDescription($, $('structure description')),
             realm: $('realm').text() as Realm,
             fields,
             deprecated
@@ -280,7 +304,7 @@ export class WikiPageMarkupScraper extends Scraper<WikiPage> {
             type: 'panel',
             name: address,
             address: address,
-            description: $('panel description').text(),
+            description: markdownifyDescription($, $('panel description')),
             realm: $('realm').text() as Realm,
             parent: $('parent').text(),
             deprecated
@@ -335,7 +359,7 @@ export class WikiPageMarkupScraper extends Scraper<WikiPage> {
             parent: mainElement.attr('parent')!,
             name: mainElement.attr('name')!,
             address: address,
-            description: $('description:first').text(),
+            description: markdownifyDescription($, $('description:first')),
             realm: $('realm:first').text() as Realm,
             arguments: argumentList,
             returns,
@@ -378,7 +402,7 @@ export class WikiPageMarkupScraper extends Scraper<WikiPage> {
             name: $el.attr('name'),
             parent: $el.attr('parent'),
             address: address,
-            description: $('type summary').text(),
+            description: markdownifyDescription($, $('type summary')),
             deprecated: deprecated
           };
         }