{"id":13908743,"url":"https://github.com/willowtreeapps/wist","last_synced_at":"2025-07-18T08:31:16.357Z","repository":{"id":40231825,"uuid":"101094465","full_name":"willowtreeapps/wist","owner":"willowtreeapps","description":"A linter for BrightScript","archived":true,"fork":false,"pushed_at":"2023-04-18T20:40:07.000Z","size":77041,"stargazers_count":43,"open_issues_count":21,"forks_count":11,"subscribers_count":134,"default_branch":"master","last_synced_at":"2025-06-29T15:52:21.008Z","etag":null,"topics":["brightscript","codeformatter","linter","parser","roku","roku-development","wist"],"latest_commit_sha":null,"homepage":null,"language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/willowtreeapps.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2017-08-22T18:22:17.000Z","updated_at":"2023-11-10T02:31:58.000Z","dependencies_parsed_at":"2024-04-16T04:46:13.118Z","dependency_job_id":"7eac26ff-28b3-4125-a82a-00545aa45d98","html_url":"https://github.com/willowtreeapps/wist","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"purl":"pkg:github/willowtreeapps/wist","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/willowtreeapps%2Fwist","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/willowtreeapps%2Fwist/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/willowtreeapps%2Fwist/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/willowtreeapps%2Fwist/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/willowtreeapps","download_url":"https://codeload.github.com/willowtreeapps/wist/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/willowtreeapps%2Fwist/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265728814,"owners_count":23818729,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["brightscript","codeformatter","linter","parser","roku","roku-development","wist"],"created_at":"2024-08-06T23:02:57.289Z","updated_at":"2025-07-18T08:31:15.502Z","avatar_url":"https://github.com/willowtreeapps.png","language":"C++","funding_links":[],"categories":["HarmonyOS"],"sub_categories":["Windows Manager"],"readme":"# Wist\n\n\u003cp align=\"center\"\u003e\n    \u003cimg width=\"200px\" height=\"200px\" src=\"https://user-images.githubusercontent.com/2018617/40627339-63aa1270-628c-11e8-8418-5b0eb88d68e1.png\"/\u003e\n\u003c/p\u003e\n\n[![Node version](https://img.shields.io/node/v/@willowtreeapps/wist.svg?style=flat-square)](https://www.npmjs.com/package/@willowtreeapps/wist)\n[![Npm version](https://img.shields.io/npm/v/@willowtreeapps/wist.svg?style=flat-square)](https://www.npmjs.com/package/@willowtreeapps/wist)\n[![Npm downloads](https://img.shields.io/npm/dt/@willowtreeapps/wist.svg?style=flat-square)](https://www.npmjs.com/package/@willowtreeapps/wist)\n[![Travis branch](https://img.shields.io/travis/willowtreeapps/wist.svg?style=flat-square)](https://travis-ci.org/willowtreeapps/wist)\n\n[Website](https://willowtreeapps.github.io/wist/) |\n[Configuring](https://willowtreeapps.github.io/wist/user-guide/getting-started) |\n[Rules](https://willowtreeapps.github.io/wist/user-guide/rules/) |\n[Contributing](https://willowtreeapps.github.io/wist/developer-guide/contributing/) |\n[Reporting Bugs](https://willowtreeapps.github.io/wist/developer-guide/contributing/#reporting-bugs) |\n[Code of Conduct](https://willowtreeapps.github.io/wist/developer-guide/contributing/code-of-conduct)\n\nWist is a linter for identifying and reporting errors found in Brightscript code. It helps you identify errors before you upload code to your Roku.\n\n\u003cp align=\"center\"\u003e\n    \u003cimg width=\"500px\" src=\"artwork/wist_2.0.gif\"\u003e\n\u003c/p\u003e\n\n**For full documentation, please see our user and developer guides [here](https://willowtreeapps.github.io/wist/)**\n\n## How does it compare to other tools?\n\nWist has one of the most accurate and complete implementations of the Brightscript grammar available right now. \nIt focuses reporting not just syntax violations, but reporting patterns that are likely to result in errors.\n\n## Questions?\n\nJoin us in the #tooling channel on the [Roku Developers Slack](https://join.slack.com/t/rokudevelopers/shared_invite/enQtMzU5Njc5ODM5MzAyLWE2MTIxMWQ5Nzg0Y2E3ODgzYTk4NmQxMDg2YjRjYjdiMzM5ZDU4ZTc0YmM1ZmU0Mzc5MzI3ODU3MmUxOTdlNTE).\n\n## Requirements\n\n* NodeJS\n\n* (Optional) JDK8\n\n\n## Clients\n\nThe easiest and best way to use Wist, is through our editor clients.\n\n* [Atom IDE Brightscript](https://github.com/willowtreeapps/atom-ide-brightscript)\n* [VSCode IDE Brightscript](https://github.com/willowtreeapps/vscode-ide-brightscript)\n\nYou can install them through their respective package managers and work out of the box with a `.wistrc.json` included in your root directory.\n\n## Standalone installation\n\nWe 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:\n\n```\n$ npm install -g @willowtreeapps/wist\n```\n\nIt can be invoked directly using the `wist` command\n\n```\n$ wist yourfile.brs\n```\n\nWist can also be installed locally to the project\n\n```\n$ npm install @willowtreeapps/wist --save-dev\n```\n\nAfter that, you can run Wist in your project's root directory like this:\n\n```\n$ ./node_modules/.bin/wist yourfile.brs\n```\n\n\n## Usage\n\n```\nwist [options] file.brs [file.brs] [dir]\n\nBasic configuration:\n  -i, --init           Initialize Wist\n  -c, --config String  Use specified configuration file\n  -f, --format String  Output format - either: compact, json, stylish, unix, or visualstudio - default: stylish\n  -v, --verbose        Verbose logging\n  -h, --help           Show help\n```\n\nTo get started linting your Brightscript project, you should then setup a wist configuration file:\n\n```\n$ wist --init\n```\n\nThis will generate a `.wistrc.json` file in your directory. In it, you'll see some rules configured like this:\n\n```json\n{\n    \"rules\": {\n        \"no-stop\": [\"error\"],\n        \"no-print\": [\"warn\"]\n    }\n}\n```\n\nThese configures the sort of errors that the [rules engine](https://willowtreeapps.github.io/wist/user-guide/rules-engine) reports back. There are several other rules that can be configured. See the [documentation](https://willowtreeapps.github.io/wist/user-guide/rules/) for the full list.\n\nOnce your `.wistrc.json` has been configured to your liking. Invoke wist on your Brightscript file.\n\n```\n$ wist yourfile.brs\n```\n\n## Wist format (experimental)\n\nWist format or `wist-fmt` is an opinionated code formatter built into Wist. It works by traversing your codes abstract syntax tree and reprinting it with the appropriate whitespace after. `wist-fmt` can be run in a pre-commit hook, or in your CI environments to ensure your codebase has a consistent code style.\n\n```\nUsage: wist-fmt [options] [file.brs]\n\n  -i, --indent Int  Number of tokens to indent\n  --use-tabs        Indent with tabs\n  -h, --help        Show help\n  -v, --version     Show version information\n```\n\nYou can invoke the formatter in the terminal using the `wist-fmt` command.\n\n```\nwist-fmt yourfile.brs\n```\n\nYou can specify the number of spaces used to indent your code using the `-i` flag.\n\n```\nwist-fmt -i 2 yourfile.brs\n```\n\n## Contributing to Wist\n\nContributions are welcome. Please see the [Contributing guidelines](CONTRIBUTING.md).\n\nWist has adopted a [Code of Conduct](CODE_OF_CONDUCT.md) defined by the [Contributor Covenant](http://contributor-covenant.org). Please see our [Code of Conduct](/CODE_OF_CONDUCT.md) as well as our [Contributing Guidelines ](/CONTRIBUTING.md) for more information.\n\n## FAQ\n\n1. How do I run wist on directory or path? \n    \n    You can use the directory syntax to pass a pattern. For example, if I wanted lint all the `*.brs` files in my sources directory, I can do so with this command.\n    \n    ```\n    $ wist source/*.brs\n    ```\n\n2. Wist takes a really long time on large projects\n\n    The reason for this is because Wist currently doesn't run lints in parallel. A work around for this would be to run multiple intances of wist in parallel. For example, \n    \n    ```\n    $ find source/ -name *.brs | xargs -P 8 wist\n    ```\n    \n3. How do I install the latest development version\n\n    You can do this through `npm`. Please note that while the latest development version might \n    have bug fixes and enhancements, it's not guaranteed to be stable until release.\n    \n    You have to first uninstall the current version of Wist you have installed\n    \n    ```\n    $ npm uninstall -g @willowtreeapps/wist\n    ```\n    \n    Then install from the git repository using, \n    \n    ```\n    $ npm install -g git+https://github.com/willowtreeapps/wist.git\n    ```\n    \n    You can also install a version based on a specific commit\n    \n    ```\n    $ npm install -g git+https://github.com/willowtreeapps/wist.git#[commit hash]\n    ```\n    \n    For example,\n    \n    ```\n    $ npm install -g git+https://github.com/willowtreeapps/wist.git#de1e2b6\n    ```\n    \n## License\n\n```\n   Copyright 2018 WillowTree Inc.\n\n   Licensed under the Apache License, Version 2.0 (the \"License\");\n   you may not use this file except in compliance with the License.\n   You may obtain a copy of the License at\n\n       http://www.apache.org/licenses/LICENSE-2.0\n\n   Unless required by applicable law or agreed to in writing, software\n   distributed under the License is distributed on an \"AS IS\" BASIS,\n   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n   See the License for the specific language governing permissions and\n   limitations under the License.\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwillowtreeapps%2Fwist","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwillowtreeapps%2Fwist","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwillowtreeapps%2Fwist/lists"}