Make link to wiki consistent with how LuaLS links to Lua docs

luttje · luttje · commit 0f3934e05444 · 2025-01-22T12:30:11.000+01:00
diff --git a/__tests__/api-writer/glua-api-writer.spec.ts b/__tests__/api-writer/glua-api-writer.spec.ts
@@ -123,7 +123,7 @@ describe('GLua API Writer', () => {
       ],
     });
 
-    expect(api).toEqual(`---![(Shared)](https://github.com/user-attachments/assets/a356f942-57d7-4915-a8cc-559870a980fc) Explodes with an optional intensity.\n---\n---[(View on wiki)](na)\n---@param intensity? number The intensity of the explosion.\n---@return number # The amount of damage done.\nfunction _G.Explode(intensity) end\n\n`);
+    expect(api).toEqual(`---![(Shared)](https://github.com/user-attachments/assets/a356f942-57d7-4915-a8cc-559870a980fc) Explodes with an optional intensity.\n---\n---[View wiki](na)\n---@param intensity? number The intensity of the explosion.\n---@return number # The amount of damage done.\nfunction _G.Explode(intensity) end\n\n`);
   });
 
   it('should allow overriding specific page addresses', () => {
@@ -246,7 +246,7 @@ describe('GLua API Writer', () => {
       ],
     });
 
-    expect(api).toEqual(`---![(Shared)](https://github.com/user-attachments/assets/a356f942-57d7-4915-a8cc-559870a980fc) Returns a table of all bots on the server.\n---\n---[(View on wiki)](na)\n---@return Player[] # A table only containing bots ( AI / non human players )\nfunction player.GetBots() end\n\n`);
+    expect(api).toEqual(`---![(Shared)](https://github.com/user-attachments/assets/a356f942-57d7-4915-a8cc-559870a980fc) Returns a table of all bots on the server.\n---\n---[View wiki](na)\n---@return Player[] # A table only containing bots ( AI / non human players )\nfunction player.GetBots() end\n\n`);
   });
 
   it('should not convert table<type,otherType> to type,otherType[]', () => {
@@ -268,7 +268,7 @@ describe('GLua API Writer', () => {
       ],
     });
 
-    expect(api).toEqual(`---![(Shared)](https://github.com/user-attachments/assets/a356f942-57d7-4915-a8cc-559870a980fc) Returns a table of all bots on the server.\n---\n---[(View on wiki)](na)\n---@return table<number,Player> # A table only containing bots ( AI / non human players )\nfunction player.GetBots() end\n\n`);
+    expect(api).toEqual(`---![(Shared)](https://github.com/user-attachments/assets/a356f942-57d7-4915-a8cc-559870a980fc) Returns a table of all bots on the server.\n---\n---[View wiki](na)\n---@return table<number,Player> # A table only containing bots ( AI / non human players )\nfunction player.GetBots() end\n\n`);
   });
 
   const testFuncPart = {
@@ -298,7 +298,7 @@ describe('GLua API Writer', () => {
           }
         ],
       },
-      output: `---![(Shared)](https://github.com/user-attachments/assets/a356f942-57d7-4915-a8cc-559870a980fc) Just for testing.\n---\n---[(View on wiki)](na)\n---@param value string|number The value to fake.\nfunction test.Fake(value) end\n\n`,
+      output: `---![(Shared)](https://github.com/user-attachments/assets/a356f942-57d7-4915-a8cc-559870a980fc) Just for testing.\n---\n---[View wiki](na)\n---@param value string|number The value to fake.\nfunction test.Fake(value) end\n\n`,
     },
     // Case with pipes in the type (prefered in wiki)
     {
@@ -314,7 +314,7 @@ describe('GLua API Writer', () => {
           }
         ],
       },
-      output: `---![(Shared)](https://github.com/user-attachments/assets/a356f942-57d7-4915-a8cc-559870a980fc) Just for testing.\n---\n---[(View on wiki)](na)\n---@param value string|number The value to fake.\nfunction test.Fake(value) end\n\n`,
+      output: `---![(Shared)](https://github.com/user-attachments/assets/a356f942-57d7-4915-a8cc-559870a980fc) Just for testing.\n---\n---[View wiki](na)\n---@param value string|number The value to fake.\nfunction test.Fake(value) end\n\n`,
     },
     // Case with pipes and table<x> conversion
     {
@@ -330,7 +330,7 @@ describe('GLua API Writer', () => {
           }
         ],
       },
-      output: `---![(Shared)](https://github.com/user-attachments/assets/a356f942-57d7-4915-a8cc-559870a980fc) Just for testing.\n---\n---[(View on wiki)](na)\n---@param value string|table<number,Player> The value to fake.\nfunction test.Fake(value) end\n\n`,
+      output: `---![(Shared)](https://github.com/user-attachments/assets/a356f942-57d7-4915-a8cc-559870a980fc) Just for testing.\n---\n---[View wiki](na)\n---@param value string|table<number,Player> The value to fake.\nfunction test.Fake(value) end\n\n`,
     },
     // Case with table<x> conversion in both altType and type
     {
@@ -347,7 +347,7 @@ describe('GLua API Writer', () => {
           }
         ],
       },
