Enforce new line at the end of textual files (#5050)

### Changes

- Add a script to check and add eol
- Add eol where required
- Add a CI step to enforce it

### Issues
fix #5014

Author: paolino

.buildkite/pipeline.yml

@@ -291,6 +291,13 @@ steps:
       agents:
         system: ${linux}
 
+    - label: Check eol is present
+      key: eol
+      depends_on: []
+      command: 'nix develop --command scripts/enforce-eol.sh'
+      agents:
+        system: ${linux}
+
   - group: Linux Benchmarks
     key: linux-benchmarks
     depends_on: linux-nix

configs/cardano/refresh.sh

@@ -4,4 +4,4 @@ set -euo pipefail
 
 for dir in preprod mainnet preview private sanchonet; do
   (cd "$dir" && ./download.sh)
-done
+done

configs/cardano/sanchonet/download.sh

@@ -8,4 +8,4 @@ wget https://book.play.dev.cardano.org/environments-pre/sanchonet/topology.json
 wget https://book.play.dev.cardano.org/environments-pre/sanchonet/byron-genesis.json
 wget https://book.play.dev.cardano.org/environments-pre/sanchonet/shelley-genesis.json
 wget https://book.play.dev.cardano.org/environments-pre/sanchonet/alonzo-genesis.json
-wget https://book.play.dev.cardano.org/environments-pre/sanchonet/conway-genesis.json
+wget https://book.play.dev.cardano.org/environments-pre/sanchonet/conway-genesis.json

docs/site/src/index.md

@@ -7,4 +7,4 @@ This project provides an HTTP Application Programming Interface (API) and comman
 It can be used as a component of a frontend such as [Daedalus][], which provides a friendly user interface for wallets. Most users who would like to use Cardano should start with Daedalus.
 
 [Cardano]: https://www.cardano.org/
-[Daedalus]: https://daedaluswallet.io/
+[Daedalus]: https://daedaluswallet.io/

docs/site/src/user/common-use-cases/delegation.md

@@ -148,4 +148,4 @@ I can now **sign** and **submit** such a transaction just like in
 
 ```admonish note
 All rewards will be withdrawn only if you add {"withdrawal":"self"} to the payload. You can achieve this with a single transaction, as shown above.
-```
+```

docs/site/src/user/security.md

@@ -6,4 +6,4 @@ In order to ensure that only trusted users may access the HTTP service, cardano-
 
 It’s worth mentioning that a trusted user can attack the wallet through the HTTP service in many ways, they can also view sensitive information, delete a wallet’s store, etc. Thus, as soon as an attacker is able to become a trusted user.
 
-It’s also worth mentioning that a trusted user that can access the HTTP API is not able to spend funds of the wallet without gaining access to additional information such as the passphrase or the wallet secret key. TLS prevents eavesdropping on the passphrase, and the wallet secret key is encrypted by the passphrase.
+It’s also worth mentioning that a trusted user that can access the HTTP API is not able to spend funds of the wallet without gaining access to additional information such as the passphrase or the wallet secret key. TLS prevents eavesdropping on the passphrase, and the wallet secret key is encrypted by the passphrase.

lib/delta-types/README.md

@@ -45,4 +45,4 @@ In general, there may be multiple delta types associated with a single base type
 
   [bobkonf2023]: https://bobkonf.de/2023/apfelmus.html
   [2002.05256]: https://arxiv.org/abs/2002.05256
-  [1811.06069]: https://arxiv.org/abs/1811.06069
+  [1811.06069]: https://arxiv.org/abs/1811.06069

nix/README.md

@@ -60,4 +60,4 @@ The `./nix/` directory contains various helper functions and utilities.
 
 * [Haskell.nix][]
     * Basic example with cross-compilation: https://github.com/input-output-hk/haskell-nix-example
-    * Setting up the binary cache to avoid recompiling GHC: https://input-output-hk.github.io/haskell.nix/tutorials/getting-started#setting-up-the-binary-cache
+    * Setting up the binary cache to avoid recompiling GHC: https://input-output-hk.github.io/haskell.nix/tutorials/getting-started#setting-up-the-binary-cache

scripts/buildkite/admin/flake.nix

@@ -35,4 +35,4 @@
         };
       }
     );
-}
+}

scripts/buildkite/main/linux-package.sh

@@ -9,4 +9,4 @@ git fetch --all
 git checkout "$RELEASE_CANDIDATE_COMMIT"
 
 rm -rf ./result/*
-nix build -L -o result/linux .#ci.artifacts.linux64.release
+nix build -L -o result/linux .#ci.artifacts.linux64.release

scripts/buildkite/release/openapi-diff.sh

@@ -28,4 +28,4 @@ mkdir -p artifacts
 # free the bin directory for buildkite to clean up
 chmod -R +w "$GOPATH"
 rm -rf "$GOPATH"
-rm -rf "$swagger_tmp"
+rm -rf "$swagger_tmp"

scripts/buildkite/release/push-to-dockerhub.sh

@@ -53,4 +53,4 @@ artifact() {
     fi
 }
 
-artifact "cardano-wallet-$NEW_GIT_TAG-docker-image.tgz"
+artifact "cardano-wallet-$NEW_GIT_TAG-docker-image.tgz"

scripts/buildkite/release/update-documentation-links.sh

@@ -10,4 +10,4 @@ git pull --rebase origin "${GH_PAGES_BRANCH}"
 cd releases
 ./make_redirects.sh "${RELEASE_VERSION}"
 git remote set-url origin "https://$GITHUB_TOKEN@github.com/cardano-foundation/cardano-wallet.git"
-git push origin "${GH_PAGES_BRANCH}"
+git push origin "${GH_PAGES_BRANCH}"

scripts/enforce-eol.sh

@@ -0,0 +1,51 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+
+# define command as the script parameter or default to check
+command=${1:-check}
+
+# traverse the directories and apply the operation to the files that match the regex
+traverse() {
+    local op=$1
+    local directory=$2
+    local regex=$3
+    find "$directory" -type f -regex "$regex" |
+        while read -r file; do
+            $op "$file"
+        done
+}
+
+# check if the file ends with a newline character and, depending on the command, add it
+# or bail out with an error message
+check() {
+    local file=$1
+    if [ -s "$file" ] && [ "$(tail -c 1 "$file")" != "" ]; then
+        case $command in
+        add)
+            echo "Adding newline character to $file"
+            echo "" >>"$file"
+            ;;
+        check)
+            echo "File $file does not end with a newline character."
+            echo "Fix this by running ./scripts/enforce-eol.sh add"
+            exit 1
+            ;;
+        *)
+            echo "Invalid command: $command"
+            echo "Usage: enforce-eol.sh [check|add]"
+            exit 1
+            ;;
+        esac
+    fi
+}
+
+directories=("lib" "scripts" "docs" "nix" "specifications" "configs")
+
+# json is not included because most of json is golden files. It would be better to
+# use the directories filter instead of the regex filter
+regex=".*\.\(md\|hs\|sh\|nix\|yaml\|yml\|toml\|cabal\)$"
+
+for directory in "${directories[@]}"; do
+    traverse check "$directory" "$regex"
+done

specifications/Cardano/Wallet/Primitive/Types/DeltaUTxO.md

@@ -123,4 +123,4 @@ Set DeltaUTxO ≈ (Set KeyDeltaUTxO, Map KeyDeltaUTxO DeltaUTxO)
 
 where the key replaces the polymorphic values, and the `Map` assigns the keys the values again.
 
-Note that this approach does require us to do manual key management — we have to create and destroy `KeyDeltaUTxO` as we add and remove elements from the container.
+Note that this approach does require us to do manual key management — we have to create and destroy `KeyDeltaUTxO` as we add and remove elements from the container.

specifications/Cardano/Wallet/Submissions/design.md

@@ -128,4 +128,4 @@ gantt
     Unknown    :2021-12-29 , 13d
 ```
 
-Note: Transactions with `Unknown` status cannot be partitioned by slot, we have to consider them through the entire timeline.
+Note: Transactions with `Unknown` status cannot be partitioned by slot, we have to consider them through the entire timeline.

specifications/Cardano/Wallet/delegation.md

@@ -146,4 +146,4 @@ data Operation slot drep pool
     = VoteAndDelegate (Maybe drep) (Maybe pool) slot
     | Deregister slot
     | Rollback slot
-```
+```