fix derma panel inheritance

Author: luttje

__tests__/utils/string.spec.ts

@@ -1,4 +1,4 @@
-import { removeNewlines, toLowerCamelCase, putCommentBeforeEachLine } from '../../src/utils/string';
+import { removeNewlines, toLowerCamelCase, putCommentBeforeEachLine, safeFileName } from '../../src/utils/string';
 
 describe('toLowerCamelCase', () => {
   it('should convert a string to lowerCamelCase', () => {
@@ -37,4 +37,19 @@ describe('putCommentBeforeEachLine', () => {
   ])('should put a comment before each line', (input, expected, skipFirstLine = false) => {
     expect(putCommentBeforeEachLine(input, skipFirstLine)).toBe(expected);
   });
+});
+
+describe('safeFileName', () => {
+  it.each([
+    ['hello world','hello world'],
+    ['hello:World', 'hello_World'],
+    ['hello:World', 'hello-World', '-'],
+    ['hello:World', 'helloWorld', ''],
+    ['hello:World', 'hello World', ' '],
+  ])('should make a string "%s" safe ("%s") for use as a file name', (input: string, expected: string, replacement: string|undefined = undefined) => {
+    if (replacement !== undefined)
+      expect(safeFileName(input, replacement)).toBe(expected);
+    else
+      expect(safeFileName(input)).toBe(expected);
+  });
 });

custom/DMenu.AddOption.lua

@@ -0,0 +1,7 @@
+---[CLIENT] Add an option to the DMenu
+---
+---[(View on wiki)](https://wiki.facepunch.com/gmod/DMenu:AddOption)
+---@param name string Name of the option.
+---@param func? function Function to execute when this option is clicked.
+---@return DMenuOption #Returns the created DMenuOption panel.
+function DMenu:AddOption(name, func) end

custom/DMenu.AddPanel.lua

@@ -0,0 +1,8 @@
+---[CLIENT] Adds a panel to the DMenu as if it were an option.
+--- 
+--- This invokes DScrollPanel:AddItem and will not create a new panel if a class name is passed, unlike Panel:Add.
+---
+---[(View on wiki)](https://wiki.facepunch.com/gmod/DMenu:AddPanel)
+---@generic T : Panel
+---@param pnl `T` The panel that you want to add.
+function DMenu:AddPanel(pnl) end

custom/DMenu.AddSubMenu.lua

@@ -0,0 +1,8 @@
+---[CLIENT] Add a sub menu to the DMenu
+---
+---[(View on wiki)](https://wiki.facepunch.com/gmod/DMenu:AddSubMenu)
+---@param Name string Name of the sub menu.
+---@param func? function Function to execute when this sub menu is clicked.
+---@return DMenu, DMenuOption #DMenu - The created sub DMenu
+---@return DMenu, DMenuOption #DMenuOption - The created DMenuOption
+function DMenu:AddSubMenu(Name, func) end

custom/Global.Color.lua

@@ -5,6 +5,6 @@
 ---@param r number An integer from `0-255` describing the red value of the color.
 ---@param g number An integer from `0-255` describing the green value of the color.
 ---@param b number An integer from `0-255` describing the blue value of the color.
----@param a number An integer from `0-255` describing the alpha (transparency) of the color.
+---@param a? number An integer from `0-255` describing the alpha (transparency) of the color.
 ---@return Color #The created Color. Is returned as a table without the Color metatable, [(See GitHub issue)](https://github.com/Facepunch/garrysmod-issues/issues/2407).
 function _G.Color(r, g, b, a) end

custom/Global.DermaMenu.lua

@@ -0,0 +1,7 @@
+---[CLIENT AND MENU] Creates a DMenu and closes any current menus.
+---
+---[(View on wiki)](https://wiki.facepunch.com/gmod/Global.DermaMenu)
+---@param keepOpen? boolean If we should keep other DMenus open (`true`) or not (`false`).
+---@param parent? Panel The panel to parent the created menu to.
+---@return DMenu #The created DMenu.
+function _G.DermaMenu(keepOpen, parent) end

src/api-writer/glua-api-writer.ts

@@ -1,5 +1,5 @@
 import { ClassFunction, Enum, Function, HookFunction, LibraryFunction, Panel, PanelFunction, Realm, Struct, WikiPage, isPanel } from '../scrapers/wiki-page-markup-scraper.js';
-import { putCommentBeforeEachLine, removeNewlines, toLowerCamelCase } from '../utils/string.js';
+import { putCommentBeforeEachLine, removeNewlines, safeFileName, toLowerCamelCase } from '../utils/string.js';
 import {
   isClassFunction,
   isHookFunction,
@@ -62,19 +62,20 @@ export class GluaApiWriter {
   }
 
   public addOverride(pageAddress: string, override: string) {
-    this.pageOverrides.set(pageAddress, override);
+    this.pageOverrides.set(safeFileName(pageAddress, '.'), override);
   }
 
   public writePage(page: WikiPage) {
-    if (this.pageOverrides.has(page.address)) {
+    const fileSafeAddress = safeFileName(page.address, '.');
+    if (this.pageOverrides.has(fileSafeAddress)) {
       let api = '';
 
       if (isClassFunction(page))
         api += this.writeClass(page.parent);
       else if (isLibraryFunction(page))
         api += this.writeLibraryGlobal(page);
 
-      api += this.pageOverrides.get(page.address);
+      api += this.pageOverrides.get(fileSafeAddress);
 
       return `${api}\n\n`;
     } else if (isClassFunction(page))
@@ -184,18 +185,8 @@ export class GluaApiWriter {
       }
     };
 
-    for (const item of _enum.items) {
-      const keys = item.key.split(' or ');
-
-      if (keys.length > 1) {
-        console.warn(`Enum item ${item.key} has multiple keys. This is not supported by the Glua API.`);
-        for (const key of keys) {
-          writeItem(key, item);
-        }
-      } else {
-        writeItem(item.key, item);
-      }
-    }
+    for (const item of _enum.items)
+      writeItem(item.key, item);
 
     if (isContainedInTable)
       api += '}';

src/utils/string.ts

@@ -28,4 +28,15 @@ export function putCommentBeforeEachLine(text: string, skipLineOne: boolean = tr
 
     return `--- ${line}`;
   }).join('\n');
+}
+
+/**
+ * Makes a string safe for use as a file name
+ * 
+ * @param str The string to make safe
+ * @param replacement The string to replace unsafe characters with
+ * @returns The safe string
+ */
+export function safeFileName(str: string, replacement: string = '_') {
+  return str.replace(/[^a-z0-9_\-\. ]/gi, replacement);
 }