upstream/opnsense-core
1
0
Fork 0
mirror of https://github.com/opnsense/core.git synced 2026-06-09 00:42:36 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

lint: Add linter that finds unused imports in php classes

Browse source
This commit is contained in:
Monviech 2026-03-27 16:26:42 +01:00 committed by Franco Fichtner
parent aaf9a1c797
commit e6726ba233
2 changed files with 53 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
Mk/lint.mk
View file

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

49
Scripts/class-import.sh Executable file
View file

@ -0,0 +1,49 @@
#!/bin/sh
# Copyright (c) 2026 Deciso B.V.
#
# 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
cd "${1}" || exit ${RET}
if [ ! -d src ]; then
exit ${RET}
fi
for FILE in $(find src -name "*.php"); do
for LINE in $(grep '^use ' ${FILE} || true); do
IMPORT=$(echo "${LINE}" | sed 's/^use //; s/;//')
CLASS=${IMPORT##*\\}
COUNT=$(grep -w "${CLASS}" ${FILE} | wc -l)
if [ "${COUNT}" -le 1 ]; then
echo "${FILE}: warning: stale import use ${IMPORT}"
fi
done
done
exit ${RET}