brace_linter: Brace linter
| brace_linter | R Documentation |
Brace linter
Description
Perform various style checks related to placement and spacing of curly braces:
Usage
brace_linter(
allow_single_line = FALSE,
function_bodies = c("multi_line", "always", "not_inline", "never")
)
Arguments
allow_single_line |
If |
function_bodies |
When to require function bodies to be wrapped in curly braces. One of
|
Details
Opening curly braces are never on their own line and are always followed by a newline.
Opening curly braces have a space before them.
Closing curly braces are on their own line unless they are followed by an
else.Closing curly braces in
ifconditions are on the same line as the correspondingelse.Either both or neither branch in
if/elseuse curly braces, i.e., either both branches use{...}or neither does.Function bodies are wrapped in curly braces.
Tags
configurable, default, readability, style
See Also
-
linters for a complete list of linters available in lintr.
Examples
# will produce lints
lint(
text = "f <- function() { 1 }",
linters = brace_linter()
)
writeLines("if (TRUE) {\n return(1) }")
lint(
text = "if (TRUE) {\n return(1) }",
linters = brace_linter()
)
# okay
writeLines("f <- function() {\n 1\n}")
lint(
text = "f <- function() {\n 1\n}",
linters = brace_linter()
)
writeLines("if (TRUE) { \n return(1) \n}")
lint(
text = "if (TRUE) { \n return(1) \n}",
linters = brace_linter()
)
# customizing using arguments
writeLines("if (TRUE) { return(1) }")
lint(
text = "if (TRUE) { return(1) }",
linters = brace_linter(allow_single_line = TRUE)
)
