BrightScript Formatter

Number of spaces per indent level when useTabs is false.

function main()
  if true then
    print "nested"
  end if
end function

function main()
    if true then
        print "nested"
    end if
end function

Use tab characters instead of spaces for indentation.

function main()
  print "spaces"
end function

function main()
	print "tabs"
end function

Maximum number of consecutive blank lines allowed. 0 = no limit.

function a()
end function



function b()
end function

function a()
end function

function b()
end function

Exact number of blank lines between top-level function/sub declarations.

function a()
end function
function b()
end function

function a()
end function

function b()
end function

Exact number of blank lines between AA method definitions inside a builder function.

Remove all trailing whitespace from the end of each line.

Ensure the file ends with exactly one newline character.

Line ending style. 'auto' preserves the file's existing line endings.

Controls whether compound end keywords use a space ('end if') or are compact ('endif').

if x = 1 then
  print "one"
endif

while x > 0
  x--
endwhile

if x = 1 then
  print "one"
end if

while x > 0
  x--
end while

Controls whether 'then' appears on if conditions.

if x = 1
  print "one"
end if

if y > 0 then print "pos"

if x = 1 then
  print "one"
end if

if y > 0 then print "pos"

Enforce consistent use of function vs sub for procedures that return nothing.

function doWork() as Void
  print "work"
end function

sub doWork()
  print "work"
end sub

Insert a space between the function name and its opening parenthesis in definitions.

function add(a, b)
  return a + b
end function

function add (a, b)
  return a + b
end function

Insert a space between the function keyword and its opening parenthesis in anonymous function expressions.

callback = function(x)
  return x
end function

callback = function (x)
  return x
end function

Insert a space between function name and '(' in call expressions.

result = add(1, 2)
print result

result = add (1, 2)
print result

Enforce spaces inside parentheses in calls and definitions.

result = add(1, 2)

result = add( 1, 2 )

How to align parameters when a function signature spans multiple lines. Note: in BrightScript, multi-line parameter lists require _ line-continuation characters. This pass is not yet implemented — the option is accepted but has no effect on formatting output.

Enforce spaces around binary operators: +, -, *, /, \, ^, <, >, <=, >=, <>, and, or, mod.

x=a+b*c
valid=x>0 and x<100

x = a + b * c
valid = x > 0 and x < 100

Enforce spaces around = in standalone assignment statements.

x=1
name="hello"

x = 1
name = "hello"

Enforce a space after the unary 'not' operator.

result = not valid

result = not valid

Normalize all comment markers to tick (') or rem.

rem initialize the screen
x = 1
' set the value
y = 2

' initialize the screen
x = 1
' set the value
y = 2

Enforce a single space between the comment marker (') and the comment text.

'No space after tick
x = 1  'Also no space

' Space after tick
x = 1  ' Also space

Maximum line length for comment lines. 0 = no limit.

Sort @import statements alphabetically (module-relative imports first, then absolute paths).

' @import /utils/z-helper.brs
' @import /utils/a-helper.brs
' @import /components/Widget.brs

' @import /components/Widget.brs
' @import /utils/a-helper.brs
' @import /utils/z-helper.brs

Insert a blank line after the last @import line and before the first line of code.

' @import /utils/helper.brs
function main()
  print "hello"
end function

' @import /utils/helper.brs

function main()
  print "hello"
end function

Insert a blank line after the function/sub declaration line.

function main()
  x = 1
end function

function main()

  x = 1
end function

Insert a blank line before end function/sub.

function main()
  print "done"
end function

function main()
  print "done"

end function

Insert a blank line before return statements. 'not-alone' skips when return is the only statement.

function getValue()
  x = compute()
  return x
end function

function getValue()
  x = compute()

  return x
end function

Enforce a blank line before a stand-alone comment line.

x = 1
' compute result
y = x + 1

x = 1

' compute result
y = x + 1

Control whether if conditions are wrapped in parentheses. Works on any condition expression including method calls and comparisons (e.g. 'if a.someMethod() > 0' → 'if (a.someMethod() > 0)').

if x = 1 then
  print "one"
end if

if result > threshold then
  print "ok"
end if

if (x = 1) then
  print "one"
end if

if (result > threshold) then
  print "ok"
end if

Intended to control else placement. This pass is not yet implemented — the option is accepted but has no effect on formatting output.

Enforce spaces around 'to' and 'step' keywords in for-loop headers.

for i=1 to 10 step 2
  print i
end for

for i = 1 to 10 step 2
  print i
end for

Spaces inside {} braces for inline associative arrays: { key: value } vs {key: value}.

data = {name: "Alice", age: 30}

data = { name: "Alice", age: 30 }

Trailing comma after the last element in arrays/AA literals.

items = [
  "apple",
  "banana",
  "cherry"
]

items = [
  "apple",
  "banana",
  "cherry",
]

Comma separators between entries in multi-line arrays. BrightScript allows omitting commas when entries are on separate lines.

items = [
  "apple"
  "banana"
]

items = [
  "apple",
  "banana",
]

Comma separators between entries in multi-line associative arrays. BrightScript allows omitting commas when entries are on separate lines.

data = {
  name: "Alice"
  age: 30
}

data = {
  name: "Alice",
  age: 30,
}

Force multi-line layout when an AA has more than this many keys. 0 = no threshold.

data = { a: 1, b: 2, c: 3, d: 4 }

data = {
  a: 1,
  b: 2,
  c: 3,
  d: 4,
}

Split [{ onto separate lines for multi-item array-of-objects.

items = [{ id: 1, name: "a" }, { id: 2, name: "b" }]

items = [
  { id: 1, name: "a" },
  { id: 2, name: "b" },
]

Normalize m-scope field access to dot notation or bracket notation.

m["count"] = m["count"] + 1
m["name"] = "test"

m.count = m.count + 1
m.name = "test"

Align = signs in consecutive assignment statements.

firstName = "John"
lastName = "Doe"
age = 30
isActive = true

firstName = "John"
lastName  = "Doe"
age       = 30
isActive  = true

Enforce observeFieldScoped() over observeField() for task/render-safe observation. Using non-scoped observeField() can cause memory leaks in long-lived Task nodes.

m.top.observeField("myField", "onChanged")

m.top.observeFieldScoped("myField", "onChanged")

Normalize SceneGraph node field access between dot notation and getField()/setField() methods.

value = m.top.getField("myField")
m.top.setField("result", 42)

value = m.top.myField
m.top.result = 42