From 1c0769fdc316a5e2982d8909e713050af223c928 Mon Sep 17 00:00:00 2001 From: "Luke T. Shumaker" Date: Mon, 27 Jan 2025 22:32:10 -0700 Subject: GNUmakefile: Pull lint/c, lint/all, and lint/unknown out into separate shell scripts --- build-aux/lint-generic | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100755 build-aux/lint-generic (limited to 'build-aux/lint-generic') diff --git a/build-aux/lint-generic b/build-aux/lint-generic new file mode 100755 index 0000000..9f9e0f7 --- /dev/null +++ b/build-aux/lint-generic @@ -0,0 +1,31 @@ +#!/bin/sh +# build-aux/lint-generic - Non-language-specific lint checks +# +# Copyright (C) 2024-2025 Luke T. Shumaker +# SPDX-License-Identifier: AGPL-3.0-or-later + +r=0 +for filename in "$@"; do + if ! { [ -f "$filename" ] && ! [ -h "$filename" ]; }; then + continue + fi + if ! grep -E -q 'Copyright \(C\) 202[4-9]((-|, )202[5-9])* Luke T. Shumaker' "$filename"; then + echo "$filename is missing a copyright statement"; r=1 + fi + if ! grep -q ' SPDX-License-Identifier[:] ' "$filename"; then + echo "$filename is missing an SPDX-License-Identifier"; r=1 + fi + dscname_act=$(./build-aux/get-dscname "$filename") + dscname_exp=$(echo "$filename" | sed \ + -e 's,.*/config/,,' \ + -e 's,.*/config\.h$,config.h,' \ + -e 's,.*include/,,' \ + -e 's/\.wip$//') + if [ "$dscname_act" != "$dscname_exp" ] && [ "cmd/$dscname_act" != "$dscname_exp" ]; then + echo "$filename self-identifies as $dscname_act (expected $dscname_exp)"; r=1 + fi + if grep -n --color=auto "$(printf '\\S\t')" "$filename"; then + echo "$filename uses tabs for alignment"; r=1 + fi +done +exit $r -- cgit v1.2.3-2-g168b From fdd80b98e9419dc0eaaa367f919252420d4f7676 Mon Sep 17 00:00:00 2001 From: "Luke T. Shumaker" Date: Mon, 27 Jan 2025 22:59:31 -0700 Subject: make lint: Have the output be a little prettier --- build-aux/lint-generic | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) (limited to 'build-aux/lint-generic') diff --git a/build-aux/lint-generic b/build-aux/lint-generic index 9f9e0f7..fcc0457 100755 --- a/build-aux/lint-generic +++ b/build-aux/lint-generic @@ -4,16 +4,24 @@ # Copyright (C) 2024-2025 Luke T. Shumaker # SPDX-License-Identifier: AGPL-3.0-or-later +RED=$(tput setaf 1) +RESET=$(tput sgr0) + +err() { + printf "${RED}%s${RESET}: %s\n" "$1" "$2" >&2 + r=1 +} + r=0 for filename in "$@"; do if ! { [ -f "$filename" ] && ! [ -h "$filename" ]; }; then continue fi if ! grep -E -q 'Copyright \(C\) 202[4-9]((-|, )202[5-9])* Luke T. Shumaker' "$filename"; then - echo "$filename is missing a copyright statement"; r=1 + err "$filename" 'is missing a copyright statement' fi if ! grep -q ' SPDX-License-Identifier[:] ' "$filename"; then - echo "$filename is missing an SPDX-License-Identifier"; r=1 + err "$filename" 'is missing an SPDX-License-Identifier' fi dscname_act=$(./build-aux/get-dscname "$filename") dscname_exp=$(echo "$filename" | sed \ @@ -22,10 +30,10 @@ for filename in "$@"; do -e 's,.*include/,,' \ -e 's/\.wip$//') if [ "$dscname_act" != "$dscname_exp" ] && [ "cmd/$dscname_act" != "$dscname_exp" ]; then - echo "$filename self-identifies as $dscname_act (expected $dscname_exp)"; r=1 + err "$filename" "self-identifies as $dscname_act (expected $dscname_exp)" fi if grep -n --color=auto "$(printf '\\S\t')" "$filename"; then - echo "$filename uses tabs for alignment"; r=1 + err "$filename" 'uses tabs for alignment' fi done exit $r -- cgit v1.2.3-2-g168b From 3199e6a45fd5e8bd9ec44616d5dcfb856ba6a888 Mon Sep 17 00:00:00 2001 From: "Luke T. Shumaker" Date: Mon, 27 Jan 2025 23:01:19 -0700 Subject: lint-generic: Check that shebang-presence and executable bit match --- build-aux/lint-generic | 15 +++++++++++++++ 1 file changed, 15 insertions(+) (limited to 'build-aux/lint-generic') diff --git a/build-aux/lint-generic b/build-aux/lint-generic index fcc0457..c02dc34 100755 --- a/build-aux/lint-generic +++ b/build-aux/lint-generic @@ -15,14 +15,26 @@ err() { r=0 for filename in "$@"; do if ! { [ -f "$filename" ] && ! [ -h "$filename" ]; }; then + # Ignore non-files continue fi + + # File header ########################################################## + + shebang="$(sed -n '1{/^#!/{/^#!\/hint\//q; p;};}' "$filename")" + if [ -x "$filename" ] && [ -z "$shebang" ]; then + err "$filename" 'is executable but does not have a shebang' + elif [ -n "$shebang" ] && ! [ -x "$filename" ]; then + err "$filename" 'has a shebang but is executable' + fi + if ! grep -E -q 'Copyright \(C\) 202[4-9]((-|, )202[5-9])* Luke T. Shumaker' "$filename"; then err "$filename" 'is missing a copyright statement' fi if ! grep -q ' SPDX-License-Identifier[:] ' "$filename"; then err "$filename" 'is missing an SPDX-License-Identifier' fi + dscname_act=$(./build-aux/get-dscname "$filename") dscname_exp=$(echo "$filename" | sed \ -e 's,.*/config/,,' \ @@ -32,6 +44,9 @@ for filename in "$@"; do if [ "$dscname_act" != "$dscname_exp" ] && [ "cmd/$dscname_act" != "$dscname_exp" ]; then err "$filename" "self-identifies as $dscname_act (expected $dscname_exp)" fi + + # File body ############################################################ + if grep -n --color=auto "$(printf '\\S\t')" "$filename"; then err "$filename" 'uses tabs for alignment' fi -- cgit v1.2.3-2-g168b