bneradt commented on code in PR #12696: URL: https://github.com/apache/trafficserver/pull/12696#discussion_r2558384604
########## tools/whitespace-format.sh: ########## @@ -0,0 +1,95 @@ +#!/usr/bin/env bash +# +# Script to fix whitespace issues: trailing whitespace and DOS carriage returns. +# +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +set -e + +# Get the repository root +REPO_ROOT=$(cd $(dirname $0) && git rev-parse --show-toplevel) + +EXCLUDE_PATTERNS=( + "lib/yamlcpp" + "lib/Catch2" + "lib/systemtap" + ".gold:" + ".test_input" +) + +GREP_EXCLUDE_ARGS="" +for pattern in "${EXCLUDE_PATTERNS[@]}"; do + GREP_EXCLUDE_ARGS="${GREP_EXCLUDE_ARGS} | grep -F -v '${pattern}'" +done + +echo "Fixing whitespace issues in ${REPO_ROOT}" + +# Should the file be excluded? +should_exclude() { + local file="$1" + for pattern in "${EXCLUDE_PATTERNS[@]}"; do + if echo "$file" | grep -F -q "$pattern"; then + return 0 + fi + done + return 1 +} + +if [[ "$OSTYPE" == "darwin"* ]]; then + SED_INPLACE=(sed -i '') +else + SED_INPLACE=(sed -i) +fi + +FILES_MODIFIED=0 + +# Fix trailing whitespace. +echo "Checking for trailing whitespace..." +TRAILING_WS_FILES=$(git grep -IE ' +$' | eval "grep -F -v 'lib/yamlcpp' | grep -F -v 'lib/Catch2' | grep -F -v 'lib/systemtap' | grep -F -v '.gold:' | grep -F -v '.test_input'" | cut -d: -f1 | sort -u || true) + +if [ -n "$TRAILING_WS_FILES" ]; then + while IFS= read -r file; do + if [ -f "$file" ]; then + echo " Fixing trailing whitespace in: $file" + "${SED_INPLACE[@]}" 's/[[:space:]]*$//' "$file" Review Comment: Maybe in theory. Keep in mind this will fail CI today if that ever is the case because that check is done in CI now. My intention with this PR is to pull the CI check to a local change so that things fail locally rather than later in CI. For reference, here's the CI check that this file borrows logic from: https://github.com/apache/trafficserver-ci/blob/2286af7d567d1f36a78aeb138a97cf9f3dc70b45/jenkins/github/format.pipeline#L62-L74 Even better: with this change, I can take these special white space checks out of CI and just use this format target alone. Then if such a string is added, this script can be updated for it along with the PR that introduces such problems. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
