devtools/dts-check-format.sh - main - phprus/github_dpdk

devtools/dts-check-format.sh
124 строки3 KB
Dean Marx
devtools: add DTS test case docstring checks
30 янв 2026, 19:47
30 янв 2026, 19:47edc493e
#!/bin/sh
# SPDX-License-Identifier: BSD-3-Clause
# Copyright(c) 2022 University of New Hampshire
# Copyright(c) 2023 PANTHEON.tech s.r.o.

usage() {
	echo "Usage: $(basename $0) [options] [directory]"
	echo 'Options:'
	# Get source code comments after getopts arguments and print them both
	grep -E '[a-zA-Z]+\) +#' "$0" | tr -d '#'
}

format=true
lint=true
typecheck=true
docstringcheck=true

# Comments after args serve as documentation; must be present
while getopts "hflt" arg; do
	case $arg in
	h) # Display this message
		echo 'Run formatting and linting programs for DTS.'
		usage
		exit 0
		;;
	f) # Don't run formatters
		format=false
		;;
	l) # Don't run linter
		lint=false
		;;
	t) # Don't run type checker
		typecheck=false
		;;
	?)
		usage
		exit 1
	esac
done
shift $(($OPTIND - 1))

directory=$(realpath --relative-base=$(pwd) ${1:-$(dirname $0)/../dts})
cd $directory || exit 1

heading() {
	echo $*
	echo $* | sed 's/./-/g' # underline
}

errors=0

if $format; then
	if command -v git > /dev/null; then
		if git rev-parse --is-inside-work-tree >&-; then
			heading "Formatting in $directory/"
			if command -v ruff > /dev/null; then
				echo "Formatting code with ruff:"
				ruff format
			else
				echo "ruff is not installed, not formatting"
				errors=$((errors + 1))
			fi

			git update-index --refresh
			retval=$?
			if [ $retval -ne 0 ]; then
				echo 'The "needs update" files have been reformatted.'
				echo 'Please update your commit.'
			fi
			errors=$((errors + retval))
		else
			echo ".git directory not found, not formatting code"
			errors=$((errors + 1))
		fi
	else
		echo "git command not found, not formatting code"
		errors=$((errors + 1))
	fi
fi

if $lint; then
	if $format; then
		echo
	fi
	heading "Linting in $directory/"
	if command -v ruff > /dev/null; then
		ruff check --fix
		errors=$((errors + $?))

		git update-index --refresh
		retval=$?
		if [ $retval -ne 0 ]; then
			echo 'The "needs update" files have been fixed by the linter.'
			echo 'Please update your commit.'
		fi
		errors=$((errors + retval))
	else
		echo "ruff not found, unable to run linter"
		errors=$((errors + 1))
	fi
	if $docstringcheck; then
		python3 ../devtools/dts-check-docstrings.py
		errors=$((errors + $?))
	fi
fi

if $typecheck; then
	if $format || $lint; then
		echo
	fi
	heading "Checking types in $directory/"
	if command -v mypy > /dev/null; then
		mypy .
		errors=$((errors + $?))
	else
		echo "mypy not found, unable to check types"
		errors=$((errors + 1))
	fi
fi

echo
heading "Summary for $directory/"
echo "Found $errors errors"
exit $errors