Check that the source contains no TODO comments (case-insensitive).
Usage
todo_comment_linter(todo = c("todo", "fixme"), except_regex = NULL)
Arguments
- todo
Vector of case-insensitive strings that identify TODO comments.
- except_regex
Vector of case-sensitive regular expressions that identify valid TODO comments.
See also
linters for a complete list of linters available in lintr.
Examples
# will produce lints
lint(
text = "x + y # TOODOO",
linters = todo_comment_linter(todo = "toodoo")
)
#> ::warning file=<text>,line=1,col=7::file=<text>,line=1,col=7,[todo_comment_linter] Remove TODO comments.
lint(
text = "pi <- 1.0 # FIIXMEE",
linters = todo_comment_linter(todo = "fiixmee")
)
#> ::warning file=<text>,line=1,col=11::file=<text>,line=1,col=11,[todo_comment_linter] Remove TODO comments.
lint(
text = "x <- TRUE # TOODOO(#1234): Fix this hack.",
linters = todo_comment_linter()
)
# okay
lint(
text = "x + y # my informative comment",
linters = todo_comment_linter()
)
lint(
text = "pi <- 3.14",
linters = todo_comment_linter()
)
lint(
text = "x <- TRUE",
linters = todo_comment_linter()
)
lint(
text = "x <- TRUE # TODO(#1234): Fix this hack.",
linters = todo_comment_linter(except_regex = "TODO\\(#[0-9]+\\):")
)