-      output: `---![(Shared)](https://github.com/user-attachments/assets/a356f942-57d7-4915-a8cc-559870a980fc) Just for testing.\n---\n---[(View on wiki)](na)\n---@param value table<number,Player>|table<Entity,number> The value to fake.\nfunction test.Fake(value) end\n\n`,
+      output: `---![(Shared)](https://github.com/user-attachments/assets/a356f942-57d7-4915-a8cc-559870a980fc) Just for testing.\n---\n---[View wiki](na)\n---@param value table<number,Player>|table<Entity,number> The value to fake.\nfunction test.Fake(value) end\n\n`,
     },
   ])('should handle alternate types correctly', async ({ api, output }) => {
     const writer = new GluaApiWriter();
@@ -372,7 +372,7 @@ describe('GLua API Writer', () => {
       ],
     });
 
-    expect(api).toEqual(`---![(Shared)](https://github.com/user-attachments/assets/a356f942-57d7-4915-a8cc-559870a980fc) Just for testing.\n---\n---[(View on wiki)](na)\n---@param value table<string|number>|string The value to fake.\nfunction test.Fake(value) end\n\n`);
+    expect(api).toEqual(`---![(Shared)](https://github.com/user-attachments/assets/a356f942-57d7-4915-a8cc-559870a980fc) Just for testing.\n---\n---[View wiki](na)\n---@param value table<string|number>|string The value to fake.\nfunction test.Fake(value) end\n\n`);
   });
 
   it('should support structure table type', () => {
@@ -394,7 +394,7 @@ describe('GLua API Writer', () => {
       ],
     });
 
-    expect(api).toEqual(`---![(Client)](https://github.com/user-attachments/assets/a5f6ba64-374d-42f0-b2f4-50e5c964e808) Returns where on the screen the specified position vector would appear.\n---\n---[(View on wiki)](na)\n---@return ToScreenData # The created Structures/ToScreenData.\nfunction Vector.ToScreen() end\n\n`);
+    expect(api).toEqual(`---![(Client)](https://github.com/user-attachments/assets/a5f6ba64-374d-42f0-b2f4-50e5c964e808) Returns where on the screen the specified position vector would appear.\n---\n---[View wiki](na)\n---@return ToScreenData # The created Structures/ToScreenData.\nfunction Vector.ToScreen() end\n\n`);
   });
 
   // number{ENUM_NAME} -> ENUM_NAME
@@ -420,7 +420,7 @@ describe('GLua API Writer', () => {
       ],
     });
 
-    expect(api).toEqual(`---![(Client)](https://github.com/user-attachments/assets/a5f6ba64-374d-42f0-b2f4-50e5c964e808) Sets the fog mode.\n---\n---[(View on wiki)](na)\n---@param mode MATERIAL_FOG The fog mode.\nfunction render.FogMode(mode) end\n\n`);
+    expect(api).toEqual(`---![(Client)](https://github.com/user-attachments/assets/a5f6ba64-374d-42f0-b2f4-50e5c964e808) Sets the fog mode.\n---\n---[View wiki](na)\n---@param mode MATERIAL_FOG The fog mode.\nfunction render.FogMode(mode) end\n\n`);
   });
 
   // it('should be able to write Annotated API files directly from wiki pages', async () => {
diff --git a/__tests__/test-data/offline-sites/gmod-wiki/hook-player-initial-spawn.ts b/__tests__/test-data/offline-sites/gmod-wiki/hook-player-initial-spawn.ts
@@ -192,7 +192,7 @@ GM = {}
 --- end )
 --- \`\`\`
 ---
----[(View on wiki)](https://wiki.facepunch.com/gmod/GM:PlayerInitialSpawn)
+---[View wiki](https://wiki.facepunch.com/gmod/GM:PlayerInitialSpawn)
 ---@param player Player The player who spawned.
 ---@param transition boolean If \`true\`, the player just spawned from a map transition.
 function GM:PlayerInitialSpawn(player, transition) end\n\n`;
