]> git.baikalelectronics.ru Git - arm-tf.git/commitdiff
style(hooks): adds Arm copyright style fix
authorMaksims Svecovs <maksims.svecovs@arm.com>
Wed, 15 Mar 2023 13:24:44 +0000 (13:24 +0000)
committerMaksims Svecovs <maksims.svecovs@arm.com>
Wed, 15 Mar 2023 13:32:00 +0000 (13:32 +0000)
Adds a check to pre-commit hook that makes sure "Arm" is written in a
correct case and not "arm" or "ARM". Same as a copyright-year check, the
hook will fix the issue and prompt user to stage the fix.

Change-Id: I39db148d6621d542193f3ee703bddc23c7e8dc27
Signed-off-by: Maksims Svecovs <maksims.svecovs@arm.com>
.husky/pre-commit.copyright

index b5087a74652d9ae0ab9cfdd8cd843aff72243015..a4dfee8e3908ab1b7901d2decc3c3241762bd6f0 100755 (executable)
@@ -18,7 +18,7 @@ ARM_RGX="\(ARM\|Arm\|arm\)"
 exit_code=0
 
 function user_warning() {
-       echo -e "Copyright of $RED$FILE$BLANK is out of date"
+       echo -e "Copyright of $RED$FILE$BLANK is out of date/incorrect"
        echo -e "Updated copyright to"
        grep -nr "opyright.*$YEAR_RGX.*$ARM_RGX" "$FILE"
        echo
@@ -38,15 +38,21 @@ while read -r FILE; do
                if grep "opyright.*$YEAR_RGX.*-.*$YEAR_RGX.*$ARM_RGX" "$FILE" >/dev/null 2>&1
                then
                        exit_code=1
-                       sed -i "s/\(opyright.*\)$YEAR_RGX\(.*$ARM_RGX\)/\1$(date +"%Y")\2/" $FILE
+                       sed -i "s/\(opyright.*\)$YEAR_RGX\(.*$ARM_RGX\)/\1$(date +"%Y"), Arm/" $FILE
                        user_warning
                # If it is single "date" type of entry - add the copyright extension to current year.
                elif grep "opyright.*$YEAR_RGX.*$ARM_RGX" "$FILE" >/dev/null 2>&1
                then
                        exit_code=1
-                       sed -i "s/\(opyright.*$YEAR_RGX\)\(.*$ARM_RGX\)/\1-$(date +"%Y")\2/" $FILE
+                       sed -i "s/\(opyright.*$YEAR_RGX\)\(.*$ARM_RGX\)/\1-$(date +"%Y"), Arm/" $FILE
                        user_warning
                fi
+       # Even if the year is correct - verify that Arm copyright is formatted correctly.
+       elif grep "opyright.*\(ARM\|arm\)" "$FILE">/dev/null 2>&1
+       then
+               exit_code=1
+               sed -i "s/\(opyright.*\)\(ARM\|arm\)/\1Arm/" $FILE
+               user_warning
        fi
 done <<< "$FILES"