Nix templates (#5)

README.md

@@ -13,6 +13,66 @@ list of all tasks running on ECS.
 
 ## Installation
 
+<details>
+<summary>Nix users</summary>
+
+### devenv
+
+Add the project input into the `devenv.yaml` file:
+
+```yml
+inputs:
+  iecs:
+    url: github:sestrella/iecs
+    overlays:
+      - default
+```
+
+To install the binary, add it to the `packages` section in the `devenv.nix`
+file:
+
+```nix
+packages = [ pkgs.iecs ];
+```
+
+### flake
+
+Add the project input into the `flake.nix` file:
+
+```nix
+inputs.iecs.url = "github:sestrella/iecs/nix_templates";
+```
+
+#### Using it as an overlay
+
+Add the project overlay to `nixpkgs`:
+
+```nix
+pkgs = import nixpkgs {
+  inherit system;
+  overlays = [ iecs.overlays.default ];
+};
+```
+
+Use the binary as derivation input for creating packages or shells:
+
+```nix
+buildInputs = [ pkgs.iecs ];
+```
+
+#### Using it as a package
+
+Use the binary as derivation input for creating packages or shells:
+
+```nix
+buildInputs = [ iecs.packages.${system}.default ];
+```
+
+</details>
+
+<details>
+<summary>Non-Nix users</summary>
+
 Clone the repository:
 
 ```
@@ -39,6 +99,8 @@ cp iecs ~/.local/bin/iecs
 > Check that the path where the binary is copied exists in the `PATH`
 > environment variable.
 
+</details>
+
 ## References
 
 - https://aws.github.io/aws-sdk-go-v2/docs/getting-started/

flake.nix

@@ -17,7 +17,7 @@
 
       systems = import systems;
 
-      perSystem = { config, system, pkgs, ... }: {
+      perSystem = { self', pkgs, system, ... }: {
         _module.args.pkgs = import nixpkgs {
           inherit system;
           overlays = [ gomod2nix.overlays.default ];
@@ -31,7 +31,7 @@
         };
 
         overlayAttrs = {
-          iecs = config.packages.default;
+          iecs = self'.packages.default;
         };
       };
     };

templates/.gitignore

@@ -0,0 +1,2 @@
+devenv.lock
+flake.lock

templates/devenv/.envrc

@@ -0,0 +1,3 @@
+source_url "https://raw.githubusercontent.com/cachix/devenv/82c0147677e510b247d8b9165c54f73d32dfd899/direnvrc" "sha256-7u4iDd1nZpxL4tCzmPG0dQgC5V+/44Ba+tHkPob1v2k="
+
+use devenv

templates/devenv/.gitignore

@@ -0,0 +1,9 @@
+# Devenv
+.devenv*
+devenv.local.nix
+
+# direnv
+.direnv
+
+# pre-commit
+.pre-commit-config.yaml

templates/devenv/devenv.nix

@@ -0,0 +1,5 @@
+{ pkgs, ... }:
+
+{
+  packages = [ pkgs.iecs ];
+}

templates/devenv/devenv.yaml

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

templates/flake-overlay/.envrc

@@ -0,0 +1 @@
+use flake

templates/flake-overlay/flake.nix

@@ -0,0 +1,26 @@
+{
+  inputs = {
+    iecs.url = "github:sestrella/iecs";
+    nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable";
+    systems.url = "github:nix-systems/default";
+  };
+
+  outputs = { iecs, nixpkgs, systems, ... }:
+    let
+      eachSystem = nixpkgs.lib.genAttrs (import systems);
+    in
+    {
+      devShells = eachSystem (system:
+        let
+          pkgs = import nixpkgs {
+            inherit system;
+            overlays = [ iecs.overlays.default ];
+          };
+        in
+        {
+          default = pkgs.mkShell {
+            buildInputs = [ pkgs.iecs ];
+          };
+        });
+    };
+}

templates/flake/.envrc

@@ -0,0 +1 @@
+use flake

templates/flake/flake.nix

@@ -0,0 +1,24 @@
+{
+  inputs = {
+    iecs.url = "github:sestrella/iecs";
+    nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable";
+    systems.url = "github:nix-systems/default";
+  };
+
+  outputs = { iecs, nixpkgs, systems, ... }:
+    let
+      eachSystem = nixpkgs.lib.genAttrs (import systems);
+    in
+    {
+      devShells = eachSystem (system:
+        let
+          iecsPkgs = iecs.packages.${system};
+          pkgs = nixpkgs.legacyPackages.${system};
+        in
+        {
+          default = pkgs.mkShell {
+            buildInputs = [ iecsPkgs.default ];
+          };
+        });
+    };
+}