{"id":"daad/debugutil","name":"debugutil","scope":"daad","platform":"roblox","description":"Mirrored from the Wally registry.","version":"0.1.0","latest":"0.1.0","versions":["0.0.1","0.0.2","0.0.3","0.0.4","0.0.5","0.0.6","0.0.7","0.0.8","0.0.9","0.0.10","0.1.0"],"license":"MIT","licenseRating":"safe","licenseCaveats":["The package archive does not include its license text; the license is declared in its manifest metadata."],"licenseVerified":false,"dependencies":{},"integrity":"c2cda79697919f51de681f4966873c578c9032de247946c51a9c3e7a2721a77e","likes":0,"downloads":0,"install":"forest install daad/debugutil","url":"https://forest.dev/p/roblox/daad/debugutil","files":"https://api.forest.dev/ai/package/roblox/daad/debugutil/files","readme":"\r\n# Roblox Debug Tool\r\n\r\nThis module provides simple, configurable debug logging for Roblox projects.\r\n\r\n## Usage\r\n\r\nFirst, require the debug module:\r\n\r\n```lua\r\nlocal DebugUtil = require(path.to.debugutil.init)\r\n```\r\n\r\n### Enable logging for a module\r\n\r\n```lua\r\nDebugUtil.set(\"MyModule\", true) -- Enable all logging for MyModule do\r\nDebugUtil.set(\"someFolder.MyModule\", true) -- Enable all logging for MyModule\r\n\r\nDebugUtil.set(\"MyModule\", { enabled = true, methods = { myMethod = false } })\r\n\r\nDebugUtil.set(\"MyPackage\", { -- Set config for a whole module\r\n\tMyModule = { enabled = true, methods = { init = true } },\r\n})\r\n```\r\n\r\n### Print debug messages\r\n\r\n```lua\r\nDebug.print(\"myMethod\", \"This is a debug message\")\r\nDebug.warn(\"myMethod\", \"This is a warning\")\r\nDebug.error(\"myMethod\", \"This is an error\")\r\n```\r\n\r\nOutput example:\r\n\r\n```\r\n[DEBUG] [MyModule] [myMethod] This is a debug message - MyModuleScript:42\r\n[WARN] [MyModule] [myMethod] This is a warning\r\n[ERROR] [MyModule] [myMethod] This is an error\r\n```\r\n\r\n\r\n\r\n## Example: Overriding DebugUtil with a Package Prefix\r\n\r\nYou can create a wrapper to automatically prefix all debug calls with your package name:\r\n\r\n```lua\r\n-- debugutil/debug.lua\r\nlocal DebugUtil = require(path.to.debugutil)\r\nlocal PACKAGE = \"debugutil\"\r\n\r\nlocal Debug = {}\r\n\r\nfunction Debug.print(moduleName, methodName, ...)\r\n\tDebugUtil.print(PACKAGE .. \".\" .. moduleName .. \".\" .. methodName, ...)\r\nend\r\n\r\nfunction Debug.warn(moduleName, methodName, ...)\r\n\tDebugUtil.warn(PACKAGE .. \".\" .. moduleName .. \".\" .. methodName, ...)\r\nend\r\n\r\nfunction Debug.error(moduleName, methodName, ...)\r\n\tDebugUtil.error(PACKAGE .. \".\" .. moduleName .. \".\" .. methodName, ...)\r\nend\r\n\r\nreturn Debug\r\n```\r\n\r\nUsage in your package:\r\n\r\n```lua\r\nlocal Debug = require(path.to.debugutil.debug)\r\nDebug.print(\"MyModule\", \"myMethod\", \"message\")\r\n```\r\n\r\nThis ensures all logs are prefixed with your package name for easier filtering and configuration.\r\n\r\nSee `init.lua` for more configuration options.\r\n","readmeTruncated":false}