You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on May 26, 2023. It is now read-only.
[Code of Conduct](https://willowtreeapps.github.io/wist/developer-guide/contributing/code-of-conduct)
19
+
20
+
21
+
Wist is a linter for identifying and reporting errors found in Brightscript code. It helps you identify errors before you upload code to your Roku.
13
22
14
23
**For full documentation, please see our user and developer guides [here](https://willowtreeapps.github.io/wist/)**
15
24
@@ -36,13 +45,12 @@ The easiest and best way to use Wist, is through our editor clients.
36
45
*[Atom IDE Brightscript](https://github.com/willowtreeapps/atom-ide-brightscript)
37
46
*[VSCode IDE Brightscript](https://github.com/willowtreeapps/vscode-ide-brightscript)
38
47
39
-
You can install them through their respective package managers and work out of the box with a `.wistrc.json` in your root directory.
48
+
You can install them through their respective package managers and work out of the box with a `.wistrc.json`included in your root directory.
40
49
41
50
## Standalone installation
42
51
43
52
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:
44
53
45
-
46
54
```
47
55
$ npm install -g @willowtreeapps/wist
48
56
```
@@ -96,7 +104,7 @@ This will generate a `.wistrc.json` file in your directory. In it, you'll see so
96
104
}
97
105
```
98
106
99
-
These 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](https://willowtreeapps.github.io/wist/user-guide/rules/) that can be configured. See the documentation for the full list.
107
+
These 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.
100
108
101
109
Once your `.wistrc.json` has been configured to your liking. Invoke wist on your Brightscript file.
102
110
@@ -106,12 +114,13 @@ $ wist yourfile.brs
106
114
107
115
## Wist format
108
116
109
-
Wist format is a code formatter built into Wist.
117
+
Wist 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.
110
118
111
119
```
112
120
Usage: wist-fmt [options] [file.brs]
113
121
114
122
-i, --indent Int Number of tokens to indent
123
+
--use-tabs Indent with tabs
115
124
-h, --help Show help
116
125
-v, --version Show version information
117
126
```
@@ -133,3 +142,21 @@ wist-fmt -i 2 yourfile.brs
133
142
Contributions are welcome. Please see the [Contributing guidelines](CONTRIBUTING.md).
134
143
135
144
Wist 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.
145
+
146
+
## License
147
+
148
+
```
149
+
Copyright 2018 WillowTree Inc.
150
+
151
+
Licensed under the Apache License, Version 2.0 (the "License");
152
+
you may not use this file except in compliance with the License.
153
+
You may obtain a copy of the License at
154
+
155
+
http://www.apache.org/licenses/LICENSE-2.0
156
+
157
+
Unless required by applicable law or agreed to in writing, software
158
+
distributed under the License is distributed on an "AS IS" BASIS,
159
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
160
+
See the License for the specific language governing permissions and
0 commit comments