From 3f6ccc34a02a04de1e85b784d0c0af3a72c8a215 Mon Sep 17 00:00:00 2001 From: Jose Diaz-Gonzalez Date: Wed, 2 Mar 2022 01:20:26 -0500 Subject: [PATCH] feat: add .shellcheckrc dquote> dquote> This is a minimal config that can be used in conjunction with text editors to run linting during development. The initial rules are a subset of those we ignore across the codebase. A future update will add further rules as needed and cleanup the codebase. --- .shellcheckrc | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 .shellcheckrc diff --git a/.shellcheckrc b/.shellcheckrc new file mode 100644 index 000000000..eed21d662 --- /dev/null +++ b/.shellcheckrc @@ -0,0 +1,9 @@ +# SC1091 - Not following: FILE: does not exist (No such file or directory) - https://github.com/koalaman/shellcheck/wiki/SC1091 +# - used for sourcing function files throughout the codebase +# SC2034 - VAR appears unused - https://github.com/koalaman/shellcheck/wiki/SC2034 +# - used for declaring desc and deprecated function variables +# SC2064 - Use single quotes, otherwise this expands now rather than when signalled. - https://github.com/koalaman/shellcheck/wiki/SC2064 +# - used for traps +# SC2155 - Declare and assign separately to avoid masking return values - https://github.com/koalaman/shellcheck/wiki/SC2155 +# - used throughout the codebase +disable=SC1091,SC2034,SC2064,SC2155