Add flake.nix

.gitignore

@@ -163,3 +163,6 @@ compile_flags.txt
 
 # Local .envrc overrides
 .envrc.local
+
+# nix-direnv artifacts
+.direnv/

CONTRIBUTING.md

@@ -19,7 +19,7 @@ If you encounter any issues when following along with this file please don't hes
 - [**Doxygen**](https://www.doxygen.nl): For building the C-Reference documentation pages.
 
 
-##### For Linux
+#### For Linux
 
 Before installing the dependencies, you need to add the LLVM repository and GPG key to get Clang 21:
 
@@ -40,7 +40,7 @@ or:
 sudo apt-get install check clang-21 clang-tidy-21 clang-format-21 emscripten doxygen
 ```
 
-##### For macOS (using Homebrew)
+#### For macOS (using Homebrew)
 
 ```bash
 brew bundle
@@ -51,6 +51,16 @@ or:
 brew install check llvm@21 emscripten doxygen
 ```
 
+#### Nix flake
+
+Additionally we provide a `flake.nix` file which includes all dependencies and configuration to easily get started with Herb development. The recommended way to use it is by adding something like the following to `.envrc.local`:
+
+```sh
+use flake . --no-write-lock-file
+```
+
+If you'd prefer to have a  `flake.lock` use `use flake` instead and ignore the lockfile by adding it to `.git/info/exclude`.
+
 ### Building
 
 #### Clone the Repo

flake.nix

@@ -0,0 +1,68 @@
+{
+  description = "Herb";
+
+  inputs = {
+    nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
+    flake-utils.url = "github:numtide/flake-utils";
+  };
+
+  outputs =
+    {
+      self,
+      nixpkgs,
+      flake-utils,
+    }:
+    flake-utils.lib.eachDefaultSystem (
+      system:
+      let
+        pkgs = nixpkgs.legacyPackages.${system};
+      in
+      {
+        devShells.default = pkgs.mkShell {
+          packages = with pkgs; [
+            # JavaScript/TypeScript
+            nodejs_22
+            yarn
+
+            # Ruby
+            ruby_4_0
+            bundler
+
+            # Rust
+            rustc
+            cargo
+            clippy
+            rustfmt
+
+            # Java (JNI bindings)
+            jdk17
+
+            # C/C++ toolchain
+            llvmPackages_21.clang
+            llvmPackages_21.clang-tools # clang-format, clang-tidy
+
+            # C testing
+            check
+
+            # WebAssembly
+            emscripten
+
+            # Documentation
+            doxygen
+
+            # Build tools and libraries
+            gnumake
+            libyaml
+            nodePackages."yarn"
+          ];
+
+          shellHook = ''
+            export cc=clang
+            export clang_format=clang-format
+            export clang_tidy=clang-tidy
+            export check_prefix=${pkgs.check}
+          '';
+        };
+      }
+    );
+}