зеркало из https://github.com/microsoft/LightGBM.git
156 строки
6.3 KiB
R
Executable File
156 строки
6.3 KiB
R
Executable File
|
|
loadNamespace("lintr")
|
|
|
|
args <- commandArgs(
|
|
trailingOnly = TRUE
|
|
)
|
|
SOURCE_DIR <- args[[1L]]
|
|
|
|
FILES_TO_LINT <- list.files(
|
|
path = SOURCE_DIR
|
|
, pattern = "\\.r$|\\.rmd$"
|
|
, all.files = TRUE
|
|
, ignore.case = TRUE
|
|
, full.names = TRUE
|
|
, recursive = TRUE
|
|
, include.dirs = FALSE
|
|
)
|
|
|
|
# text to use for pipe operators from packages like 'magrittr'
|
|
pipe_text <- paste0(
|
|
"For consistency and the sake of being explicit, this project's code "
|
|
, "does not use the pipe operator."
|
|
)
|
|
|
|
# text to use for functions that should only be called interactively
|
|
interactive_text <- paste0(
|
|
"Functions like '?', 'help', and 'install.packages()' should only be used "
|
|
, "interactively, not in package code."
|
|
)
|
|
|
|
LINTERS_TO_USE <- list(
|
|
"absolute_path" = lintr::absolute_path_linter()
|
|
, "any_duplicated" = lintr::any_duplicated_linter()
|
|
, "any_is_na" = lintr::any_is_na_linter()
|
|
, "assignment" = lintr::assignment_linter()
|
|
, "backport" = lintr::backport_linter()
|
|
, "boolean_arithmetic" = lintr::boolean_arithmetic_linter()
|
|
, "braces" = lintr::brace_linter()
|
|
, "class_equals" = lintr::class_equals_linter()
|
|
, "commas" = lintr::commas_linter()
|
|
, "conjunct_test" = lintr::conjunct_test_linter()
|
|
, "duplicate_argument" = lintr::duplicate_argument_linter()
|
|
, "empty_assignment" = lintr::empty_assignment_linter()
|
|
, "equals_na" = lintr::equals_na_linter()
|
|
, "fixed_regex" = lintr::fixed_regex_linter()
|
|
, "for_loop_index" = lintr::for_loop_index_linter()
|
|
, "function_left" = lintr::function_left_parentheses_linter()
|
|
, "function_return" = lintr::function_return_linter()
|
|
, "implicit_assignment" = lintr::implicit_assignment_linter()
|
|
, "implicit_integers" = lintr::implicit_integer_linter()
|
|
, "infix_spaces" = lintr::infix_spaces_linter()
|
|
, "inner_combine" = lintr::inner_combine_linter()
|
|
, "is_numeric" = lintr::is_numeric_linter()
|
|
, "lengths" = lintr::lengths_linter()
|
|
, "length_levels" = lintr::length_levels_linter()
|
|
, "length_test" = lintr::length_test_linter()
|
|
, "line_length" = lintr::line_length_linter(length = 120L)
|
|
, "literal_coercion" = lintr::literal_coercion_linter()
|
|
, "matrix" = lintr::matrix_apply_linter()
|
|
, "missing_argument" = lintr::missing_argument_linter()
|
|
, "non_portable_path" = lintr::nonportable_path_linter()
|
|
, "numeric_leading_zero" = lintr::numeric_leading_zero_linter()
|
|
, "outer_negation" = lintr::outer_negation_linter()
|
|
, "package_hooks" = lintr::package_hooks_linter()
|
|
, "paren_body" = lintr::paren_body_linter()
|
|
, "paste" = lintr::paste_linter()
|
|
, "quotes" = lintr::quotes_linter()
|
|
, "redundant_equals" = lintr::redundant_equals_linter()
|
|
, "regex_subset" = lintr::regex_subset_linter()
|
|
, "routine_registration" = lintr::routine_registration_linter()
|
|
, "scalar_in" = lintr::scalar_in_linter()
|
|
, "semicolon" = lintr::semicolon_linter()
|
|
, "seq" = lintr::seq_linter()
|
|
, "spaces_inside" = lintr::spaces_inside_linter()
|
|
, "spaces_left_parens" = lintr::spaces_left_parentheses_linter()
|
|
, "sprintf" = lintr::sprintf_linter()
|
|
, "string_boundary" = lintr::string_boundary_linter()
|
|
, "todo_comments" = lintr::todo_comment_linter(c("todo", "fixme", "to-do"))
|
|
, "trailing_blank" = lintr::trailing_blank_lines_linter()
|
|
, "trailing_white" = lintr::trailing_whitespace_linter()
|
|
, "true_false" = lintr::T_and_F_symbol_linter()
|
|
, "undesirable_function" = lintr::undesirable_function_linter(
|
|
fun = c(
|
|
"cbind" = paste0(
|
|
"cbind is an unsafe way to build up a data frame. merge() or direct "
|
|
, "column assignment is preferred."
|
|
)
|
|
, "dyn.load" = "Directly loading or unloading .dll or .so files in package code should not be necessary."
|
|
, "dyn.unload" = "Directly loading or unloading .dll or .so files in package code should not be necessary."
|
|
, "help" = interactive_text
|
|
, "ifelse" = "The use of ifelse() is dangerous because it will silently allow mixing types."
|
|
, "install.packages" = interactive_text
|
|
, "is.list" = paste0(
|
|
"This project uses data.table, and is.list(x) is TRUE for a data.table. "
|
|
, "identical(class(x), 'list') is a safer way to check that something is an R list object."
|
|
)
|
|
, "rbind" = "data.table::rbindlist() is faster and safer than rbind(), and is preferred in this project."
|
|
, "require" = paste0(
|
|
"library() is preferred to require() because it will raise an error immediately "
|
|
, "if a package is missing."
|
|
)
|
|
)
|
|
)
|
|
, "undesirable_operator" = lintr::undesirable_operator_linter(
|
|
op = c(
|
|
"%>%" = pipe_text
|
|
, "%.%" = pipe_text
|
|
, "%..%" = pipe_text
|
|
, "|>" = pipe_text
|
|
, "?" = interactive_text
|
|
, "??" = interactive_text
|
|
)
|
|
)
|
|
, "unnecessary_concatenation" = lintr::unnecessary_concatenation_linter()
|
|
, "unnecessary_lambda" = lintr::unnecessary_lambda_linter()
|
|
, "unreachable_code" = lintr::unreachable_code_linter()
|
|
, "unused_import" = lintr::unused_import_linter()
|
|
, "vector_logic" = lintr::vector_logic_linter()
|
|
, "whitespace" = lintr::whitespace_linter()
|
|
)
|
|
|
|
noquote(paste0(length(FILES_TO_LINT), " R files need linting"))
|
|
|
|
results <- NULL
|
|
|
|
for (r_file in FILES_TO_LINT) {
|
|
|
|
this_result <- lintr::lint(
|
|
filename = r_file
|
|
, linters = LINTERS_TO_USE
|
|
, cache = FALSE
|
|
)
|
|
|
|
print(
|
|
sprintf(
|
|
"Found %i linting errors in %s"
|
|
, length(this_result)
|
|
, r_file
|
|
)
|
|
, quote = FALSE
|
|
)
|
|
|
|
results <- c(results, this_result)
|
|
|
|
}
|
|
|
|
issues_found <- length(results)
|
|
|
|
noquote(paste0("Total linting issues found: ", issues_found))
|
|
|
|
if (issues_found > 0L) {
|
|
print(results)
|
|
}
|
|
|
|
quit(save = "no", status = issues_found)
|