feat(button): readme

Author: Phil-NHS

README.md

@@ -39,75 +39,75 @@ It is client side so the users browser will do the work.
 - TELBlazor\TELBlazor.Components.ShowCase.E2ETests\bin\Debug\net8.0\playwright.ps1 need to be run as admin
 - local hook for commits, recommended for pre commit, and pre push as can only check the commit name value post commit
 
-`
-# --- Commitlint Logic (force local config) ---
-REPO_ROOT=$(git rev-parse --show-toplevel)
-CONFIG_PATH="$REPO_ROOT/.commitlintrc.json"
-echo "COMMIT_MSG_FILE is one msg behind it is only set to the commit your trying to commit after the commit succeeds so this script is one behind"
-echo "so would work best in prepush template"
-COMMIT_MSG_FILE="$REPO_ROOT/.git/COMMIT_EDITMSG"
-
-# Check if the local .commitlintrc.json exists in the repository root
-if [ -f "$CONFIG_PATH" ]; then
-
-    echo "✅ Local .commitlintrc.json found at: $CONFIG_PATH. Running commitlint..."
-	echo "⚠️ if commit lint fails in precommit its actually reading previous commit name you need to reset or squash make a new commit and change .git/COMMIT_EDITMSG to something that would pass. ⚠️"
-
-    if command -v npx &> /dev/null; then
-	
-			cd "$REPO_ROOT" || exit 1
-
-			# Debug: Print the commit message file content
-			if [ -f "$COMMIT_MSG_FILE" ]; then
-				echo "Commit message content:"
-				cat "$COMMIT_MSG_FILE"
-			else
-				echo "❌ Commit message file not found!"
+```
+	# --- Commitlint Logic (force local config) ---
+	REPO_ROOT=$(git rev-parse --show-toplevel)
+	CONFIG_PATH="$REPO_ROOT/.commitlintrc.json"
+	echo "COMMIT_MSG_FILE is one msg behind it is only set to the commit your trying to commit after the commit succeeds so this script is one behind"
+	echo "so would work best in prepush template"
+	COMMIT_MSG_FILE="$REPO_ROOT/.git/COMMIT_EDITMSG"
+
+	# Check if the local .commitlintrc.json exists in the repository root
+	if [ -f "$CONFIG_PATH" ]; then
+
+		echo "✅ Local .commitlintrc.json found at: $CONFIG_PATH. Running commitlint..."
+		echo "⚠️ if commit lint fails in precommit its actually reading previous commit name you need to reset or squash make a new commit and change .git/COMMIT_EDITMSG to something that would pass. ⚠️"
+
+		if command -v npx &> /dev/null; then
+		
+				cd "$REPO_ROOT" || exit 1
+
+				# Debug: Print the commit message file content
+				if [ -f "$COMMIT_MSG_FILE" ]; then
+					echo "Commit message content:"
+					cat "$COMMIT_MSG_FILE"
+				else
+					echo "❌ Commit message file not found!"
+					exit 1
+				fi
+				
+				
+				# Run commitlint, explicitly pointing to the local config and providing the commit message via stdin
+				OUTPUT1=$(npx.cmd --no -- commitlint --config=".commitlintrc.json" --edit="$COMMIT_MSG_FILE" 2>&1)
+				
+				EXIT_CODE1=$?
+				# echo "!!!!!!!!!!! OUTPUT1"
+				# echo "$OUTPUT1"
+				
+				
+				# OUTPUT2=$(npx.cmd --no -- commitlint --config=".commitlintrc.json" --from=origin/master --to=HEAD 2>&1)
+				
+				# EXIT_CODE2=$?
+				# echo "!!!!!!!!!!! OUTPUT2"
+				# echo "$OUTPUT2"
+				
+				# OUTPUT3=$(npx.cmd --no -- commitlint --config=".commitlintrc.json"  --from-last-tag 2>&1)
+				
+				
+				# EXIT_CODE3=$?
+				# echo "!!!!!!!!!!! OUTPUT3"
+				# echo "$OUTPUT3"
+				
+
+
+			#if [ "$EXIT_CODE1" -ne 0 ] || [ "$EXIT_CODE2" -ne 0 ] || [ "$EXIT_CODE3" -ne 0 ];  then
+			if [ "$EXIT_CODE1" -ne 0 ];  then
+				echo "❌ Commitlint failed:"
+				
+				echo "$OUTPUT1"
 				exit 1
+			else
+				echo "✅ Commitlint passed!"
 			fi
-			
-			
-			# Run commitlint, explicitly pointing to the local config and providing the commit message via stdin
-			OUTPUT1=$(npx.cmd --no -- commitlint --config=".commitlintrc.json" --edit="$COMMIT_MSG_FILE" 2>&1)
-			
-			EXIT_CODE1=$?
-			# echo "!!!!!!!!!!! OUTPUT1"
-			# echo "$OUTPUT1"
-			
-			
-			# OUTPUT2=$(npx.cmd --no -- commitlint --config=".commitlintrc.json" --from=origin/master --to=HEAD 2>&1)
-			
-			# EXIT_CODE2=$?
-			# echo "!!!!!!!!!!! OUTPUT2"
-			# echo "$OUTPUT2"
-			
-			# OUTPUT3=$(npx.cmd --no -- commitlint --config=".commitlintrc.json"  --from-last-tag 2>&1)
-			
-			
-			# EXIT_CODE3=$?
-			# echo "!!!!!!!!!!! OUTPUT3"
-			# echo "$OUTPUT3"
-			
-
-
-        #if [ "$EXIT_CODE1" -ne 0 ] || [ "$EXIT_CODE2" -ne 0 ] || [ "$EXIT_CODE3" -ne 0 ];  then
-		if [ "$EXIT_CODE1" -ne 0 ];  then
-            echo "❌ Commitlint failed:"
-			
-            echo "$OUTPUT1"
-            exit 1
-        else
-            echo "✅ Commitlint passed!"
-        fi
-    else
-        echo "⚠️ npx not found. Please ensure Node.js and npm are installed to use commitlint."
-        # Optionally fail here
-        # exit 1
-    fi
-else
-    echo "ℹ️ No local .commitlintrc.json found in $REPO_ROOT. Skipping commitlint."
-fi
-`
+		else
+			echo "⚠️ npx not found. Please ensure Node.js and npm are installed to use commitlint."
+			# Optionally fail here
+			# exit 1
+		fi
+	else
+		echo "ℹ️ No local .commitlintrc.json found in $REPO_ROOT. Skipping commitlint."
+	fi
+```
 - open powershell admin
 	- go to e2e project bin/Debug/net8
 	- run the playwright script with "install"