remove_comments

Parameters

It is important to note that when generating code with the dense or readable generator (e.g. darklua process src --format dense), the comments will already be removed. The only way to retain comments is to use the retain_lines format and avoid this rule.

The except parameter is useful to avoid removing specific comments like --!native (which trigger native compilation of modules when using Luau on Roblox). For example, to avoid removing all comments starting with --!:

{
  rule: "remove_comments",
  except: ["^--!"],
}

Examples

return nil -- this is a comment

return nil 

return nil -- this is a comment

return nil