Use invisible characters in lua markdown

Author: NightrainsRbx

server/main.lua

@@ -38,6 +38,7 @@ end
 
 loadArgs()
 
+INV      = "‎"
 ROOT     = fs.path(expanduser(rootPath))
 LOGPATH  = LOGPATH  and expanduser(LOGPATH)  or (ROOT:string() .. '/log')
 METAPATH = METAPATH and expanduser(METAPATH) or (ROOT:string() .. '/meta')

server/script/core/hover/arg.lua

@@ -45,9 +45,9 @@ local function asFunction(source, oop)
                 )
                 if arg.default and arg.default ~= "nil" then
                     if argType == "string" or argType:sub(1, 5) == "Enum." then
-                        args[#args] = args[#args] .. " \f= \"" .. arg.default .. "\""
+                        args[#args] = ("%s %s= \"%s\""):format(args[#args], INV, arg.default)
                     else
-                        args[#args] = args[#args] .. " \f= " .. arg.default
+                        args[#args] = ("%s %s= %s"):format(args[#args], INV, arg.default)
                     end
                 end
             else
@@ -101,7 +101,7 @@ local function asTypeFunction(source, oop)
             end
         end
         if arg.default then
-            args[#args] = args[#args] .. " \f= " .. (arg.default == "" and '""' or arg.default)
+            args[#args+1] = ("%s %s= %s"):format(args[#args], INV, (arg.default == "" and '""' or arg.default))
         end
     end
     if oop then

server/script/core/hover/init.lua

@@ -52,7 +52,7 @@ local function getHoverAsValue(source)
         end
     end
     return {
-        label       = label and "\f" .. label,
+        label       = label and INV .. label,
         source      = source,
         description = desc,
         path        = getPath(source)
@@ -146,7 +146,7 @@ local function getHoverAsTypeFunction(source, values, oop)
             local rtn   = buildReturn(value)
             lines[#lines+1] = ('function %s(%s)'):format(name, arg)
             if rtn then
-                lines[#lines+1] = "\f" .. rtn .. "\f"
+                lines[#lines+1] = INV .. rtn .. INV
             end
         else
             other = other + 1

server/script/core/hover/label.lua

@@ -17,7 +17,7 @@ local function asFunction(source, oop)
     local lines = {}
     lines[1] = ('function %s(%s)'):format(name, arg)
     if rtn then
-        lines[2] = "\f" .. rtn .. "\f"
+        lines[2] = INV .. rtn .. INV
     end
     return table.concat(lines, '\n')
 end
@@ -29,7 +29,7 @@ local function asDocFunction(source)
     local lines = {}
     lines[1] = ('function %s(%s)'):format(name, arg)
     if rtn then
-        lines[2] = "\f" .. rtn .. "\f"
+        lines[2] = INV .. rtn .. INV
     end
     return table.concat(lines, '\n')
 end
@@ -42,7 +42,7 @@ local function asFunctionType(source, oop)
     local lines = {}
     lines[1] = ('function %s(%s)'):format(name, arg)
     if rtn then
-        lines[2] = "\f" .. rtn .. "\f"
+        lines[2] = INV .. rtn .. INV
     end
     return table.concat(lines, '\n')
 end

server/script/core/hover/return.lua

@@ -61,7 +61,7 @@ local function asTypeAnn(typeAnn)
     local line = {}
     for i = 1, #returns do
         if i == 1 then
-            line[#line+1] = '  -> ' .. returns[i]
+            line[#line+1] = '  -> ' .. returns[i]
         else
             line[#line+1] = ('% 3d. %s'):format(i, returns[i])
         end
@@ -83,7 +83,7 @@ local function asFunction(source)
         local line = {}
         local types = {}
         if i == 1 then
-            line[#line+1] = '  -> '
+            line[#line+1] = '  -> '
         else
             line[#line+1] = ('% 3d. '):format(i)
         end
@@ -133,7 +133,7 @@ local function asDocFunction(source)
             rtn.optional and '?' or ''
         )
         if i == 1 then
-            returns[#returns+1] = ('  -> %s'):format(rtnText)
+            returns[#returns+1] = ('  -> %s'):format(rtnText)
         else
             returns[#returns+1] = ('% 3d. %s'):format(i, rtnText)
         end

server/script/core/hover/table.lua

@@ -119,13 +119,13 @@ local function buildAsHash(classes, literals, reachMax)
         local class   = classes[key]
         local literal = literals[key]
         if literal then
-            lines[#lines+1] = ('    %s: %s = %s,'):format(key, class, literal)
+            lines[#lines+1] = ('    %s: %s = %s,'):format(key, class, literal)
         else
-            lines[#lines+1] = ('    %s: %s,'):format(key, class)
+            lines[#lines+1] = ('    %s: %s,'):format(key, class)
         end
     end
     if reachMax then
-        lines[#lines+1] = '    ...'
+        lines[#lines+1] = '    ...'
     end
     lines[#lines+1] = '}'
     return table.concat(lines, '\n')
@@ -145,13 +145,13 @@ local function buildAsConst(classes, literals, reachMax)
         local class   = classes[key]
         local literal = literals[key]
         if literal then
-            lines[#lines+1] = ('    %s: %s = %s,'):format(key, class, literal)
+            lines[#lines+1] = ('    %s: %s = %s,'):format(key, class, literal)
         else
-            lines[#lines+1] = ('    %s: %s,'):format(key, class)
+            lines[#lines+1] = ('    %s: %s,'):format(key, class)
         end
     end
     if reachMax then
-        lines[#lines+1] = '    ...'
+        lines[#lines+1] = '    ...'
     end
     lines[#lines+1] = '}'
     return table.concat(lines, '\n')

server/script/core/signature.lua

@@ -52,7 +52,7 @@ end
 
 local function makeOneSignature(source, oop, index)
     local label = hoverLabel(source, oop)
-    label = label:gsub('%s*\f%s*->.+', ''):gsub("\f", "")
+    label = label:gsub("[%s ]*" .. INV .. "[%s ]*%-%>.+", ""):gsub(INV, "")
     local argStart, argLabel = label:match("()(%b())$")
     argLabel = argLabel:sub(2, #argLabel - 1)
     for _, pattern in ipairs({"()", "{}", "[]", "<>"}) do

server/script/library/rbxlibs.lua

@@ -406,7 +406,7 @@ local function parseMembers(data, isObject)
             local child = {}
             if params and #params > 0 then
                 local paramsStr = require("core.guide").buildTypeAnn(params)
-                paramsLabel = string.format("\n\f\f  -> %s\n", paramsStr)
+                paramsLabel = string.format("\n%s  -> %s\n", INV .. INV, paramsStr)
                 child[1] = {
                     name = "Wait",
                     type = "type.library",

server/script/vm/getType.lua

@@ -11,7 +11,7 @@ function vm.getTypeString(source, deep)
         if infer.source and infer.source.type == "type.table" then
             local fields = {}
             for _, field in ipairs(infer.source) do
-                fields[#fields+1] = "\t" .. guide.buildTypeAnn(field)
+                fields[#fields+1] = "    " .. guide.buildTypeAnn(field)
             end
             return ("{\n%s\n}"):format(table.concat(fields, ",\n"))
         end

syntaxes/lua.tmLanguage.json

@@ -531,8 +531,8 @@
 		"hover": {
 			"patterns": [
 				{
-					"begin": "\\f\\b(global|field|event|property|child|callback)\\b (\\w*)\\.?([\\w.]*)(:) ",
-					"end": "\\f",
+					"begin": "[‎]\\b(global|field|event|property|child|callback)\\b (\\w*)\\.?([\\w.]*)(:) ",
+					"end": "[‎]",
 					"beginCaptures": {
 						"1": {
 							"name": "storage"
@@ -554,8 +554,8 @@
 					]
 				},
 				{
-					"begin": "\\f\\s*-> ",
-					"end": "\\f",
+					"begin": "[‎]\\s*-> ",
+					"end": "[‎]",
 					"patterns": [
 						{
 							"match": "(\\w+): (\\w+(\\.)?\\w*)",
@@ -577,7 +577,7 @@
 					]
 				},
 				{
-					"begin": " \\f= ",
+					"begin": " [‎]= ",
 					"end": "[),]",
 					"patterns": [
 						{
@@ -586,7 +586,7 @@
 					]
 				},
 				{
-					"match": "\\f(type)\\s+(\\w+(\\.)?\\w*)",
+					"match": "[‎](type)\\s+(\\w+(\\.)?\\w*)",
 					"captures": {
 						"1": {
 							"name": "storage.type.lua"