diff --git a/__tests__/test-data/offline-sites/gmod-wiki/library-function-concommand-gettable.ts b/__tests__/test-data/offline-sites/gmod-wiki/library-function-concommand-gettable.ts
@@ -15,7 +15,7 @@ concommand = {}
 
 ---![(Shared and Menu)](https://github.com/user-attachments/assets/8f5230ff-38f7-493b-b9fc-cc70ffd5b3f4) Returns the tables of all console command callbacks, and autocomplete functions, that were added to the game with [concommand.Add](https://wiki.facepunch.com/gmod/concommand.Add).
 ---
----[(View on wiki)](https://wiki.facepunch.com/gmod/concommand.GetTable)
+---[View wiki](https://wiki.facepunch.com/gmod/concommand.GetTable)
 ---@return table # Table of command callback functions.
 ---@return table # Table of command autocomplete functions.
 function concommand.GetTable() end\n\n`;
diff --git a/__tests__/test-data/offline-sites/gmod-wiki/library-function-coroutine-resume.ts b/__tests__/test-data/offline-sites/gmod-wiki/library-function-coroutine-resume.ts
@@ -17,7 +17,7 @@ coroutine = {}
 
 ---![(Shared and Menu)](https://github.com/user-attachments/assets/8f5230ff-38f7-493b-b9fc-cc70ffd5b3f4) Resumes the given coroutine and passes the given vararg to either the function arguments or the [coroutine.yield](https://wiki.facepunch.com/gmod/coroutine.yield) that is inside that function and returns whatever yield is called with the next time or by the final return in the function.
 ---
----[(View on wiki)](https://wiki.facepunch.com/gmod/coroutine.resume)
+---[View wiki](https://wiki.facepunch.com/gmod/coroutine.resume)
 ---@param coroutine thread Coroutine to resume.
 ---@param ... any Arguments to be returned by coroutine.yield.
 ---@return boolean # If the executed thread code had no errors occur within it.
diff --git a/custom/DMenu.AddOption.lua b/custom/DMenu.AddOption.lua
@@ -1,6 +1,6 @@
 ---![(Client)](https://github.com/user-attachments/assets/a5f6ba64-374d-42f0-b2f4-50e5c964e808) Add an option to the DMenu
 ---
----[(View on wiki)](https://wiki.facepunch.com/gmod/DMenu:AddOption)
+---[View 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.
diff --git a/custom/DMenu.AddPanel.lua b/custom/DMenu.AddPanel.lua
@@ -2,7 +2,7 @@
 ---
 --- 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)
+---[View 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
diff --git a/custom/DMenu.AddSubMenu.lua b/custom/DMenu.AddSubMenu.lua
@@ -1,6 +1,6 @@
 ---![(Client)](https://github.com/user-attachments/assets/a5f6ba64-374d-42f0-b2f4-50e5c964e808) Add a sub menu to the DMenu
 ---
----[(View on wiki)](https://wiki.facepunch.com/gmod/DMenu:AddSubMenu)
+---[View 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
diff --git a/custom/Global.DermaMenu.lua b/custom/Global.DermaMenu.lua
@@ -1,6 +1,6 @@
 ---![(Client and menu)](https://github.com/user-attachments/assets/25d1a1c8-4288-4a51-9867-5e3bb51b9981) Creates a DMenu and closes any current menus.
 ---
----[(View on wiki)](https://wiki.facepunch.com/gmod/Global.DermaMenu)
+---[View 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.
diff --git a/custom/Panel.Add.lua b/custom/Panel.Add.lua
@@ -1,6 +1,6 @@
 ---![(Client and menu)](https://github.com/user-attachments/assets/25d1a1c8-4288-4a51-9867-5e3bb51b9981) Adds the specified object to the panel.
 ---
----[(View on wiki)](https://wiki.facepunch.com/gmod/Panel:Add)
+---[View wiki](https://wiki.facepunch.com/gmod/Panel:Add)
 ---@generic T : Panel
 ---@param object `T` The panel to be added (parented). Can also be:
 --- * string Class Name - creates panel with the specified name and adds it to the panel.
diff --git a/custom/spawnmenu.AddCreationTab.lua b/custom/spawnmenu.AddCreationTab.lua
@@ -1,6 +1,6 @@
 ---![(Client)](https://github.com/user-attachments/assets/a5f6ba64-374d-42f0-b2f4-50e5c964e808) Inserts a new tab into the CreationMenus table, which will be used by the creation menu to generate its tabs (Spawnlists, Weapons, Entities, etc.)
 ---
----[(View on wiki)](https://wiki.facepunch.com/gmod/spawnmenu.AddCreationTab)
+---[View wiki](https://wiki.facepunch.com/gmod/spawnmenu.AddCreationTab)
 ---@generic T : Panel
 ---@param name string What text will appear on the tab (I.E Spawnlists).
 ---@param _function fun(): T The function called to generate the content of the tab.
diff --git a/custom/vgui.Create.lua b/custom/vgui.Create.lua
@@ -1,7 +1,7 @@
 ---![(Client and menu)](https://github.com/user-attachments/assets/25d1a1c8-4288-4a51-9867-5e3bb51b9981) Creates a panel by the specified classname.
 --- Custom VGUI elements are not loaded instantly. Use GM:OnGamemodeLoaded to create them on startup.
 ---
----[(View on wiki)](https://wiki.facepunch.com/gmod/vgui.Create)
+---[View wiki](https://wiki.facepunch.com/gmod/vgui.Create)
 ---@generic T: Panel
 ---@param classname `T` Classname of the panel to create.
 ---
diff --git a/src/api-writer/glua-api-writer.ts b/src/api-writer/glua-api-writer.ts
@@ -429,7 +429,7 @@ export class GluaApiWriter {
 
   private writeFunctionLuaDocComment(func: Function, args: FunctionArgument[] | undefined, realm: Realm) {
     let luaDocComment = `---${this.formatRealm(realm)} ${putCommentBeforeEachLine(func.description!.trim())}\n`;
-    luaDocComment += `---\n---[(View on wiki)](${func.url})\n`;
+    luaDocComment += `---\n---[View wiki](${func.url})\n`;
 
     if (args) {
       args.forEach((arg, index) => {
