treefmt: add config, tooling and pre-commit hook

Signed-off-by: Patrizio Bekerle <patrizio@bekerle.com>

Author: pbek

.scripts/pre-commit.sh

@@ -0,0 +1,10 @@
+#!/usr/bin/env bash
+# pre-commit hook script
+
+echo "Running pre-commit hook with treefmt"
+
+# Run treefmt to format the code and check if there are any changes after formatting
+if ! just fmt --fail-on-change; then
+  echo -e "\nCode may have been formatted. Please review the changes and commit again."
+  exit 1
+fi

justfile

@@ -9,6 +9,10 @@ default:
 
 transferDir := `if [ -d "$HOME/NextcloudPrivate/Transfer" ]; then echo "$HOME/NextcloudPrivate/Transfer"; else echo "$HOME/Nextcloud/Transfer"; fi`
 
+# Aliases
+
+alias fmt := format
+
 # Apply the patch to the qownnotes-scripts repository
 [group('patch')]
 git-apply-patch:
@@ -35,3 +39,8 @@ just-format:
         echo "Formatting $file"
         just --fmt --unstable -f "$file"
     done
+
+# Format all files
+[group('linter')]
+format args='':
+    nix-shell -p treefmt nodePackages.prettier shfmt nixfmt-rfc-style statix taplo kdePackages.qtdeclarative --run "treefmt {{ args }}"

shell.nix

@@ -1,7 +1,20 @@
-{ pkgs ? import <nixpkgs> {} }:
-  pkgs.mkShell {
-    nativeBuildInputs = with pkgs; [
-      php
-      just
-    ];
+{
+  pkgs ? import <nixpkgs> { },
+}:
+pkgs.mkShell {
+  nativeBuildInputs = with pkgs; [
+    php
+    just
+  ];
+
+  shellHook = ''
+    # Determine the repository root
+    REPO_ROOT=$(git rev-parse --show-toplevel 2>/dev/null)
+
+    # Check if we are in the repository root
+    if [ "$REPO_ROOT" = "$(pwd)" ]; then
+      # Symlink the pre-commit hook into the .git/hooks directory
+      ln -sf ../../.scripts/pre-commit.sh .git/hooks/pre-commit
+    fi
+  '';
 }

treefmt.toml

@@ -0,0 +1,39 @@
+# https://github.com/numtide/treefmt
+# https://github.com/numtide/treefmt-nix
+
+on-unmatched = "info"
+
+[formatter.prettier]
+command = "prettier"
+options = ["--write"]
+includes = ["*.js", "*.md", "*.yaml", "*.yml", "*.json"]
+
+[formatter.shfmt]
+command = "shfmt"
+includes = ["*.sh", "*.bash", "*.envrc", "*.envrc.*"]
+options = ["-s", "-w", "-i", "2"]
+
+[formatter.just]
+command = "just"
+includes = ["*.just"]
+
+[formatter.taplo]
+command = "taplo"
+includes = ["*.toml"]
+options = ["format"]
+
+[formatter.nixfmt-rfc-style]
+command = "nixfmt"
+includes = ["*.nix"]
+
+# Statix doesn't support formatting single files, see https://github.com/oppiliappan/statix/issues/69
+# Workaround: https://github.com/numtide/treefmt/issues/241#issuecomment-1614563462
+[formatter.statix]
+command = "bash"
+options = ["-euc", "for file in \"$@\"; do statix fix \"$file\"; done"]
+includes = ["*.nix"]
+
+[formatter.qmlformat]
+includes = ["*.qml"]
+command = "qmlformat"
+options = ["--inplace", "--normalize"]