a
/
badguardhome
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Pull request: scripts: improve go-lint 

Merge in DNS/adguard-home from imp-lint-script to master

Squashed commit of the following:

commit 89a6e8343f9f0c7ea257899b5daac014bfb6b6df
Author: Ainar Garipov <A.Garipov@AdGuard.COM>
Date:   Thu Dec 10 13:36:38 2020 +0300

    script: make go-lint more in line with HACKING.md

commit dc4e1519d25877a074f667fec696578c80d7baf3
Author: Ainar Garipov <A.Garipov@AdGuard.COM>
Date:   Thu Dec 10 13:35:03 2020 +0300

    scripts: improve go-lint
This commit is contained in:
Ainar Garipov 2020-12-10 14:35:07 +03:00
parent ef178610d6
commit e02308dd42
2 changed files with 31 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
HACKING.md
View File

@ -152,6 +152,8 @@ The rules are mostly sorted in the alphabetical order.
* Put spaces within `$( cmd )`, `$(( expr ))`, and `{ cmd; }`. * Put spaces within `$( cmd )`, `$(( expr ))`, and `{ cmd; }`.
* `snake_case`, not `camelCase`.
* Use `set -e -f -u` and also `set -x` in verbose mode. * Use `set -e -f -u` and also `set -x` in verbose mode.
* Use the `"$var"` form instead of the `$var` form, unless word splitting is * Use the `"$var"` form instead of the `$var` form, unless word splitting is

36
scripts/go-lint.sh
View File

@ -13,10 +13,30 @@ test "${EXITONERROR:=1}" = '0' && set +e || set -e
# variables. # variables.
set -f -u set -f -u
# blocklistimports is a simple check against unwanted packages. not_found_msg='
looks like a binary not found error.
make sure you have installed the linter binaries using:
$ make go-install-tools
'
not_found() {
if [ "$?" = '127' ]
then
# Code 127 is the exit status a shell uses when
# a command or a file is not found, according to the
# Bash Hackers wiki.
#
# See https://wiki.bash-hackers.org/dict/terms/exit_status.
echo "$not_found_msg" 1>&2
fi
}
trap not_found EXIT
# blocklist_imports is a simple check against unwanted packages.
# Currently it only looks for package log which is replaced by our own # Currently it only looks for package log which is replaced by our own
# package github.com/AdguardTeam/golibs/log. # package github.com/AdguardTeam/golibs/log.
blocklistimports () { blocklist_imports() {
git grep -F -e '"log"' -- '*.go' || exit 0; git grep -F -e '"log"' -- '*.go' || exit 0;
} }
@ -28,9 +48,9 @@ underscores () {
-v || exit 0; } -v || exit 0; }
} }
# exitonoutput exits with a nonzero exit code if there is anything in # exit_on_output exits with a nonzero exit code if there is anything in
# the command's combined output. # the command's combined output.
exitonoutput() { exit_on_output() {
test "$VERBOSE" -lt '2' && set +x test "$VERBOSE" -lt '2' && set +x
cmd="$1" cmd="$1"
@ -57,11 +77,11 @@ exitonoutput() {
return "$exitcode" return "$exitcode"
} }
exitonoutput blocklistimports exit_on_output blocklist_imports
exitonoutput underscores exit_on_output underscores
exitonoutput gofumpt --extra -l -s . exit_on_output gofumpt --extra -l -s .
golint --set_exit_status ./... golint --set_exit_status ./...
@ -87,7 +107,7 @@ nilness ./...
# TODO(a.garipov): Enable errcheck fully after handling all errors, # TODO(a.garipov): Enable errcheck fully after handling all errors,
# including the deferred ones, properly. Also, perhaps, enable --blank. # including the deferred ones, properly. Also, perhaps, enable --blank.
# errcheck ./... # errcheck ./...
exitonoutput sh -c ' exit_on_output sh -c '
errcheck --asserts ./... |\ errcheck --asserts ./... |\
{ grep -e "defer" -e "_test\.go:" -v || exit 0; } { grep -e "defer" -e "_test\.go:" -v || exit 0; }
' '