upstream/opnsense-core
1
0
Fork 0
mirror of https://github.com/opnsense/core.git synced 2026-02-03 20:39:42 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

make: add a linter for PHP class name consistency #9638

Browse source
This commit is contained in:
Franco Fichtner 2026-01-30 08:57:45 +01:00
parent c827a02ef6
commit cff4c085d3
2 changed files with 56 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
Mk/lint.mk
View file

@ -108,6 +108,9 @@ lint-model:
lint-acl:
@${COREREFDIR}/Scripts/dashboard-acl.sh ${COREREFDIR}
lint-class:
@${COREREFDIR}/Scripts/class-filename.sh ${COREREFDIR}
SCRIPTDIRS!= if [ -d ${.CURDIR}/src/opnsense/scripts ]; then find ${.CURDIR}/src/opnsense/scripts -type d -depth 1; fi
lint-exec:
@ -151,4 +154,4 @@ lint-plist:
@rm ${WRKDIR}/plist.*
.endif
lint: lint-plist lint-desc lint-shell lint-xml lint-model lint-acl lint-exec lint-php
lint: lint-plist lint-desc lint-shell lint-xml lint-model lint-acl lint-class lint-exec lint-php

52
Scripts/class-filename.sh Executable file
View file

@ -0,0 +1,52 @@
#!/bin/sh
# Copyright (c) 2026 Franco Fichtner <franco@opnsense.org>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
#
# 1. Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
#
# 2. Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
# SUCH DAMAGE.
RET=0
for FILE in $(find src -name "*.php"); do
CLASS=$(grep ^class ${FILE} | awk '{ print $2 }')
if [ -z "${CLASS}" ]; then
continue
fi
MULTI=
OK=
for _CLASS in ${CLASS}; do
if [ "$(basename ${FILE})" == "${_CLASS}.php" ]; then
OK=${_CLASS}
else
MULTI="${_CLASS} ${MULTI}"
fi
done
if [ -z "${OK}" ]; then
echo "${FILE}: error: does not match class name" ${CLASS}
RET=1
elif [ -n "${MULTI}" ]; then
echo "${FILE}: warning: has additional classes" ${MULTI}
fi
done
exit ${RET}