Skip to content

Commit e9f0046

Browse files
kgrytekgryte
committed
fix: fix environment variable usage and update docs
1 parent 202e696 commit e9f0046

File tree

3 files changed

+65
-66
lines changed

3 files changed

+65
-66
lines changed

‎tools/git/hooks/post-merge‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
#
2121
# This hook is called with the following arguments:
2222
#
23-
# * `$1` - status flag specifying whether or not the merge being done is a squash merge
23+
# - `$1` - status flag specifying whether or not the merge being done is a squash merge
2424
#
2525
# This hook cannot does __not__ affect the outcome of `git merge` and is not executed if merge fails due to conflicts.
2626

‎tools/git/hooks/pre-commit‎

Lines changed: 38 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -26,24 +26,24 @@
2626
# VARIABLES #
2727

2828
# Resolve environment variables:
29-
skip_lint_filenames=${SKIP_LINT_FILENAMES}
30-
skip_lint_markdown=${SKIP_LINT_MARKDOWN}
31-
skip_lint_package_json=${SKIP_LINT_PACKAGE_JSON}
32-
skip_lint_repl_help=${SKIP_LINT_REPL_HELP}
33-
skip_lint_javascript_src=${SKIP_LINT_JAVASCRIPT_SRC}
34-
skip_lint_javascript_cli=${SKIP_LINT_JAVASCRIPT_CLI}
35-
skip_lint_javascript_examples=${SKIP_LINT_JAVASCRIPT_EXAMPLES}
36-
skip_lint_javascript_tests=${SKIP_LINT_JAVASCRIPT_TESTS}
37-
skip_lint_javascript_benchmarks=${SKIP_LINT_JAVASCRIPT_BENCHMARKS}
38-
skip_lint_python=${SKIP_LINT_PYTHON}
39-
skip_lint_r=${SKIP_LINT_R}
40-
skip_lint_c_src=${SKIP_LINT_C_SRC}
41-
skip_lint_c_examples=${SKIP_LINT_C_EXAMPLES}
42-
skip_lint_c_benchmarks=${SKIP_LINT_C_BENCHMARKS}
43-
skip_lint_c_tests_fixtures=${SKIP_LINT_TESTS_FIXTURES}
44-
skip_lint_shell=${SKIP_LINT_SHELL}
45-
skip_lint_typescript_declarations=${SKIP_LINT_TYPESCRIPT_DECLARATIONS}
46-
skip_lint_license_headers=${SKIP_LINT_LICENSE_HEADERS}
29+
skip_filenames="${SKIP_LINT_FILENAMES}"
30+
skip_markdown="${SKIP_LINT_MARKDOWN}"
31+
skip_package_json="${SKIP_LINT_PACKAGE_JSON}"
32+
skip_repl_help="${SKIP_LINT_REPL_HELP}"
33+
skip_javascript_src="${SKIP_LINT_JAVASCRIPT_SRC}"
34+
skip_javascript_cli="${SKIP_LINT_JAVASCRIPT_CLI}"
35+
skip_javascript_examples="${SKIP_LINT_JAVASCRIPT_EXAMPLES}"
36+
skip_javascript_tests="${SKIP_LINT_JAVASCRIPT_TESTS}"
37+
skip_javascript_benchmarks="${SKIP_LINT_JAVASCRIPT_BENCHMARKS}"
38+
skip_python="${SKIP_LINT_PYTHON}"
39+
skip_r="${SKIP_LINT_R}"
40+
skip_c_src="${SKIP_LINT_C_SRC}"
41+
skip_c_examples="${SKIP_LINT_C_EXAMPLES}"
42+
skip_c_benchmarks="${SKIP_LINT_C_BENCHMARKS}"
43+
skip_c_tests_fixtures="${SKIP_LINT_C_TESTS_FIXTURES}"
44+
skip_shell="${SKIP_LINT_SHELL}"
45+
skip_typescript_declarations="${SKIP_LINT_TYPESCRIPT_DECLARATIONS}"
46+
skip_license_headers="${SKIP_LINT_LICENSE_HEADERS}"
4747

