Turn qmk_firmware into a flake input

Author: agustinmista

README.md

@@ -85,6 +85,12 @@ Waiting for Teensy device...
 
 ## Notes
 
+- You can change the version of `qmk_firmware` used by nixcaps by overriding its `qmk_firmware` flake input as follows:
+
+  ```nix
+  nixcaps.inputs.qmk_firmware.url = "git+https://github.com/qmk/qmk_firmware?submodules=1&rev=<COMMIT_SHA>";
+  ```
+
 - Under the hood, this derivation first copies the files in `src` into `keyboards/<keyboard>/keymaps/nixcaps` inside an internal copy of the `qmk_firmware` repo, and then executes `qmk compile --keyboard <keyboard>[/<variant>] --keymap nixcaps`.
 
 - While it should be possible to flash the compiled firmwares using `qmk flash`, this command is only available while inside the `qmk_firmware` repo. So, it is not enough to provide such a derivation with just the compiled firmware, and one would have to copy the entire (or a large part of) the `qmk_firmware` repo as well. If you know how to implement this in an efficient way, let me know!

flake.lock

@@ -4,18 +4,27 @@
   inputs = {
     nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable";
     flake-utils.url = "github:numtide/flake-utils";
+    qmk_firmware = {
+      url = "git+https://github.com/qmk/qmk_firmware?submodules=1&rev=54e8fad959d6a6e53e08c62ac3a3c4d4bdc6c957";
+      flake = false;
+    };
   };
 
   outputs =
-    { nixpkgs, flake-utils, ... }:
+    {
+      nixpkgs,
+      flake-utils,
+      qmk_firmware,
+      ...
+    }:
     (flake-utils.lib.eachDefaultSystem (
       system:
       let
         pkgs = nixpkgs.legacyPackages.${system};
-        nixcaps = pkgs.callPackage ./nixcaps.nix { };
+        nixcaps = pkgs.callPackage ./nixcaps.nix { inherit qmk_firmware; };
       in
       {
-        packages = { inherit (nixcaps) compile qmk_firmware; };
+        packages = { inherit (nixcaps) compile; };
         formatter = pkgs.nixfmt-rfc-style;
       }
     ))

flake.nix

@@ -1,19 +1,12 @@
 {
+  qmk_firmware,
   qmk,
-  fetchFromGitHub,
   stdenv,
   writeShellScriptBin,
   symlinkJoin,
   lib,
 }:
-rec {
-  qmk_firmware = fetchFromGitHub {
-    owner = "qmk";
-    repo = "qmk_firmware";
-    rev = "0.30.3";
-    sha256 = "sha256-lM5B9xl7sSxGhI/fbS0ys22t5oVUp8aMLI4pzICEKHk=";
-    fetchSubmodules = true;
-  };
+{
   compile =
     {
       keyboard,

nixcaps.nix

@@ -5,6 +5,9 @@
     nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable";
     flake-utils.url = "github:numtide/flake-utils";
     nixcaps.url = "github:agustinmista/nixcaps/main";
+    # Uncomment the next line if you want to use a specific revision of
+    # qmk_firmware. Just make sure not to remove the submodules=1 part.
+    # nixcaps.inputs.qmk_firmware.url = "git+https://github.com/qmk/qmk_firmware?submodules=1&rev=54e8fad959d6a6e53e08c62ac3a3c4d4bdc6c957";
   };
 
   outputs =