devenv: add tooling

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

Author: pbek

.envrc

@@ -1 +1,7 @@
-use nix
+export DIRENV_WARN_TIMEOUT=20s
+
+eval "$(devenv direnvrc)"
+
+# The use_devenv function supports passing flags to the devenv command
+# For example: use devenv --impure --option services.postgres.enable:bool true
+use devenv

.github/workflows/format-check.yml

@@ -0,0 +1,30 @@
+name: 📄 Check formatting
+
+on:
+  push:
+    branches-ignore:
+      - release
+    tags-ignore:
+      - "*"
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  format-check:
+    name: 📄 Check code formatting with "just fmt"
+    runs-on: ubuntu-latest
+    steps:
+      - name: 🧰 Checkout code
+        uses: actions/checkout@v5
+      - name: ⚙️ Install Nix
+        uses: cachix/install-nix-action@v31
+        with:
+          nix_path: nixpkgs=channel:nixos-unstable
+      - name: 🔒 Cache dependencies
+        uses: cachix/cachix-action@v16
+        with:
+          name: devenv
+      - name: 🔧 Install devenv.sh
+        run: nix profile install nixpkgs#devenv
+      - name: 🌳 Format code
+        run: devenv shell "just format-all"

.gitignore

@@ -7,3 +7,13 @@ docker/owncloud/certificates/*
 *.db*
 *.cache
 vendor
+
+# Devenv
+.devenv*
+devenv.local.nix
+
+# direnv
+.direnv
+
+# pre-commit
+.pre-commit-config.yaml

devenv.lock

@@ -0,0 +1,103 @@
+{
+  "nodes": {
+    "devenv": {
+      "locked": {
+        "dir": "src/modules",
+        "lastModified": 1755798632,
+        "owner": "cachix",
+        "repo": "devenv",
+        "rev": "e70f1e0a7da7ab9e74f2ed300cbf05f407fb107b",
+        "type": "github"
+      },
+      "original": {
+        "dir": "src/modules",
+        "owner": "cachix",
+        "repo": "devenv",
+        "type": "github"
+      }
+    },
+    "flake-compat": {
+      "flake": false,
+      "locked": {
+        "lastModified": 1747046372,
+        "owner": "edolstra",
+        "repo": "flake-compat",
+        "rev": "9100a0f413b0c601e0533d1d94ffd501ce2e7885",
+        "type": "github"
+      },
+      "original": {
+        "owner": "edolstra",
+        "repo": "flake-compat",
+        "type": "github"
+      }
+    },
+    "git-hooks": {
+      "inputs": {
+        "flake-compat": "flake-compat",
+        "gitignore": "gitignore",
+        "nixpkgs": [
+          "nixpkgs"
+        ]
+      },
+      "locked": {
+        "lastModified": 1755446520,
+        "owner": "cachix",
+        "repo": "git-hooks.nix",
+        "rev": "4b04db83821b819bbbe32ed0a025b31e7971f22e",
+        "type": "github"
+      },
+      "original": {
+        "owner": "cachix",
+        "repo": "git-hooks.nix",
+        "type": "github"
+      }
+    },
+    "gitignore": {
+      "inputs": {
+        "nixpkgs": [
+          "git-hooks",
+          "nixpkgs"
+        ]
+      },
+      "locked": {
+        "lastModified": 1709087332,
+        "owner": "hercules-ci",
+        "repo": "gitignore.nix",
+        "rev": "637db329424fd7e46cf4185293b9cc8c88c95394",
+        "type": "github"
+      },
+      "original": {
+        "owner": "hercules-ci",
+        "repo": "gitignore.nix",
+        "type": "github"
+      }
+    },
+    "nixpkgs": {
+      "locked": {
+        "lastModified": 1755783167,
+        "owner": "cachix",
+        "repo": "devenv-nixpkgs",
+        "rev": "4a880fb247d24fbca57269af672e8f78935b0328",
+        "type": "github"
+      },
+      "original": {
+        "owner": "cachix",
+        "ref": "rolling",
+        "repo": "devenv-nixpkgs",
+        "type": "github"
+      }
+    },
+    "root": {
+      "inputs": {
+        "devenv": "devenv",
+        "git-hooks": "git-hooks",
+        "nixpkgs": "nixpkgs",
+        "pre-commit-hooks": [
+          "git-hooks"
+        ]
+      }
+    }
+  },
+  "root": "root",
+  "version": 7
+}

devenv.nix

@@ -0,0 +1,49 @@
+{
+  pkgs,
+  ...
+}:
+
+{
+  # https://devenv.sh/supported-languages/php/
+  languages.php.enable = true;
+
+  # https://devenv.sh/packages/
+  packages = with pkgs; [
+    just
+    zellij
+  ];
+
+  enterShell = ''
+    echo "🛠️ QOwnNotesAPI dev shell"
+    echo "🐘 PHP version: $(php --version | head -n 1)"
+  '';
+
+  # https://devenv.sh/git-hooks/
+  git-hooks.hooks = {
+    # https://devenv.sh/reference/options/#git-hookshookstreefmt
+    # https://github.com/numtide/treefmt
+    # https://github.com/numtide/treefmt-nix
+    treefmt = {
+      enable = true;
+      settings.formatters = with pkgs; [
+        nodePackages.prettier
+        shfmt
+        nixfmt-rfc-style
+        statix
+        taplo
+        php83Packages.php-cs-fixer
+      ];
+    };
+
+    # https://devenv.sh/reference/options/#git-hookshooksdeadnix
+    # https://github.com/astro/deadnix
+    deadnix = {
+      enable = true;
+      settings = {
+        edit = true; # Allow to edit the file if it is not formatted
+      };
+    };
+  };
+
+  # See full reference at https://devenv.sh/reference/options/
+}

devenv.yaml

@@ -0,0 +1,4 @@
+# yaml-language-server: $schema=https://devenv.sh/devenv.schema.json
+inputs:
+  nixpkgs:
+    url: github:cachix/devenv-nixpkgs/rolling

docker/justfile

@@ -45,7 +45,7 @@ bash-root:
 
 # Run a sidecar container with more debugging tools
 slim-shell:
-    slim debug --target {{ containerName }}
+    nix-shell -p docker-slim --run "slim debug --target {{ containerName }}"
 
 # Turn off maintenance mode
 maintenance-mode-off:

justfile

@@ -43,7 +43,7 @@ git-apply-patch:
 # Run the GitHub Actions test workflow locally with act
 [group('dev')]
 github-run-test:
-    act -W .github/workflows/test.yml
+    nix-shell -p act --run "act -W .github/workflows/test.yml"
 
 # Open the project in the browser
 [group('dev')]
@@ -63,7 +63,12 @@ just-format:
 # Format all files
 [group('linter')]
 format args='':
-    nix-shell -p treefmt nodePackages.prettier shfmt nixfmt-rfc-style statix taplo php83Packages.php-cs-fixer --run "treefmt {{ args }}"
+    treefmt {{ args }}
+
+# Format all files using pre-commit
+[group('linter')]
+format-all args='':
+    pre-commit run --all-files {{ args }}
 
 # Add git commit hashes to the .git-blame-ignore-revs file
 [group('linter')]