Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

xlint: support severity levels #323

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

xlint: support severity levels #323

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e015425
xlint: support severity levels
classabbyamp Feb 12, 2024
4d12964
xlint: make variable=empty lint warning for custom vars
classabbyamp Feb 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
33 changes: 20 additions & 13 deletions xlint
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,21 @@
export LC_ALL=C

scan() {
local rx="$1" msg="$(printf '%s\n' "$2" | sed 's,/,\\/,g')"
local rx="$1" msg="$(printf '%s\n' "$2" | sed 's,/,\\/,g')" sev="${3:-$defaultsev}"
grep -P -hn -e "$rx" "$template" |
grep -v -P -e "[^:]*:\s*#" |
sed "s/^\([^:]*\):\(.*\)/\1: $msg/" |
while read line; do
echo "$argument:$line"
while read -r line; do
echo "$argument:$sev:$line"
done
}

scan_warn() {
scan "$@" warning
}

check_old_vars() {
sed -E 's/^([^:]+:[0-9]+:).*: ('"$old_variables"')=.*$/\1 \2 is deprecated and should not be used/'
sed -E 's/^([^:]+:[^:]+:[0-9]+:).*: ('"$old_variables"')=.*$/\1 \2 is deprecated and should not be used/'
}

regex_escape() {
Expand All @@ -29,19 +33,19 @@ once() {

header() {
if [ "$(head -n1 "$template")" != "# Template file for '$pkgname'" ]; then
echo "$argument:1: Header should be: # Template file for '$pkgname'"
echo "$argument:$defaultsev:1: Header should be: # Template file for '$pkgname'"
fi
}

exists_once() {
for var in pkgname version revision short_desc maintainer license \
homepage; do
case "$(grep -c "^${var}=" "$template")" in
0) echo "$argument:1: '$var' missing!";;
0) echo "$argument:$defaultsev:1: '$var' missing!";;
1) ;;
*)
lines="$(grep -n "^${var}=" "$template" | awk -F: 'NR>1 { printf ", " } { printf "%s", $1 }')"
echo "$argument:${lines##*, }: '$var' defined more than once: previously on line(s) ${lines%,*}"
echo "$argument:$defaultsev:${lines##*, }: '$var' defined more than once: previously on line(s) ${lines%,*}"
;;
esac
done
Expand Down Expand Up @@ -126,7 +130,7 @@ variables_order() {
if [ "$variables_end" ]; then
break
elif [ "$curr_index" -lt "$max_index" ]; then
message="$argument:$max_index_line_number: Place $max_index_line= after ${line%%=*}="
message="$argument:$defaultsev:$max_index_line_number: Place $max_index_line= after ${line%%=*}="
elif [ "$curr_index" -gt "$max_index" ]; then
max_index="$curr_index"
max_index_line="${line%%=*}"
Expand All @@ -141,13 +145,15 @@ variables_order() {
}

file_end() {
if [ "$(tail -c 1 $template)" ]; then
echo "$argument:$(( $(wc -l < $template) + 1 )): File does not end with newline character"
elif [ -z "$(tail -c 2 $template)" ]; then
echo "$argument:$(wc -l < $template): Last line is empty"
if [ "$(tail -c 1 "$template")" ]; then
echo "$argument:$defaultsev:$(( $(wc -l < "$template") + 1 )): File does not end with newline character"
elif [ -z "$(tail -c 2 "$template")" ]; then
echo "$argument:$defaultsev:$(wc -l < "$template"): Last line is empty"
fi
}

defaultsev="error"

variables=$(echo -n "#.*
_.*
.*_descr
Expand Down Expand Up @@ -456,7 +462,8 @@ for argument; do
scan 'maintainer=(?!.*<.*@.*>).*' "maintainer needs email address"
scan 'maintainer=.*<.*@users.noreply.github.com>.*' "maintainer needs a valid address for sending mail"
scan '^(?!\s*('"$variables"'))[^\s=-]+=' "custom variables should use _ prefix: \\2" | check_old_vars
scan '^[^ =]*=(""|''|)$' "variable set to empty string: \\2"
scan '^[^_ =][^ =]*=(""|''|)$' "variable set to empty string: \\2"
scan_warn '^_[^ =]*=(""|''|)$' "custom variable set to empty string: \\2"
scan '^(.*)-docs_package().*' 'use <pkgname>-doc subpackage for documentation'
scan 'distfiles=.*github.com.*/archive/.*\.zip[\"]?$' 'Use the distfile .tar.gz instead of .zip'
scan 'distfiles=.*downloads\.sourceforge\.net' 'use $SOURCEFORGE_SITE'
Expand Down