Brslint

Parsing and linting tool for Roku's BrightScript language

Installation

npm i brslint -g

Usage

brslint [path] [options]

If path is a directory brslint will lint .brs files in that directory and all of it's subdirectories.

brslint source                     

brslint source/main.brs

If path is not provided brslint will first look for brslint.config in current directory. If config is not found brslint will run as if . path was provided

brslint.config

brslint.config can be used to customise what file or directories should be linted as well as which rules should be applied.

In the follwing example files in directory1, directory2/subdirectory, their subdirectories and directory/file.brs will be linted. While files in directory1/subdirectory will be excluded

{
    "paths": {
        "include": [
            "directory1",
            "directory2/subdirectory",
            "directory/file.brs"
        ],
        "exclude": [
            "directory1/subdirectory"
        ]
    }
}

You can select your own set of rules as shown below

{
    "rules": {
        "include": [
            "no_empty_then",
            "no_empty_else",
            "function_too_big",
            "function_type",
        ]
    }
}

Some rules can be provided with custom values. In the example below keyword_formatting rule will check that keywords like end if have a single space and capitalised using Pascal rules, i.e Function, While, End For.

{
    "rules": {
        "include": [
            "no_empty_then",
            "no_empty_else"
        ],
        "custom": {
            "keyword_formatting": {
                "space": "single",
                "case": "pascal",
                "keywords": {
                    "?": "print",
                    "and": "AND",
                    "or": "OR",
                    "not": "NOT",
                    "mod": "MOD"
                }
            }
        }
    }
}

You can change severity level of any rule

{
    "rules": {
        "include": [
            "no_empty_else"
        ],
        "custom": {
            "no_empty_then": {
                "level": 1
            }
        }
    }
}