From 26790f3f913229d63591a17802c6983badab5d6e Mon Sep 17 00:00:00 2001 From: vx-clutch Date: Mon, 21 Jul 2025 20:41:56 -0400 Subject: [PATCH] this is a differenet branch so this can be the commit message --- tools/Cleanup | 36 ++++++++++++++ tools/check-copyright-headers | 40 ---------------- tools/{add-header => check_header_footer} | 57 ++++++++++++++++------- tools/format | 2 + 4 files changed, 77 insertions(+), 58 deletions(-) create mode 100644 tools/Cleanup delete mode 100644 tools/check-copyright-headers rename tools/{add-header => check_header_footer} (65%) mode change 100644 => 100755 diff --git a/tools/Cleanup b/tools/Cleanup new file mode 100644 index 0000000..7ea96df --- /dev/null +++ b/tools/Cleanup @@ -0,0 +1,36 @@ +#!/bin/env bash + +# Usage: ./Cleanup [FILE]... + +lint_file() { + cppcheck --enable=all --quiet "$1" +} + +whitespace_cleanup() { + sed -i 's/[ \t]*$//' "$1" + awk 'BEGIN{ORS=""} {print $0 "\n"} END{}' "$1" > "$1.tmp" && mv "$1.tmp" "$1" +} + +comment_check() { + if grep -n -E 'TODO|FIXME' "$1"; then + echo "[WARN] $1 contains TODO/FIXME comments." + fi +} + +process_file() { + clang-format -i "$1" + tools/check_header_footer "$1" + lint_file "$1" + whitespace_cleanup "$1" + comment_check "$1" +} + +if [[ $# -gt 0 ]]; then + for file in "$@"; do + process_file "$file" + done +else + for file in $(find yait core -type f \( -name "*.c" -o -name "*.h" \)); do + process_file "$file" + done +fi \ No newline at end of file diff --git a/tools/check-copyright-headers b/tools/check-copyright-headers deleted file mode 100644 index 3e03cb6..0000000 --- a/tools/check-copyright-headers +++ /dev/null @@ -1,40 +0,0 @@ -#!/usr/bin/env bash - -if pwd | grep -q tools; then - cd .. -fi - -files=$(find iota/ \( -name '*.c' -o -name '*.h' \)) -files+=" $(find . -maxdepth 1 -type f)" - -ignore="README COPYING .clang-format" - -if [ -z "$files" ]; then - echo "No files found" - exit 0 -fi - -missing="" - -for file in $files; do - if echo "$ignore" | grep -qw "$(basename "$file")"; then - continue - fi - echo -ne "$file... " - if grep -q "Copyright (C)" "$file"; then - echo -e "\033[1;32mOK\033[0m" - else - echo -e "\033[0;31mFAIL\033[0m" - missing+="$file " - fi -done - -if [ "$missing" = "" ]; then - echo -e "\033[1;32mAll checks pass.\033[0m" -else - echo -e "\033[0;31mThe follwing files are missing copyright information.\033[0m" -fi - -for file in $missing; do - echo " - $file" -done diff --git a/tools/add-header b/tools/check_header_footer old mode 100644 new mode 100755 similarity index 65% rename from tools/add-header rename to tools/check_header_footer index 56bf2f3..3eb2be7 --- a/tools/add-header +++ b/tools/check_header_footer @@ -1,12 +1,20 @@ -#!/usr/bin/env bash +#!/bin/bash + +# Usage: ./ensure_header_footer.sh filename + +FILE="$1" +HEADER=$(cat <<'EOF' +// Copyright (C) 2025 vx_clutch ( owestness@gmail.com ) +// See end of file for extended copyright information. +EOF +) +HEADER+=$'\n' +FOOTER=$(cat <<'EOF' -header="// Copyright (C) 2025 $1 ( owestness@gmail.com ) -// See end of file for extended copyright information.\n" -footer=" /* yait is yet another init tool. - * Copyright (C) 2025 $1 + * Copyright (C) 2025 vx-clutch * - * The file is part of yait. + * This file is part of yait. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met: @@ -20,7 +28,7 @@ footer=" * used to endorse or promote products derived from this software without * specific prior written permission. * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE @@ -32,19 +40,32 @@ footer=" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE * POSSIBILITY OF SUCH DAMAGE. */ -" +EOF +) -if [[ "$#" -lt 1 ]]; then - echo "Usage: $0 name file1 [file2 ...]" +if [[ -z "$FILE" ]]; then + echo "Usage: $0 " exit 1 fi -for file in "${@:2}"; do - if [[ ! -f "$file" ]]; then - echo "Error: File '$file' not found, skipping." - continue - fi +if [[ ! -f "$FILE" ]]; then + echo "Error: File '$FILE' does not exist." + exit 1 +fi - echo -e "$header\n$(cat "$file")\n$footer" > "$file" - echo "Processed file: $file" -done +TMP_FILE="$(mktemp)" + +read -r FIRST_LINE < "$FILE" +if [[ "$FIRST_LINE" != "$HEADER" ]]; then + echo "$HEADER" > "$TMP_FILE" + cat "$FILE" >> "$TMP_FILE" + mv "$TMP_FILE" "$FILE" +else + rm "$TMP_FILE" +fi + +if [[ "$(tail -n 1 "$FILE")" != "$FOOTER" ]]; then + echo "$FOOTER" >> "$FILE" +fi + +echo "Checked '$FILE' for header/footer." diff --git a/tools/format b/tools/format index b9b2492..239ac47 100755 --- a/tools/format +++ b/tools/format @@ -1,3 +1,5 @@ #!/usr/bin/env bash +# Usage ./format + find . -name "*.c" -exec clang-format -i {} \;