Merge pull request #1 from mlabs-haskell/avnik/scaffolding

scaffolding

.envrc

@@ -0,0 +1,5 @@
+if ! has nix_direnv_version || ! nix_direnv_version 2.2.0; then
+    source_url "https://raw.githubusercontent.com/nix-community/nix-direnv/2.2.0/direnvrc" "sha256-5EwyKnkJNQeXrRkYbwwRBcXbibosCJqyIUuz9Xq+LRc="
+fi
+nix_direnv_watch_file ./shell/default.nix flake.lock
+use flake -L

.gitignore

@@ -0,0 +1 @@
+.direnv

README.md

@@ -1 +1,17 @@
 # cardano.nix
+
+Collection of Cardano related NixOS modules, with a special focus on:
+
+- autogenerated documentation
+- comprehensive (NixOS) tests
+- an homogeneous module interface
+
+## Shell
+
+`cardano.nix` provides a shell that includes some useful aliases:
+
+- `fmt` formats the entire repository using [treefmt](https://github.com/numtide/treefmt)
+- `build-all` builds all the flake's outputs using [devour-flake](https://github.com/srid/devour-flake)
+- `check` simply stands for `nix flake check`
+
+A `.envrc` is also provided, using [direnv]() and [nix-direnv](https://github.com/nix-community/nix-direnv) is highly suggested.

checks/default.nix

@@ -0,0 +1,38 @@
+{inputs, ...}: {
+  perSystem = {
+    pkgs,
+    config,
+    ...
+  }: {
+    apps = {
+      nix-build-all.program = pkgs.writeShellApplication {
+        name = "nix-build-all";
+        runtimeInputs = [
+          (pkgs.callPackage inputs.devour-flake {})
+        ];
+        text = ''
+          # Make sure that flake.lock is sync
+          nix flake lock --no-update-lock-file
+
+          # Do a full nix build (all outputs)
+          devour-flake . "$@"
+        '';
+      };
+    };
+
+    devshells.default.commands = [
+      {
+        category = "Tools";
+        name = "build-all";
+        help = "Build all the checks";
+        command = config.apps.nix-build-all.program;
+      }
+      {
+        category = "Tools";
+        name = "check";
+        help = "Alias of `nix flake check`";
+        command = "nix flake check";
+      }
+    ];
+  };
+}

ci/default.nix

@@ -0,0 +1,6 @@
+{inputs, ...}: {
+  imports = [
+    inputs.hercules-ci-effects.flakeModule
+  ];
+  config.herculesCI.ciSystems = ["x86_64-linux" "x86_64-darwin"];
+}