{"id":"plothan/luaubencher","name":"luaubencher","scope":"plothan","platform":"roblox","description":"The public tool for benchmarking Plothan libraries and tools.","version":"0.2.0","latest":"0.2.0","versions":["0.2.0"],"license":"MIT","licenseRating":"safe","licenseCaveats":["License identified from the packaged LICENSE file; the manifest declared none."],"licenseVerified":true,"dependencies":{},"integrity":"f4b7b8d2cb5ca2f86649df89e700de4edc453bfebddc4583b8310d1fa523459f","likes":0,"downloads":0,"install":"forest install plothan/luaubencher","url":"https://forest.dev/p/roblox/plothan/luaubencher","files":"https://api.forest.dev/ai/package/roblox/plothan/luaubencher/files","readme":"# LuauBencher\r\nLuauBencher is a solution for benchmarking code through a flexible framework that provides 3 stages of the benchmarking pipeline for each benchmarking section.\r\n\r\n# Installation\r\nGrab the latest release from github's releases.\r\n\r\n# How to use\r\nUsing LuauBencher is really fun and easy, to start benchmarking a dir or more:\r\n\r\n```lua\r\nlocal LuauBencher = require(path)\r\nlocal dir = game:GetService(\"ContainerService\").directory\r\n\r\nLuauBencher.bootstrapper.run({\r\n    directories = {dir}\r\n})\r\n```\r\nand a .bench.lua(u) file would look like:\r\n```lua\r\nreturn {\r\n    {\r\n      \r\n      name = \"stuff\",\r\n      calls = 1,\r\n      \r\n      preRun = function()\r\n        return param\r\n      end,\r\n      run = function(param)\r\n      -- run to-be-benchmarked code here\r\n      end,\r\n      postRun = function()\r\n      -- in case anything needs to be done after benchmarking process for this section\r\n      end\r\n    }\r\n}\r\n```\r\n","readmeTruncated":false}