Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/RokuRoad/eslint-plugin-roku
ESLint plugin to parse and lint BrightScript files
https://github.com/RokuRoad/eslint-plugin-roku
brightscript codequality eslint eslint-plugin lint linter linter-plugin roku roku-development screengraph vscode
Last synced: about 2 months ago
JSON representation
ESLint plugin to parse and lint BrightScript files
- Host: GitHub
- URL: https://github.com/RokuRoad/eslint-plugin-roku
- Owner: RokuRoad
- License: mit
- Created: 2018-06-10T14:26:03.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-07T19:34:47.000Z (about 2 years ago)
- Last Synced: 2024-11-08T02:42:11.363Z (2 months ago)
- Topics: brightscript, codequality, eslint, eslint-plugin, lint, linter, linter-plugin, roku, roku-development, screengraph, vscode
- Language: TypeScript
- Size: 3.73 MB
- Stars: 44
- Watchers: 5
- Forks: 9
- Open Issues: 31
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-roku - eslint-plugin-roku - eslint plugin for linting brightscript files (Linters)
- awesome-eslint - BrightScript - BrightScript plugin for Roku development. Includes Parser and Rules. (Parsers / Testing Tools)
README
[](https://www.npmjs.com/package/eslint-plugin-roku)
[](http://www.npmtrends.com/eslint-plugin-roku)
[](https://travis-ci.com/RokuRoad/eslint-plugin-roku)
[](https://circleci.com/gh/RokuRoad/eslint-plugin-roku)
[](https://codecov.io/gh/RokuRoad/eslint-plugin-roku)
[](https://david-dm.org/RokuRoad/eslint-plugin-roku) [](https://greenkeeper.io/)
[](https://www.codefactor.io/repository/github/rokuroad/eslint-plugin-roku)
The ESLint custom plugin with rules and parser for `.brs` files.
[Sample Project](./sample)
### ESLint plugin for BrightScript
We going to skip the part why linting is important so you can read more about it at [ESLint](https://eslint.org/docs/about) site. Primary motivation for this development is absence of reliable tools for Roku development (at least at the time this work started) and performance criteria.
*Latest tests gave measurement of about 14 seconds for a 1000 files of BrightScript*
This plugin provides parsing and linting tool for your Roku project. While ESLint rules for Javascript are not 1 to 1 replaceable you are able to quickly develop or translate any other rules to work with brightscript. It's written in typescript but could use any JS- technology you like
### VSCode Integration
``` json
"eslint.validate": [ {
"language": "brightscript",
"autoFix": false
} ],
```
##### Linter Warnings
#### Syntax Errors
### Disable rules with comments
```
? "this is a valid log" ' eslint-disable-line
```
or
```
' eslint-disable-next-line [rule]
? "this is a valid log"
```
note: whole file `eslint-disable` does not work as there is no block quote in brightscript
### Installation
You'll first need to install [ESLint](http://eslint.org):
**With Yarn**
```bash
yarn add --dev eslint
```
**With npm**
```bash
$ npm i eslint --save-dev
```
Next, install `eslint-plugin-roku`:
**With Yarn**
```bash
yarn add --dev eslint-plugin-roku
```
**With npm**
```bash
$ npm install eslint-plugin-roku --save-dev
```
**Note:** If you installed ESLint globally (using the `-g` flag) then you must also install `eslint-plugin-roku` globally.
## Configuration
``` json
{
"extends": "plugin:roku/recommended",
"rules": {
"roku/no-print": "error",
"roku/no-stop": "warn",
"roku/sub-to-function": "warn",
"roku/function-no-return": "warn",
"roku/no-unused-params": "warn",
"roku/function-no-return-type": "warn",
"roku/function-name-camelcase": "warn",
"roku/no-uninitialized-variables": "error",
"roku/no-uninitialized-functions": "error",
}
}
```
## Plugin-Provided Rules
*Just as any other project this one requires more feedback and linting rules ideas*
### Parsing and AST
This documentation will be available at https://github.com/RokuRoad/bright
### Writing rules
https://eslint.org/docs/developer-guide/working-with-rules
### Testing rules
Typical test for a rule will look like
Test runner and valid / invalid factories to wrap your test code into testable solution
``` typescript
import { invalidFactory, runTest, validFactory } from '../helpers'
```
Define name of your rule, it will be used to require it and run tests
``` typescript
const RULE_NAME = 'sub-to-function'
```
Provide prefix and suffix, so you can test function body or root element like library import of the function itself
``` typescript
const valid = validFactory(RULE_NAME, '', '')
const invalid = invalidFactory(RULE_NAME, '', '')
```
Define cases to match against. Invalid cases will provide error messages
``` typescript
runTest(RULE_NAME, {
invalid: [
[
`sub a() as Dynamic
end sub`,
[ { message: 'Sub a should not have a return type (dynamic). Consider replacing it with Function' } ]
]
].map(invalid),
valid: [
`sub a()
print a
end sub
`
].map(valid)
})
```
### SceneGraph
Currently in development, check back soon. Rule will be aware of components tree structure so for instance if function is going to be overwritten or just mistakenly left empty.