Merge branch 'main' of https://github.com/filoxen/workspace-detector

detector.luau

@@ -1,3 +1,4 @@
+-- main entry point
 local cli = require("./lib/cli")
 local fileproc = require("./lib/fileproc")
 local fs = require("@lune/fs")

lib/cli.luau

@@ -22,6 +22,7 @@ function cli.parseArgs(): types.opts
         forceBinaryRead = false,
         printInstanceNames = false,
         zlibDecompressFiles = false,
+        zlibDecompressFilesRecursive = false,
         filesToProcess = {}
     }
     if #args < 1 then
@@ -59,6 +60,8 @@ function cli.parseArgs(): types.opts
         elseif arg == "--zlib-decompress" then
             opts.zlibDecompressFiles = true
             i = i + 1
+        elseif arg == "--zlib-decompress-recursive" then
+            opts.zlibDecompressFilesRecursive = true
         else
             if not opts.directoryMode then
                 table.insert(opts.filesToProcess, arg)
@@ -82,6 +85,7 @@ function cli.printUsage()
     stdio.write("       lune run detector --force-binary-read file1 file2.bin file3.robloxmodelfile\n")
     stdio.write("       lune run detector --print-instance-names file1.rbxm\n")
     stdio.write("       lune run detector --zlib-decompress file1.rbxm\n")
+    stdio.write("       lune run detector --zlib-decompress-recursive file1.rbxm\n")
     stdio.write(stdio.color("reset"))
 end
 
@@ -95,4 +99,6 @@ function cli.checkOutputFile(outputFile: string?)
     end
 end
 
+
+
 return cli

lib/compression.luau

@@ -0,0 +1,31 @@
+local serde = require("@lune/serde")
+
+type CompressionModule = {
+    zlibDecompress: (contents: string, recursive: boolean?) -> string | boolean
+}
+
+local compressionModule = {} :: CompressionModule
+
+
+-- take in file contents and zlib decompress them
+-- if recursive param is true repeatedly zlib decompress the file until it fails
+-- (modelscrape files are often double/triple zlib decompressed)
+function compressionModule.zlibDecompress(contents: string, recursive: boolean?): string | boolean
+    assert(typeof(contents) == "string", "Expected contents to be of type 'string'")
+    if recursive == nil then recursive = false end
+    assert(typeof(recursive) == "boolean", "Expected recursive to be of type 'boolean'")
+    local success, decompressed = pcall(function() return serde.decompress("zlib", contents) end)
+    if not success then
+        return false
+    end
+    if recursive then
+        local nextDecompressed = compressionModule.zlibDecompress(decompressed, true)
+        while nextDecompressed do
+            decompressed = nextDecompressed
+            nextDecompressed = compressionModule.zlibDecompress(decompressed, true)
+        end
+    end
+    return decompressed
+end
+
+return compressionModule

lib/core.luau

@@ -1,11 +1,11 @@
 -- handles core detection logic for workspace in models
 local roblox = require("@lune/roblox")
 local stdio  = require("@lune/stdio")
-local serde  = require("@lune/serde")
 local types  = require("./types")
+local compression = require("./compression")
 
 export type Core = {
-    scanForWorkspace:      (model: {Instance}, printInstanceNames: boolean) -> boolean,
+    scanForWorkspace:      (model: types.model, printInstanceNames: boolean) -> boolean,
     isValidModelFile:      (fileName: string) -> boolean,
     fileContainsWorkspace: (fileContents: string, opts: types.opts) -> boolean,
     formatResult:          (result: boolean, fileName: string) -> string
@@ -40,7 +40,7 @@ function core.fileContainsWorkspace(fileContents: string, opts: types.opts): boo
     assert(typeof(fileContents) == "string", "Expected fileContents to be of type 'string'")
     assert(typeof(opts) == "table", "Expected opts to be of type 'table'")
     if opts.zlibDecompressFiles then
-        local success = pcall(function() fileContents = serde.decompress("zlib", fileContents) end)
+        local success = pcall(function() fileContents = compression.zlibDecompress(fileContents, opts.zlibDecompressFilesRecursive) end)
         if not success then
             stdio.write(stdio.color("yellow"))
             stdio.write("Warning: Failed to decompress file with zlib. Proceeding with original contents.\n")

lib/fileproc.luau

@@ -94,7 +94,21 @@ end
 -- if recursive param is true repeatedly zlib decompress the file until it fails
 -- (modelscrape files are often double/triple zlib decompressed)
 function fileproc.zlibDecompress(contents: string, recursive: boolean?): string | boolean
-    error("fileproc.zlibDecompress is not implemented.")
+    assert(typeof(contents) == "string", "Expected contents to be of type 'string'")
+    if recursive == nil then recursive = false end
+    assert(typeof(recursive) == "boolean", "Expected recursive to be of type 'boolean'")
+    local success, decompressed = pcall(function() return serde.decompress("zlib", contents) end)
+    if not success then
+        return false
+    end
+    if recursive then
+        local nextDecompressed = fileproc.zlibDecompress(decompressed, true)
+        while nextDecompressed do
+            decompressed = nextDecompressed
+            nextDecompressed = fileproc.zlibDecompress(decompressed, true)
+        end
+    end
+    return decompressed
 end
 
 return fileproc

lib/types.luau

@@ -9,6 +9,7 @@ export type opts = {
     forceBinaryRead:     boolean,
     printInstanceNames:  boolean,
     zlibDecompressFiles: boolean,
+    zlibDecompressFilesRecursive: boolean,
     filesToProcess:      {string?}
 }