hulu/eslint-brightscript

Lint your Brightscript code with brs and eslint

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.

{
    "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:

{
  "parser": "@hulu/eslint-parser-brightscript",
  "plugins": ["@hulu/eslint-plugin-brightscript"],
  "rules": {
    "@hulu/brightscript/rule-name": "error"
  }
}

eslint-brightscript's Issues

Rule: `then-after-if`

Some codebases require the optional then keyword at the end of an if/else if statement's condition; others forbid it! Some even require it only for the single-line or only for the block variants of if. An eslint rule means humans don't need to watch for that sort of thing during code reviews!

Schema

Name: then-after-if
Options:

• String (enum)
  • Values: "always" | "block-only" | "line-only" | "never"

Examples

Block if statements

if foo then
    print "bar"
end if

Option	Allowed?
always	✅
block-only	✅
line-only	🚫
never	🚫

if foo
    print "bar"
end if

Option	Allowed?
always	🚫
block-only	🚫
line-only	✅
never	✅

Line if statements

if foo then print "bar"

Option	Allowed?
always	✅
block-only	🚫
line-only	✅
never	🚫

if foo print "bar"

Option	Allowed?
always	🚫
block-only	✅
line-only	🚫
never	✅

Rule: `comment-style`

BrightScript comments start with ' or any capitalization of rem. Add a linter rule to ensure those are consistent.

Schema

Name: comment-style
Options:

• String (enum)
  • Values: "'" | "rem" | "Rem" | "REM"

Note: Other capitalizations are intentionally not included here. I imagine very few people prefer to start comments with reM while also wanting that usage to be consistent.

Examples

' lorem ipsum

Option	Allowed?
'	✅
rem	🚫
Rem	🚫
REM	🚫

rem lorem ipsum

Option	Allowed?
'	🚫
rem	✅
Rem	🚫
REM	🚫

Rem lorem ipsum

Option	Allowed?
'	🚫
rem	🚫
Rem	✅
REM	🚫

REM lorem ipsum

Option	Allowed?
'	🚫
rem	🚫
Rem	🚫
REM	✅

Rule: `keyword-case`

Some people prefer keywords to be lowercase (sub main()). Others prefer uppercase (SUB main()), or title-case (Sub main()). Enforce those preferences with an eslint rule

Schema

Name: keyword-case
Options:

• String (enum)
  • Values: "lower" | "title" | "upper"

Examples

if foo then
    print "bar"
end if

Option	Allowed?
lower	✅
title	🚫
upper	🚫

If foo Then
    Print "bar"
End If

Option	Allowed?
lower	🚫
title	✅
upper	🚫

IF foo THEN
    PRINT "bar"
END IF

Option	Allowed?
lower	🚫
title	🚫
upper	✅