lua-fmt requires multiple runs to format a Lua file due to comments

[henriquegemignani]

When formatting the following code sample:

local MyModule = require("MyModule")

--[[
    Small string
]]--



-- ==================
-- = Helper Methods =
-- ==================

local function someFunction()
    return 5
end

We get the following result:

local MyModule = require("MyModule")
 --

--[[
    Small string
]] -- ==================
-- = Helper Methods =
-- ==================

local function someFunction()
    return 5
end

If we run lua-fmt in that snippet, we get this second output:

local MyModule = require("MyModule") -- ==================
--

--[[
    Small string
]] -- = Helper Methods =
-- ==================

local function someFunction()
    return 5
end

A third use gives yet another output:

local MyModule = require("MyModule") -- ================== -- = Helper Methods =
--

--[[
    Small string
]] -- ==================

local function someFunction()
    return 5
end

A fourth use is thankfully final:

local MyModule = require("MyModule") -- ================== -- = Helper Methods = -- ==================
--

--[[
    Small string
]] local function someFunction()
    return 5
end

This simple edit in the original resolves all issues:

local MyModule = require("MyModule")

--[[
    Small string
]]



-- ==================
-- = Helper Methods =
-- ==================

local function someFunction()
    return 5
end

(removed the -- after the "Small string" comment)

Running lua-fmt via vscode-lua 0.12.4