https://github.com/hulu/eslint-brightscript
Lint your Brightscript code with brs and eslint
https://github.com/hulu/eslint-brightscript
brightscript eslint-plugin linter
Last synced: 9 months ago
JSON representation
Lint your Brightscript code with brs and eslint
- Host: GitHub
- URL: https://github.com/hulu/eslint-brightscript
- Owner: hulu
- License: apache-2.0
- Created: 2021-05-21T16:56:13.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-06-02T20:20:27.000Z (over 2 years ago)
- Last Synced: 2025-04-09T08:51:15.882Z (10 months ago)
- Topics: brightscript, eslint-plugin, linter
- Language: JavaScript
- Homepage:
- Size: 991 KB
- Stars: 3
- Watchers: 11
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ESLint Plugin BrightScript
---
### Getting Started
### Installation
Install eslint if you haven't already:
```
$ yarn add -D eslint
$ npm i --save-dev eslint
```
Then install the parser and plugin:
```
$ yarn add -D @hulu/eslint-parser-brightscript @hulu/eslint-plugin-brightscript
$ npm i --save-dev @hulu/eslint-parser-brightscript @hulu/eslint-plugin-brightscript
```
### Usage
Add the following to your .eslintrc to use the recommended rules.
```json
{
"plugins": ["@hulu/eslint-plugin-brightscript"],
"extends": ["plugin:@hulu/eslint-plugin-brightscript/recommended"]
}
```
You can also ignore the recommended config by including the `@hulu/eslint-parser-brightscript` parser and
`@hulu/eslint-plugin-brightscript` plugin and adding specific rules manually:
```json
{
"parser": "@hulu/eslint-parser-brightscript",
"plugins": ["@hulu/eslint-plugin-brightscript"],
"rules": {
"@hulu/brightscript/rule-name": "error"
}
}
```