4848
# Determine root directory:
4949
root=$(git rev-parse --show-toplevel)
@@ -128,7 +128,7 @@ run_lint() {
128128
changed_files=$(git diff --name-only --cached --diff-filter ACMR)
129129

130130
# Lint filenames:
131-
if [[ -z "${SKIP_LINT_FILENAMES}" ]]; then
131+
if [[ -z "${skip_filenames}" ]]; then
132132
echo "${changed_files}" | "${lint_filenames}"
133133
if [[ "$?" -ne 0 ]]; then
134134
echo '' >&2
@@ -137,7 +137,7 @@ run_lint() {
137137
fi
138138
fi
139139
# Lint Markdown files...
140-
if [[ -z "${SKIP_LINT_MARKDOWN}" ]]; then
140+
if [[ -z "${skip_markdown}" ]]; then
141141
files=$(echo "${changed_files}" | grep '\.md$' | tr '\n' ' ')
142142
if [[ -n "${files}" ]]; then
143143
make FILES="${files}" lint-markdown-files > /dev/null >&2
@@ -149,7 +149,7 @@ run_lint() {
149149
fi
150150
fi
151151
# Lint package.json files...
152-
if [[ -z "${SKIP_LINT_PACKAGE_JSON}" ]]; then
152+
if [[ -z "${skip_package_json}" ]]; then
153153
files=$(echo "${changed_files}" | grep 'package\.json$' | grep -v 'datapackage\.json$' )
154154
if [[ -n "${files}" ]]; then
155155
echo "${files}" | "${lint_package_json}" >&2
@@ -161,7 +161,7 @@ run_lint() {
161161
fi
162162
fi
163163
# Lint REPL help files...
164-
if [[ -z "${SKIP_LINT_REPL_HELP}" ]]; then
164+
if [[ -z "${skip_repl_help}" ]]; then
165165
files=$(echo "${changed_files}" | grep 'repl\.txt$' )
166166
if [[ -n "${files}" ]]; then
167167
echo "${files}" | "${lint_repl_help}" >&2
@@ -173,7 +173,7 @@ run_lint() {
173173
fi
174174
fi
175175
# Lint JavaScript source files...
176-
if [[ -z "${SKIP_LINT_JAVASCRIPT_SRC}" ]]; then
176+
if [[ -z "${skip_javascript_src}" ]]; then
177177
files=$(echo "${changed_files}" | grep '\.js$' | grep -v -e '/examples' -e '/test' -e '/benchmark' -e '^dist/' | tr '\n' ' ')
178178
if [[ -n "${files}" ]]; then
179179
make FILES="${files}" FIX=1 lint-javascript-files > /dev/null >&2
@@ -185,7 +185,7 @@ run_lint() {
185185
fi
186186
fi
187187
# Lint JavaScript command-line interfaces...
188-
if [[ -z "${SKIP_LINT_JAVASCRIPT_CLI}" ]]; then
188+
if [[ -z "${skip_javascript_cli}" ]]; then
189189
files=$(echo "${changed_files}" | grep '/bin/cli$' | tr '\n' ' ')
190190
if [[ -n "${files}" ]]; then
191191
make FILES="${files}" FIX=1 lint-javascript-files > /dev/null >&2
@@ -197,7 +197,7 @@ run_lint() {
197197
fi
198198
fi
199199
# Lint JavaScript examples files...
200-
if [[ -z "${SKIP_LINT_JAVASCRIPT_EXAMPLES}" ]]; then
200+
if [[ -z "${skip_javascript_examples}" ]]; then
201201
files=$(echo "${changed_files}" | grep '/examples/.*\.js$' | tr '\n' ' ')
202202
if [[ -n "${files}" ]]; then
203203
make JAVASCRIPT_LINTER=eslint ESLINT_CONF="${eslint_examples_conf}" FILES="${files}" FIX=1 lint-javascript-files > /dev/null >&2
@@ -209,7 +209,7 @@ run_lint() {
209209
fi
210210
fi
211211
# Lint JavaScript test files...
212-
if [[ -z "${SKIP_LINT_JAVASCRIPT_TESTS}" ]]; then
212+
if [[ -z "${skip_javascript_tests}" ]]; then
213213
files=$(echo "${changed_files}" | grep '/test/.*\.js$' | tr '\n' ' ')
214214
if [[ -n "${files}" ]]; then
215215
make JAVASCRIPT_LINTER=eslint ESLINT_CONF="${eslint_tests_conf}" FILES="${files}" FIX=1 lint-javascript-files > /dev/null >&2
@@ -221,7 +221,7 @@ run_lint() {
221221
fi
222222
fi
223223
# Lint JavaScript benchmark files...
224-
if [[ -z "${SKIP_LINT_JAVASCRIPT_BENCHMARKS}" ]]; then
224+
if [[ -z "${skip_javascript_benchmarks}" ]]; then
225225
files=$(echo "${changed_files}" | grep '/benchmark/.*\.js$' | tr '\n' ' ')
226226
if [[ -n "${files}" ]]; then
227227
make JAVASCRIPT_LINTER=eslint ESLINT_CONF="${eslint_benchmarks_conf}" FILES="${files}" FIX=1 lint-javascript-files > /dev/null >&2
@@ -233,7 +233,7 @@ run_lint() {
233233
fi
234234
fi
235235
# Lint Python files...
236-
if [[ -z "${SKIP_LINT_PYTHON}" ]]; then
236+
if [[ -z "${skip_python}" ]]; then
237237
files=$(echo "${changed_files}" | grep '\.py$' | tr '\n' ' ')
238238
if [[ -n "${files}" ]]; then
239239
make check-python-linters > /dev/null >&2
@@ -251,7 +251,7 @@ run_lint() {
251251
fi
252252
fi
253253
# Lint R files...
254-
if [[ -z "${SKIP_LINT_R}" ]]; then
254+
if [[ -z "${skip_r}" ]]; then
255255
files=$(echo "${changed_files}" | grep '\.R$' | tr '\n' ' ')
256256
if [[ -n "${files}" ]]; then
257257
make FILES="${files}" lint-r-files > /dev/null >&2
@@ -263,7 +263,7 @@ run_lint() {
263263
fi
264264
fi
265265
# Lint C source files...
266-
if [[ -z "${SKIP_LINT_C_SRC}" ]]; then
266+
if [[ -z "${skip_c_src}" ]]; then
267267
files=$(echo "${changed_files}" | grep '\.c$' | grep -v -e '/examples' -e '/test' -e '/benchmark' | tr '\n' ' ')
268268
if [[ -n "${files}" ]]; then
269269
make check-c-linters > /dev/null >&2
@@ -281,7 +281,7 @@ run_lint() {
281281
fi
282282
fi
283283
# Lint C examples files...
284-
if [[ -z "${SKIP_LINT_C_EXAMPLES}" ]]; then
284+
if [[ -z "${skip_c_examples}" ]]; then
285285
files=$(echo "${changed_files}" | grep '/examples/.*\.c$' | tr '\n' ' ')
286286
if [[ -n "${files}" ]]; then
287287
make check-c-linters > /dev/null >&2
@@ -299,7 +299,7 @@ run_lint() {
299299
fi
300300
fi
301301
# Lint C benchmark files...
302-
if [[ -z "${SKIP_LINT_C_BENCHMARKS}" ]]; then
302+
if [[ -z "${skip_c_benchmarks}" ]]; then
303303
files=$(echo "${changed_files}" | grep '/benchmark/.*\.c$' | tr '\n' ' ')
304304
if [[ -n "${files}" ]]; then
305305
make check-c-linters > /dev/null >&2
@@ -317,7 +317,7 @@ run_lint() {
317317
fi
318318
fi
319319
# Lint C test fixtures files...
320-
if [[ -z "${SKIP_LINT_TESTS_FIXTURES}" ]]; then
320+
if [[ -z "${skip_c_tests_fixtures}" ]]; then
321321
files=$(echo "${changed_files}" | grep '/test/fixtures/.*\.c$' | tr '\n' ' ')
322322
if [[ -n "${files}" ]]; then
323323
make check-c-linters > /dev/null >&2
@@ -335,7 +335,7 @@ run_lint() {
335335
fi
336336
fi
337337
# Lint shell script files...
338-
if [[ -z "${SKIP_LINT_SHELL}" ]]; then
338+
if [[ -z "${skip_shell}" ]]; then
339339
files=$(echo "${changed_files}" | while read -r file; do head -n1 "$file" | grep -q '^\#\!/usr/bin/env bash' && echo "$file"; done | tr '\n' ' ')
340340
if [[ -n "${files}" ]]; then
341341
make check-shell-linters > /dev/null >&2
@@ -353,7 +353,7 @@ run_lint() {
353353
fi
354354
fi
355355
# Lint TypeScript declaration files...
356-
if [[ -z "${SKIP_LINT_TYPESCRIPT_DECLARATIONS}" ]]; then
356+
if [[ -z "${skip_typescript_declarations}" ]]; then
357357
files=$(echo "${changed_files}" | grep '\.d\.ts$' | tr '\n' ' ')
358358
if [[ -n "${files}" ]]; then
359359
make TYPESCRIPT_DECLARATIONS_LINTER=dtslint FILES="${files}" lint-typescript-declarations-files > /dev/null >&2
@@ -365,7 +365,7 @@ run_lint() {
365365
fi
366366
fi
367367
# Lint license headers...
368-
if [[ -z "${SKIP_LINT_LICENSE_HEADERS}" ]]; then
368+
if [[ -z "${skip_license_headers}" ]]; then
369369
files=$(echo "${changed_files}" | tr '\n' ' ')
370370
if [[ -n "${files}" ]]; then
371371
make FILES="${files}" lint-license-headers-files > /dev/null >&2
@@ -379,9 +379,8 @@ run_lint() {
379379

380380
# TODO: if datapackage.json, validate via schema
381381

382-
# Re-add files that may have been fixed by linting...
383-
git add ${changed_files}
384-
382+
# Re-add files that may have been fixed by linting:
383+
git add "${changed_files}"
385384

386385
return 0
387386
}

‎tools/git/hooks/pre-push‎

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@
2020
#
2121
# This hook is called with the following arguments:
2222
#
23-
# * `$1` - name of the remote to which the push is being done
24-
# * `$2` - URL to which the push is being done
23+
# - `$1` - name of the remote to which the push is being done
24+
# - `$2` - URL to which the push is being done
2525
#
2626
# If pushing without using a named remote, these arguments will be equal.
2727
#
@@ -37,18 +37,18 @@
3737
# VARIABLES #
3838

3939
# Resolve environment variables:
40-
skip_run_javscript_examples=${SKIP_RUN_JAVASCRIPT_EXAMPLES}
41-
skip_run_javscript_readme_examples=${SKIP_RUN_JAVASCRIPT_README_EXAMPLES}
42-
skip_run_javscript_benchmarks=${SKIP_RUN_JAVASCRIPT_BENCHMARKS}
43-
skip_run_javscript_tests=${SKIP_RUN_JAVASCRIPT_TESTS}
44-
skip_run_c_examples=${SKIP_RUN_C_EXAMPLES}
45-
skip_run_c_benchmarks=${SKIP_RUN_C_BENCHMARKS}
46-
skip_run_cpp_examples=${SKIP_RUN_CPP_EXAMPLES}
47-
skip_run_cpp_benchmarks=${SKIP_RUN_CPP_BENCHMARKS}
48-
skip_run_fortran_benchmarks=${SKIP_RUN_FORTRAN_BENCHMARKS}
49-
skip_run_julia_benchmarks=${SKIP_RUN_JULIA_BENCHMARKS}
50-
skip_run_python_benchmarks=${SKIP_RUN_PYTHON_BENCHMARKS}
51-
skip_run_r_benchmarks=${SKIP_RUN_R_BENCHMARKS}
40+
skip_javascript_examples=${SKIP_RUN_JAVASCRIPT_EXAMPLES}
41+
skip_javascript_readme_examples=${SKIP_RUN_JAVASCRIPT_README_EXAMPLES}
42+
skip_javascript_benchmarks=${SKIP_RUN_JAVASCRIPT_BENCHMARKS}
43+
skip_javascript_tests=${SKIP_RUN_JAVASCRIPT_TESTS}
44+
skip_c_examples=${SKIP_RUN_C_EXAMPLES}
45+
skip_c_benchmarks=${SKIP_RUN_C_BENCHMARKS}
46+
skip_cpp_examples=${SKIP_RUN_CPP_EXAMPLES}
47+
skip_cpp_benchmarks=${SKIP_RUN_CPP_BENCHMARKS}
48+
skip_fortran_benchmarks=${SKIP_RUN_FORTRAN_BENCHMARKS}
49+
skip_julia_benchmarks=${SKIP_RUN_JULIA_BENCHMARKS}
50+
skip_python_benchmarks=${SKIP_RUN_PYTHON_BENCHMARKS}
51+
skip_r_benchmarks=${SKIP_RUN_R_BENCHMARKS}
5252

5353
# Resolve the remote:
5454
remote="$1"
@@ -128,7 +128,7 @@ main() {
128128
changed_files=$(git diff --name-only --cached --diff-filter ACMR "${remote}/${GIT_CURRENT_BRANCH}" | sed -e "s#^#${root}\\/#")
129129

130130
# Run JavaScript example files:
131-
if [[ -z "${SKIP_RUN_JAVASCRIPT_EXAMPLES}" ]]; then
131+
if [[ -z "${skip_javascript_examples}" ]]; then
132132
files=$(echo "${changed_files}" | grep '/examples/.*\.js$' | grep -v '/examples/fixtures/.*\.js$' | tr '\n' ' ')
133133
if [[ -n "${files}" ]]; then
134134
echo 'Running JavaScript example files...' >&2
@@ -141,7 +141,7 @@ main() {
141141
fi
142142
fi
143143
# Run C example files...
144-
if [[ -z "${SKIP_RUN_C_EXAMPLES}" ]]; then
144+
if [[ -z "${skip_c_examples}" ]]; then
145145
files=$(echo "${changed_files}" | grep '/examples/.*\.c$' | grep -v '/examples/fixtures/.*\.c$' | tr '\n' ' ')
146146
if [[ -n "${files}" ]]; then
147147
echo 'Running C example files...' >&2
@@ -154,7 +154,7 @@ main() {
154154
fi
155155
fi
156156
# Run C++ example files...
157-
if [[ -z "${SKIP_RUN_CPP_EXAMPLES}" ]]; then
157+
if [[ -z "${skip_cpp_examples}" ]]; then
158158
files=$(echo "${changed_files}" | grep '/examples/.*\.cpp$' | grep -v '/examples/fixtures/.*\.cpp$' | tr '\n' ' ')
159159
if [[ -n "${files}" ]]; then
160160
echo 'Running C++ example files...' >&2
@@ -167,7 +167,7 @@ main() {
167167
fi
168168
fi
169169
# Run JavaScript examples in README files:
170-
if [[ -z "${SKIP_RUN_JAVASCRIPT_README_EXAMPLES}" ]]; then
170+
if [[ -z "${skip_javascript_readme_examples}" ]]; then
171171
files=$(echo "${changed_files}" | grep 'README.md$' | grep -v '^tools/' | tr '\n' ' ')
172172
if [[ -n "${files}" ]]; then
173173
echo 'Running README JavaScript examples...' >&2
@@ -183,7 +183,7 @@ main() {
183183
# TODO: run CLI examples found in Markdown files
184184

185185
# Run C benchmark files...
186-
if [[ -z "${SKIP_RUN_C_BENCHMARKS}" ]]; then
186+
if [[ -z "${skip_c_benchmarks}" ]]; then
187187
files=$(echo "${changed_files}" | grep '/benchmark/.*\.c$' | tr '\n' ' ')
188188
if [[ -n "${files}" ]]; then
189189
echo 'Running C benchmark files...' >&2
@@ -196,7 +196,7 @@ main() {
196196
fi
197197
fi
198198
# Run C++ benchmark files...
199-
if [[ -z "${SKIP_RUN_CPP_BENCHMARKS}" ]]; then
199+
if [[ -z "${skip_cpp_benchmarks}" ]]; then
200200
files=$(echo "${changed_files}" | grep '/benchmark/.*\.cpp$' | tr '\n' ' ')
201201
if [[ -n "${files}" ]]; then
202202
echo 'Running C++ benchmark files...' >&2
@@ -209,7 +209,7 @@ main() {
209209
fi
210210
fi
211211
# Run Fortran benchmark files...
212-
if [[ -z "${SKIP_RUN_FORTRAN_BENCHMARKS}" ]]; then
212+
if [[ -z "${skip_fortran_benchmarks}" ]]; then
213213
files=$(echo "${changed_files}" | grep '/benchmark/.*\.f$' | tr '\n' ' ')
214214
if [[ -n "${files}" ]]; then
215215
echo 'Running Fortran benchmark files...' >&2
@@ -222,7 +222,7 @@ main() {
222222
fi
223223
fi
224224
# Run JavaScript benchmark files...
225-
if [[ -z "${SKIP_RUN_JAVASCRIPT_BENCHMARKS}" ]]; then
225+
if [[ -z "${skip_javascript_benchmarks}" ]]; then
226226
files=$(echo "${changed_files}" | grep '/benchmark/.*\.js$' | tr '\n' ' ')
227227
if [[ -n "${files}" ]]; then
228228
echo 'Running JavaScript benchmark files...' >&2
@@ -235,7 +235,7 @@ main() {
235235
fi
236236
fi
237237
# Run Julia benchmark files...
238-
if [[ -z "${SKIP_RUN_JULIA_BENCHMARKS}" ]]; then
238+
if [[ -z "${skip_julia_benchmarks}" ]]; then
239239
files=$(echo "${changed_files}" | grep '/benchmark/.*\.jl$' | tr '\n' ' ')
240240
if [[ -n "${files}" ]]; then
241241
echo 'Running Julia benchmark files...' >&2
@@ -248,7 +248,7 @@ main() {
248248
fi
249249
fi
250250
# Run Python benchmark files...
251-
if [[ -z "${SKIP_RUN_PYTHON_BENCHMARKS}" ]]; then
251+
if [[ -z "${skip_python_benchmarks}" ]]; then
252252
files=$(echo "${changed_files}" | grep '/benchmark/.*\.py$' | tr '\n' ' ')
253253
if [[ -n "${files}" ]]; then
254254
echo 'Running Python benchmark files...' >&2
@@ -261,7 +261,7 @@ main() {
261261
fi
262262
fi
263263
# Run R benchmark files...
264-
if [[ -z "${SKIP_RUN_R_BENCHMARKS}" ]]; then
264+
if [[ -z "${skip_r_benchmarks}" ]]; then
265265
files=$(echo "${changed_files}" | grep '/benchmark/.*\.R$' | tr '\n' ' ')
266266
if [[ -n "${files}" ]]; then
267267
echo 'Running R benchmark files...' >&2
@@ -274,7 +274,7 @@ main() {
274274
fi
275275
fi
276276
# Run JavaScript test files...
277-
if [[ -z "${SKIP_RUN_JAVASCRIPT_TESTS}" ]]; then
277+
if [[ -z "${skip_javascript_tests}" ]]; then
278278
files=$(echo "${changed_files}" | grep '/test/.*\.js$' | grep -v '/test/fixtures/.*\.js$' | tr '\n' ' ')
279279
if [[ -n "${files}" ]]; then
280280
echo 'Running JavaScript test files...' >&2

0 commit comments

Comments
 (0)