Introduce EditorConfig

Originally, the indentation of the scripts was not unified: ones in
'scripts/' used 2 spaces, and ones in '.ci/' used 4. Even though the
former used 2 spaces, the style was not implemented well as some indents
in the files were 4 spaces.

This patch unifies the style of the scripts, and note it with an
EditorConfig file. EditorConfig is used because it's supported
out-of-the-box by many editors, helping the auto-indent functionality
works.

Change-Id: I41be8779ef5b0e94192c144bb48605625727963f

Author: lumynou5

.ci/check-format.sh

@@ -6,7 +6,7 @@ set -x
 
 for file in ${SOURCES};
 do
-    clang-format-18 ${file} > expected-format
-    diff -u -p --label="${file}" --label="expected coding style" ${file} expected-format
+  clang-format-18 ${file} > expected-format
+  diff -u -p --label="${file}" --label="expected coding style" ${file} expected-format
 done
 exit $(clang-format-18 --output-replacements-xml ${SOURCES} | grep -E -c "</replacement>")

.ci/check-newline.sh

@@ -6,14 +6,14 @@ ret=0
 show=0
 # Reference: https://medium.com/@alexey.inkin/how-to-force-newline-at-end-of-files-and-why-you-should-do-it-fdf76d1d090e
 while IFS= read -rd '' f; do
-    if file --mime-encoding "$f" | grep -qv binary; then
-        tail -c1 < "$f" | read -r _ || show=1
-        if [ $show -eq 1 ]; then
-            echo "Warning: No newline at end of file $f"
-            ret=1
-            show=0
-        fi
+  if file --mime-encoding "$f" | grep -qv binary; then
+    tail -c1 < "$f" | read -r _ || show=1
+    if [ $show -eq 1 ]; then
+      echo "Warning: No newline at end of file $f"
+      ret=1
+      show=0
     fi
+  fi
 done < <(git ls-files -z src tests/arch-test-target)
 
 exit $ret

.ci/check-provisioning.sh

@@ -2,7 +2,7 @@
 
 PROVISION_DIR=lab0-c-private
 if test -f $PROVISION_DIR/queue.c; then
-    cp -f $PROVISION_DIR/queue.c .
-    # Skip complexity checks
-    sed -i '/17:/d' scripts/driver.py
+  cp -f $PROVISION_DIR/queue.c .
+  # Skip complexity checks
+  sed -i '/17:/d' scripts/driver.py
 fi

.ci/check-sanity.sh

@@ -2,11 +2,11 @@
 
 SHA1SUM=$(which sha1sum)
 if [ $? -ne 0 ]; then
-    SHA1SUM=shasum
+  SHA1SUM=shasum
 fi
 
 $SHA1SUM -c scripts/checksums
 if [ $? -ne 0 ]; then
-    echo "[!] You are not allowed to change the header file queue.h or list.h" >&2
-    exit 1
+  echo "[!] You are not allowed to change the header file queue.h or list.h" >&2
+  exit 1
 fi

.editorconfig

@@ -0,0 +1,23 @@
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+
+[Makefile]
+indent_style = tab
+indent_size = 4
+max_line_length = 80
+
+[**/*.[ch]]
+indent_style = space
+indent_size = 4
+max_line_length = 80
+
+[**/*.py]
+indent_style = space
+indent_size = 4
+
+[**/*.{sh,hook,yml}]
+indent_style = space
+indent_size = 2

.github/workflows/main.yml

@@ -10,33 +10,33 @@ jobs:
     - uses: webfactory/[email protected]
       continue-on-error: true
       with:
-          ssh-private-key: ${{ secrets.SSH_PRIVATE_KEY }}
+        ssh-private-key: ${{ secrets.SSH_PRIVATE_KEY }}
     - name: install-dependencies
       run: |
-            .ci/check-sanity.sh
-            sudo apt-get update
-            sudo apt-get -q -y install build-essential cppcheck
+        .ci/check-sanity.sh
+        sudo apt-get update
+        sudo apt-get -q -y install build-essential cppcheck
     - name: make
       run:  |
-            git clone [email protected]:sysprog21/lab0-c-private || echo "No provisioning profile found"
-            .ci/check-provisioning.sh
-            make
+        git clone [email protected]:sysprog21/lab0-c-private || echo "No provisioning profile found"
+        .ci/check-provisioning.sh
+        make
     - name: make check
       run: |
-            make check || (cat scripts/weeping.raw ; exit 1)
-            cat scripts/kirby.raw
+        make check || (cat scripts/weeping.raw ; exit 1)
+        cat scripts/kirby.raw
     - name: make test
       run: |
-            make test || (cat scripts/weeping.raw ; exit 1)
-            cat scripts/kirby.raw
+        make test || (cat scripts/weeping.raw ; exit 1)
+        cat scripts/kirby.raw
 
   coding-style:
     runs-on: ubuntu-24.04
     steps:
     - uses: actions/checkout@v4
     - name: coding convention
       run: |
-            sudo apt-get install -q -y clang-format-18
-            .ci/check-newline.sh
-            .ci/check-format.sh
+        sudo apt-get install -q -y clang-format-18
+        .ci/check-newline.sh
+        .ci/check-format.sh
       shell: bash

scripts/aspell-pws

@@ -350,3 +350,4 @@ typedef
 BitInt
 noreturn
 pragma
+EditorConfig

scripts/check-repo.sh

@@ -81,7 +81,7 @@ curl -sSL -o "$temp_file" "$COMMITS_URL"
 # general grep pattern that finds commit links
 upstream_hash=$(
   grep -Po 'href="[^"]*/commit/\K[0-9a-f]{40}' "$temp_file" \
-  | head -n 1
+    | head -n 1
 )
 
 rm -f "$temp_file"

