lint_r_code.R 5.11 KB
Newer Older
1
2
3
4
5
6

library(lintr)

args <- commandArgs(
    trailingOnly = TRUE
)
7
SOURCE_DIR <- args[[1L]]
8
9
10

FILES_TO_LINT <- list.files(
    path = SOURCE_DIR
11
    , pattern = "\\.r$|\\.rmd$"
12
13
14
15
16
17
18
    , all.files = TRUE
    , ignore.case = TRUE
    , full.names = TRUE
    , recursive = TRUE
    , include.dirs = FALSE
)

19
20
21
22
23
24
25
26
27
28
29
30
# 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."
)

31
LINTERS_TO_USE <- list(
32
    "absolute_path"          = lintr::absolute_path_linter()
33
34
    , "any_duplicated"       = lintr::any_duplicated_linter()
    , "any_is_na"            = lintr::any_is_na_linter()
35
36
    , "assignment"           = lintr::assignment_linter()
    , "braces"               = lintr::brace_linter()
37
    , "class_equals_linter"  = lintr::class_equals_linter()
38
    , "commas"               = lintr::commas_linter()
39
    , "duplicate_argument"   = lintr::duplicate_argument_linter()
40
41
42
43
    , "equals_na"            = lintr::equals_na_linter()
    , "function_left"        = lintr::function_left_parentheses_linter()
    , "implicit_integers"    = lintr::implicit_integer_linter()
    , "infix_spaces"         = lintr::infix_spaces_linter()
44
45
    , "inner_combine"        = lintr::inner_combine_linter()
    , "literal_coercion"     = lintr::literal_coercion_linter()
46
    , "long_lines"           = lintr::line_length_linter(length = 120L)
47
    , "missing_argument"     = lintr::missing_argument_linter()
48
49
    , "no_tabs"              = lintr::no_tab_linter()
    , "non_portable_path"    = lintr::nonportable_path_linter()
50
51
52
53
    , "numeric_leading_zero" = lintr::numeric_leading_zero_linter()
    , "outer_negation"       = lintr::outer_negation_linter()
    , "package_hooks"        = lintr::package_hooks_linter()
    , "regex_subset"         = lintr::regex_subset_linter()
54
55
56
57
58
    , "semicolon"            = lintr::semicolon_linter()
    , "seq"                  = lintr::seq_linter()
    , "single_quotes"        = lintr::single_quotes_linter()
    , "spaces_inside"        = lintr::spaces_inside_linter()
    , "spaces_left_parens"   = lintr::spaces_left_parentheses_linter()
59
    , "sprintf"              = lintr::sprintf_linter()
60
    , "todo_comments"        = lintr::todo_comment_linter(c("todo", "fixme", "to-do"))
61
62
63
    , "trailing_blank"       = lintr::trailing_blank_lines_linter()
    , "trailing_white"       = lintr::trailing_whitespace_linter()
    , "true_false"           = lintr::T_and_F_symbol_linter()
64
65
    , "unreachable_code"     = lintr::unreachable_code_linter()
    , "vector_logic"         = lintr::vector_logic_linter()
66
67
    , "undesirable_function" = lintr::undesirable_function_linter(
        fun = c(
68
69
            "cat" = "CRAN forbids the use of cat() in packages except in special cases. Use message() or warning()."
            , "cbind" = paste0(
70
71
72
                "cbind is an unsafe way to build up a data frame. merge() or direct "
                , "column assignment is preferred."
            )
73
74
            , "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."
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
            , "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
            , "?" = interactive_text
            , "??" = interactive_text
        )
    )
98
    , "unneeded_concatenation" = lintr::unneeded_concatenation_linter()
99
100
)

101
noquote(paste0(length(FILES_TO_LINT), " R files need linting"))
102

103
results <- NULL
104

105
for (r_file in FILES_TO_LINT) {
106
107
108
109
110
111
112

    this_result <- lintr::lint(
        filename = r_file
        , linters = LINTERS_TO_USE
        , cache = FALSE
    )

113
114
115
116
117
118
119
120
    print(
        sprintf(
            "Found %i linting errors in %s"
            , length(this_result)
            , r_file
        )
        , quote = FALSE
    )
121
122
123
124
125
126
127

    results <- c(results, this_result)

}

issues_found <- length(results)

128
129
noquote(paste0("Total linting issues found: ", issues_found))

130
if (issues_found > 0L) {
131
132
133
134
    print(results)
}

quit(save = "no", status = issues_found)