Forum Discussion

NND's avatar
NND
Visitor
7 years ago

New code linting tool for BrightScript

If you are interested in improving your coding style and consistency and maybe catching a bug or two check out BrsLint. BrsLint is a tool that parses brightscript and checks code against predefined rules. It also performs static analysts to identify situations that can cause runtime errors, like accessing undefined variable.
BrsLint is written in javascript and works on Windows, macOS and Linux. See it here: https://www.npmjs.com/package/brslint
Roku Developer Program

4 Replies

  • owen777's avatar
    owen777
    Binge Watcher
    7 years ago
    Hey,
    appreciate the job, but, let me be honest with you, it's just another not-so-useful brightscript linter. It misses a lot of very basic rules like indentations, trailing commas, multi spaces, empty lines and so on. Anyway, I really like the "function_too_big" rule which I'd call "fresh" in this hundreds-lines brightscript functions world. By the way, rules documentation would be nice to have.

    Unfortunately, all available brightscript linting tools are quite limited and for our project we had to go the eslint + custom rules way - highly recommend.
  • NND's avatar
    NND
    Visitor
    7 years ago
    You can add some of the rules you've mentioned relatively easily. Unfortunately I don't have time to spend adding bunch of the new rules, but I would take a PR with new rules.
    I am not sure how eslint supposed to help considering that JavaScript and BrightScript have different syntax?
  • NND's avatar
    NND
    Visitor
    7 years ago
    It is nice to have choices for BrightScript parsing for sure. Three years ago my only option was to create my own tools.
    I looked at RokuRoad's parser and while it is pretty solid it did fail on few of my samples. For example it fails on `foo()()`.
    Also on code with conditional compilation like this:
    #if false
     My comments here
    #endif