Update formatting script to use pre-commit and GitHub Actions

.gitattributes

@@ -1 +1,8 @@
+# Normalize EOL for all files that Git considers text files.
+* text=auto eol=lf
+# Except for Windows-only / Visual Studio files
+*.bat eol=crlf
+*.sln eol=crlf
+*.csproj eol=crlf
+
 *.hdr binary

.github/workflows/file_format.py

@@ -0,0 +1,52 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+import sys
+
+if len(sys.argv) < 2:
+    print("Invalid usage of file_format.py, it should be called with a path to one or multiple files.")
+    sys.exit(1)
+
+BOM = b"\xef\xbb\xbf"
+
+changed = []
+invalid = []
+
+for file in sys.argv[1:]:
+    try:
+        with open(file, "rt", encoding="utf-8") as f:
+            original = f.read()
+    except UnicodeDecodeError:
+        invalid.append(file)
+        continue
+
+    if original == "":
+        continue
+
+    EOL = "\r\n" if file.endswith((".csproj", ".sln", ".bat")) else "\n"
+    WANTS_BOM = file.endswith((".csproj", ".sln"))
+
+    revamp = EOL.join([line.rstrip("\n\r\t ") for line in original.splitlines(True)]).rstrip(EOL) + EOL
+
+    new_raw = revamp.encode(encoding="utf-8")
+    if not WANTS_BOM and new_raw.startswith(BOM):
+        new_raw = new_raw[len(BOM) :]
+    elif WANTS_BOM and not new_raw.startswith(BOM):
+        new_raw = BOM + new_raw
+
+    with open(file, "rb") as f:
+        old_raw = f.read()
+
+    if old_raw != new_raw:
+        changed.append(file)
+        with open(file, "wb") as f:
+            f.write(new_raw)
+
+if changed:
+    for file in changed:
+        print(f"FIXED: {file}")
+
+if invalid:
+    for file in invalid:
+        print(f"REQUIRES MANUAL CHANGES: {file}")
+    sys.exit(1)

.github/workflows/static_checks.yml

@@ -0,0 +1,24 @@
+name: 📊 Static Checks
+on: [push, pull_request]
+
+concurrency:
+  group: ci-${{ github.actor }}-${{ github.head_ref || github.run_number }}-${{ github.ref }}-static
+
+jobs:
+  static-checks:
+    name: Code style and file formatting
+    runs-on: ubuntu-24.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 2
+
+      - name: Install Python dependencies and general setup
+        run: |
+          git config diff.wsErrorHighlight all
+
+      - name: Style checks via pre-commit
+        uses: pre-commit/action@v3.0.1
+        with:
+          extra_args: --all-files

.pre-commit-config.yaml

@@ -0,0 +1,16 @@
+default_language_version:
+  python: python3
+
+exclude: |
+  (?x)^(
+    CODE_OF_CONDUCT.md
+  )
+
+repos:
+  - repo: local
+    hooks:
+      - id: file-format
+        name: file-format
+        language: python
+        entry: python .github/workflows/file_format.py
+        types_or: [text]

appveyor.yml

@@ -10,13 +10,6 @@ configuration: Release
 environment:
   APPVEYOR_YML_DISABLE_PS_LINUX: true
 
-install:
-- sh: |
-    if [ "$(uname)" != "Darwin" ]; then
-      sudo apt-get update -y
-      sudo apt-get install -y dos2unix recode
-    fi
-    
 build_script:
   - ps: |
       New-Item -Path . -Name "build" -ItemType "directory"
@@ -33,12 +26,6 @@ build_script:
       cmake --build . --config ${CONFIGURATION}
       cd ../
 
-test_script:
-  - sh: |
-      if [ "$(uname)" != "Darwin" ]; then
-        bash ./format.sh
-      fi
-
 artifacts:
   # Linux
   - path: bin/basisu

format.sh

@@ -1,47 +0,0 @@
-#!/bin/bash
-
-# Loops through all text files tracked by Git.
-git grep -zIl '' |
-while IFS= read -rd '' f; do
-    # Exclude some types of files.
-    if [[ $f == *"proj" ]]; then
-        continue
-    elif [[ $f == *"filters" ]]; then
-        continue
-    elif [[ $f == *"sln" ]]; then
-        continue
-    elif [[ $f == *"json" ]]; then
-        continue
-    elif [[ $f == *"min.js" ]]; then
-        continue
-    elif [[ $f == *"coder.js" ]]; then
-        continue
-    fi
-    # Ensures that files are UTF-8 formatted.
-    recode UTF-8 $f 2> /dev/null
-    # Ensures that files have LF line endings.
-    dos2unix $f 2> /dev/null
-    # Ensures that files do not contain a BOM.
-    sed -i '1s/^\xEF\xBB\xBF//' "$f"
-    # Ensures that files end with newline characters.
-    tail -c1 < "$f" | read -r _ || echo >> "$f";
-done
-
-git diff > patch.patch
-FILESIZE=$(stat -c%s patch.patch)
-MAXSIZE=5
-
-# If no patch has been generated all is OK, clean up, and exit.
-if (( FILESIZE < MAXSIZE )); then
-    printf "Files in this commit comply with the formatting rules.\n"
-    rm -f patch.patch
-    exit 0
-fi
-
-# A patch has been created, notify the user, clean up, and exit.
-printf "\n*** The following differences were found between the code "
-printf "and the formatting rules:\n\n"
-cat patch.patch
-printf "\n*** Aborting, please fix your commit(s) with 'git commit --amend' or 'git rebase -i <hash>'\n"
-rm -f patch.patch
-exit 1