From 47a2ab5cbaf23eabda4b8a9734580951b2f392fd Mon Sep 17 00:00:00 2001
From: Vladimir Reznichenko <kalessil@gmail.com>
Date: Wed, 17 Jul 2024 09:47:04 +0200
Subject: [PATCH] CI: update linting script (no strict mode, additional
 information about linting steps) (#49629)

---
 plugins/woocommerce/bin/lint-branch.sh | 22 +++++++++++++++++-----
 1 file changed, 17 insertions(+), 5 deletions(-)

diff --git a/plugins/woocommerce/bin/lint-branch.sh b/plugins/woocommerce/bin/lint-branch.sh
index 69b3137cb8b..562bd5c27a4 100644
--- a/plugins/woocommerce/bin/lint-branch.sh
+++ b/plugins/woocommerce/bin/lint-branch.sh
@@ -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