scripts/commit-msg.hook

@@ -119,7 +119,7 @@ get_all_match_positions() {
 
     # skip if the target is not found
     [ -z "$result" ] && continue
-    
+
     # output and update states
     local line col
     read -r line col <<< "$result"
@@ -250,13 +250,13 @@ validate_commit_message() {
   # ------------------------------------------------------------------------------
   ASPELL=$(which aspell)
   if [ $? -ne 0 ]; then
-      echo "Aspell not installed - unable to check spelling"
+    echo "Aspell not installed - unable to check spelling"
   else
-      LINE_NUMBER=1
-      MISSPELLED_WORDS=$(echo "$COMMIT_MSG_LINES[LINE_NUMBER]" | $ASPELL --lang=en --list --home-dir=scripts --personal=aspell-pws)
-      if [ -n "$MISSPELLED_WORDS" ]; then
-        add_warning LINE_NUMBER "Possible misspelled word(s): $MISSPELLED_WORDS"
-      fi
+    LINE_NUMBER=1
+    MISSPELLED_WORDS=$(echo "$COMMIT_MSG_LINES[LINE_NUMBER]" | $ASPELL --lang=en --list --home-dir=scripts --personal=aspell-pws)
+    if [ -n "$MISSPELLED_WORDS" ]; then
+      add_warning LINE_NUMBER "Possible misspelled word(s): $MISSPELLED_WORDS"
+    fi
   fi
 
   # 1. Separate subject from body with a blank line
@@ -453,7 +453,7 @@ validate_commit_message() {
   FULL_COMMIT_MSG_WITH_SPACE=$(sed '/^[[:space:]]*#/d' "$COMMIT_MSG_FILE" | \
                                sed -E "/$TRAILER_REGEX/d" | sed -E "s@${URL_REGEX#^}@@g")
   FULL_COMMIT_MSG=$(echo "$FULL_COMMIT_MSG_WITH_SPACE" | sed '/^[[:space:]]*$/d')
-  
+
   # Extended list of abusive words (case-insensitive).
   # Adjust the list as needed.
   ABUSIVE_WORDS_REGEX='\b(fuck|fucking|dick|shit|bitch|asshole|cunt|motherfucker|damn|crap|dumbass|piss)\b'
@@ -475,7 +475,7 @@ validate_commit_message() {
     -e "s/(['\"][^'\"]*['\"])//g" \
     -e "s/\bcommit[[:space:]]+[0-9a-fA-F]{7,40}\b/commit/g")
   MSG_FOR_SPELLCHECK=$(echo "$MSG_FOR_SPELLCHECK_LINE_FINDING" | sed '/^[[:space:]]*$/d')
-  
+
   # Use aspell to list misspelled words according to American English, ignoring quoted text.
   MISSPELLED_WORDS=$(echo "$MSG_FOR_SPELLCHECK" | $ASPELL --lang=en --list --home-dir=scripts --personal=aspell-pws)
   if [ -n "$MISSPELLED_WORDS" ]; then
@@ -639,8 +639,7 @@ _gen_changeid_input() {
 }
 
 _gen_changeid() {
-  _gen_changeid_input |
-  git hash-object -t commit --stdin
+  _gen_changeid_input | git hash-object -t commit --stdin
 }
 
 # It's showtime.

scripts/pre-commit.hook

@@ -228,7 +228,7 @@ fi
 # Cross platform projects tend to avoid non-ASCII filenames; prevent
 # them from being added to the repository.
 if test $(git diff --cached --name-only --diff-filter=A -z $against |
-        LC_ALL=C tr -d '[ -~]\0' | wc -c) != 0
+          LC_ALL=C tr -d '[ -~]\0' | wc -c) != 0
 then
   cat <<\EOF
 ERROR: Attempt to add a non-ASCII file name.