Steve-Dee-Designs
/
woocommerce
mirror of https://github.com/woocommerce/woocommerce.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

CI: update linting script (no strict mode, additional information about linting steps) (#49629)

This commit is contained in:
Vladimir Reznichenko 2024-07-17 09:47:04 +02:00 committed by GitHub
parent 6d99ed6a1d
commit 47a2ab5cba
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 17 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
plugins/woocommerce/bin/lint-branch.sh
View File

@ -1,7 +1,5 @@
#!/usr/bin/env bash
set -eo pipefail
# Lint branch
#
# Runs phpcs-changed, comparing the current branch to its "base" or "parent" branch.
@ -12,22 +10,36 @@ set -eo pipefail
# ./lint-branch.sh base-branch
baseBranch=${1:-"trunk"}
redColoured='\033[0;31m'
# Lint changed php-files to match code style.
changedFiles=$(git diff $(git merge-base HEAD $baseBranch) --relative --name-only --diff-filter=d -- '*.php')
if [[ -n $changedFiles ]]; then
printf "Linting the following files with CodeSniffer:\n"
printf " %s\n" $changedFiles
composer exec phpcs-changed -- -s --git --git-base $baseBranch $changedFiles
if [[ $? != 0 ]]; then
printf "${redColoured}Unfortunately, CodeSniffer reported some violations which need to be addressed (see above).\n"
exit 1
else
printf "CodeSniffer reported no violations, well done!\n"
fi
fi
# Lint new (excl. renamed) php-files to contain strict types directive.
newFiles=$(git diff $(git merge-base HEAD $baseBranch) --relative --name-only --diff-filter=dmr -- '*.php')
if [[ -n $newFiles ]]; then
printf "Linting the new files for declaring strict types directive (https://www.php.net/manual/en/language.types.declarations.php#language.types.declarations.strict):\n"
printf " %s\n" $newFiles
passingFiles=$(find $newFiles -type f -exec grep -xl --regexp='declare(\s*strict_types\s*=\s*1\s*);' /dev/null {} +)
violatingFiles=$(grep -vxf <(printf "%s\n" $passingFiles | sort) <(printf "%s\n" $newFiles | sort) || echo '')
if [[ -n "$violatingFiles" ]]; then
redColoured='\033[0;31m'
printf "${redColoured}Following files are missing 'declare( strict_types = 1)' directive:\n"
printf "${redColoured}%s\n" $violatingFiles
printf "${redColoured}Unfortunately, some files miss 'declare( strict_types = 1)' directive and need to be updated:\n"
printf "${redColoured} %s\n" $violatingFiles
exit 1
else
printf "Strict types directive linting reported no violations, well done!\n"
fi
fi