Wist is a linter for identifying and reporting errors in Brightscript code. It helps you identify errors before you upload code to your Roku.
For full documentation, please see our user and developer guides here
Wist has one of the most accurate and complete implementations of the Brightscript grammer available right now. It focuses reporting not just syntax violations, but reporting patterns that are likely to result in errors.
-
NodeJS
-
(Optional) JDK8
The easiest and best way to use Wist, is through our editor clients.
- Atom IDE Brightscript
- VSCode coming soon
You can install them through their respective package managers and work out of the box with a .wistrc.json in your root directory.
We recommend taking this approach if you if you want to include Wist as part of your project's build pipeline. Wist is available via as an NPM package and can be installed like so:
$ npm install -g wist
It can be invoked directly using the wist command
$ wist yourfile.brs
Wist can also be installed locally to the project
$ npm install wist --save-dev
After that, you can run Wist in your project's root directory like this:
$ ./node_modules/.bin/wist yourfile.brs
To get started linting your Brightscript project, you should then setup a wist configuration file:
$ wist --init
This will generate a .wistrc.json file in your directory. In it, you'll see some rules configured like this:
{
"rules": {
"no-stop": ["error"],
"no-print": ["warn"]
}
}These configures the sort of errors that the rules engine reports back. There are several other rules that can be configured. See the documentation for the full list.
Once your .wistrc.json has been configured to your liking. Invoke wist on your Brightscript file.
$ wist yourfile.brs
Contributions are welcome. Please see the Contributing guidelines.
Wist has adopted a Code of Conduct defined by the Contributor Covenant. Please see our Code of Conduct as well as our Contributing Guidelines for more information.