1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
|
#/
# @license Apache-2.0
#
# Copyright (c) 2017 The Stdlib Authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#/
# VARIABLES #
# Define the R linter:
R_LINTER ?= $(RSCRIPT) $(TOOLS_DIR)/lint/r/linter.R
# Define the command-line options to be used when invoking the executable:
R_LINTER_FLAGS ?=
# RULES #
#/
# Lints R files.
#
# ## Notes
#
# - This rule supports the environment variables supported by each context-specific (`lint-r-<context>`) prerequisite.
# - This rule is useful when wanting to glob for files, irrespective of context, for a particular package in order to lint all contained R files.
#
# @param {string} [SOURCES_FILTER] - file path pattern (e.g., `.*/blas/base/dasum/.*`)
# @param {string} [TESTS_FIXTURES_FILTER] - file path pattern (e.g., `.*/blas/base/dasum/.*`)
# @param {string} [EXAMPLES_FILTER] - file path pattern (e.g., `.*/blas/base/dasum/.*`)
# @param {string} [BENCHMARKS_FILTER] - file path pattern (e.g., `.*/blas/base/dasum/.*`)
# @param {*} [FAST_FAIL] - flag indicating whether to stop linting upon encountering a lint error
#
# @example
# make lint-r
#
# @example
# make lint-r SOURCES_FILTER=".*/blas/base/dasum/.*" TESTS_FIXTURES_FILTER=".*/blas/base/dasum/.*" EXAMPLES_FILTER=".*/blas/base/dasum/.*" BENCHMARKS_FILTER=".*/blas/base/dasum/.*"
#/
lint-r: lint-r-src lint-r-tests-fixtures lint-r-examples lint-r-benchmarks
.PHONY: lint-r
#/
# Lints R source files.
#
# ## Notes
#
# - This rule is useful when wanting to glob for R source files (e.g., lint all R source files for a particular package).
#
# @param {string} [SOURCES_FILTER] - file path pattern (e.g., `.*/math/base/special/abs/.*`)
# @param {*} [FAST_FAIL] - flag indicating whether to stop linting upon encountering a lint error
#
# @example
# make lint-r-src
#
# @example
# make lint-r-src SOURCES_FILTER=".*/math/base/special/abs/.*"
#/
lint-r-src:
ifeq ($(FAIL_FAST), true)
$(QUIET) $(FIND_R_SOURCES_CMD) | grep '^[\/]\|^[a-zA-Z]:[/\]' | while read -r file; do \
echo ''; \
echo "Linting file: $$file"; \
$(R_LINTER) $(R_LINTER_FLAGS) $$file || exit 1; \
done
else
$(QUIET) $(FIND_R_SOURCES_CMD) | grep '^[\/]\|^[a-zA-Z]:[/\]' | while read -r file; do \
echo ''; \
echo "Linting file: $$file"; \
$(R_LINTER) $(R_LINTER_FLAGS) $$file || echo 'Linting failed.'; \
done
endif
.PHONY: lint-r-src
#/
# Lints R test fixture files.
#
# ## Notes
#
# - This rule is useful when wanting to glob for R test fixture files (e.g., lint all R test fixture files for a particular package).
#
# @param {string} [TESTS_FIXTURES_FILTER] - file path pattern (e.g., `.*/math/base/special/abs/.*`)
# @param {*} [FAST_FAIL] - flag indicating whether to stop linting upon encountering a lint error
#
# @example
# make lint-r-tests-fixtures
#
# @example
# make lint-r-tests-fixtures TESTS_FIXTURES_FILTER=".*/math/base/special/abs/.*"
#/
lint-r-tests-fixtures:
ifeq ($(FAIL_FAST), true)
$(QUIET) $(FIND_R_TESTS_FIXTURES_CMD) | grep '^[\/]\|^[a-zA-Z]:[/\]' | while read -r file; do \
echo ''; \
echo "Linting file: $$file"; \
$(R_LINTER) $(R_LINTER_FLAGS) $$file || exit 1; \
done
else
$(QUIET) $(FIND_R_TESTS_FIXTURES_CMD) | grep '^[\/]\|^[a-zA-Z]:[/\]' | while read -r file; do \
echo ''; \
echo "Linting file: $$file"; \
$(R_LINTER) $(R_LINTER_FLAGS) $$file || echo 'Linting failed.'; \
done
endif
.PHONY: lint-r-tests-fixtures
#/
# Lints R examples files.
#
# ## Notes
#
# - This rule is useful when wanting to glob for R examples files (e.g., lint all R examples files for a particular package).
#
# @param {string} [EXAMPLES_FILTER] - file path pattern (e.g., `.*/math/base/special/abs/.*`)
# @param {*} [FAST_FAIL] - flag indicating whether to stop linting upon encountering a lint error
#
# @example
# make lint-r-examples
#
# @example
# make lint-r-examples EXAMPLES_FILTER=".*/math/base/special/abs/.*"
#/
lint-r-examples:
ifeq ($(FAIL_FAST), true)
$(QUIET) $(FIND_R_EXAMPLES_CMD) | grep '^[\/]\|^[a-zA-Z]:[/\]' | while read -r file; do \
echo ''; \
echo "Linting file: $$file"; \
$(R_LINTER) $(R_LINTER_FLAGS) $$file || exit 1; \
done
else
$(QUIET) $(FIND_R_EXAMPLES_CMD) | grep '^[\/]\|^[a-zA-Z]:[/\]' | while read -r file; do \
echo ''; \
echo "Linting file: $$file"; \
$(R_LINTER) $(R_LINTER_FLAGS) $$file || echo 'Linting failed.'; \
done
endif
.PHONY: lint-r-examples
#/
# Lints R benchmark files.
#
# ## Notes
#
# - This rule is useful when wanting to glob for R benchmark files (e.g., lint all R benchmark files for a particular package).
#
# @param {string} [BENCHMARKS_FILTER] - file path pattern (e.g., `.*/math/base/special/abs/.*`)
# @param {*} [FAST_FAIL] - flag indicating whether to stop linting upon encountering a lint error
#
# @example
# make lint-r-benchmarks
#
# @example
# make lint-r-benchmarks BENCHMARKS_FILTER=".*/math/base/special/abs/.*"
#/
lint-r-benchmarks:
ifeq ($(FAIL_FAST), true)
$(QUIET) $(FIND_R_BENCHMARKS_CMD) | grep '^[\/]\|^[a-zA-Z]:[/\]' | while read -r file; do \
echo ''; \
echo "Linting file: $$file"; \
$(R_LINTER) $(R_LINTER_FLAGS) $$file || exit 1; \
done
else
$(QUIET) $(FIND_R_BENCHMARKS_CMD) | grep '^[\/]\|^[a-zA-Z]:[/\]' | while read -r file; do \
echo ''; \
echo "Linting file: $$file"; \
$(R_LINTER) $(R_LINTER_FLAGS) $$file || echo 'Linting failed.'; \
done
endif
.PHONY: lint-r-benchmarks
#/
# Lints a specified list of R files.
#
# ## Notes
#
# - This rule is useful when wanting to lint a list of R files generated by some other command (e.g., a list of changed R files obtained via `git diff`).
#
# @param {string} FILES - list of R file paths
# @param {*} [FAST_FAIL] - flag indicating whether to stop linting upon encountering a lint error
#
# @example
# make lint-r-files FILES='/foo/file.R /bar/file.R'
#/
lint-r-files:
ifeq ($(FAIL_FAST), true)
$(QUIET) for file in $(FILES); do \
echo ''; \
echo "Linting file: $$file"; \
$(R_LINTER) $(R_LINTER_FLAGS) $$file || exit 1; \
done
else
$(QUIET) for file in $(FILES); do \
echo ''; \
echo "Linting file: $$file"; \
$(R_LINTER) $(R_LINTER_FLAGS) $$file || echo 'Linting failed.'; \
done
endif
.PHONY: lint-r-files
|
