From eab59068866e9a933bd2b25ff33997c1ba482101 Mon Sep 17 00:00:00 2001
From: Daniel Baker <daniel.n.baker@gmail.com>
Date: Tue, 13 Feb 2024 18:25:39 -0800
Subject: [PATCH] Reworked the lesson to work off the previous section and
 focus solely on evaModules which is new.

---
 lessons/module-evaluation/config.nix  |  3 ++
 lessons/module-evaluation/eval.nix    | 26 +++++--------
 lessons/module-evaluation/lesson.md   | 54 ++++++++++++++++-----------
 lessons/module-evaluation/options.nix |  7 ++++
 lessons/module-evaluation/run         |  1 -
 lessons/module-evaluation/run.sh      |  1 +
 6 files changed, 52 insertions(+), 40 deletions(-)
 create mode 100644 lessons/module-evaluation/config.nix
 create mode 100644 lessons/module-evaluation/options.nix
 delete mode 100755 lessons/module-evaluation/run
 create mode 100755 lessons/module-evaluation/run.sh

diff --git a/lessons/module-evaluation/config.nix b/lessons/module-evaluation/config.nix
new file mode 100644
index 0000000..8e50687
--- /dev/null
+++ b/lessons/module-evaluation/config.nix
@@ -0,0 +1,3 @@
+{
+  config.name = "Boaty McBoatface";
+}
diff --git a/lessons/module-evaluation/eval.nix b/lessons/module-evaluation/eval.nix
index 96feba5..3f027ff 100644
--- a/lessons/module-evaluation/eval.nix
+++ b/lessons/module-evaluation/eval.nix
@@ -1,18 +1,10 @@
-{pkgs}: let
-  mymodule = {
-    imports = [
+{pkgs}:
+(
+  pkgs.lib.evalModules {
+    modules = [
+      ./options.nix
+      ./config.nix
     ];
-    options = {
-    };
-    config = {
-    };
-  };
-in
-  (
-    pkgs.lib.evalModules {
-      modules = [
-        mymodule
-      ];
-    }
-  )
-  .config
+  }
+)
+.config
diff --git a/lessons/module-evaluation/lesson.md b/lessons/module-evaluation/lesson.md
index 07438bf..8d13b38 100644
--- a/lessons/module-evaluation/lesson.md
+++ b/lessons/module-evaluation/lesson.md
@@ -1,38 +1,48 @@
 # Module Evaluation
 
-In the [eval][eval] file, we have declared an attrset called `mymodule` which is composed of 3
-fields: `imports`, `options` and `config`. This is a module with default values for those fields.
-You can omit any of those fields and they will use those same default values.
+Let us look at a basic, trivial example.
+We will use the `options.nix` and `config.nix` from the previous lesson.
 
-[//]: # (./eval.nix)
+In the `options.nix` file, we have a single option, `name`, that is of type `str`.
+
+[//]: # (./options.nix)
+
+In the `config.nix` file, we have defined a value for `name`.
 
-If you execute the run file (`./run`), you will see printed the empty JSON object `{}`.
+[//]: # (./config.nix)
 
-[eval]: ./eval.nix
+What do we do now?
 
-## Module Fields
+How do we combine these two modules together?
 
-The `options` field lets you define variables that can be used in the `config` section.
+With a simple function, `evalModules`.
 
-The `config` field assigns values to options defined in other modules. We call this using an option.
+``` nix
+pkgs.lib.evalModules {
+  modules = [
+    ./options.nix
+    ./config.nix
+  ];
+}
+```
 
-The `imports` field lets you import other modules from a module.
+That is it.
+Provide the modules you want to evaluate in a list to the `modules` attribute.
+`evalModules` will take take all the modules provided and intelligently merge them together.
 
-We will see what goes in those fields in later lessons.
+If we were to run that, we would get a big messy output.
+The result is a big attrset with several attributes.
+For now, the attribute we care about is `config`.
 
-## Evaluating Modules
+In the `eval.nix` file, we take the code from above and get the `config` attribute from the evaluation.
+
+[//]: # (./eval.nix)
 
-In the [eval][eval] file, we use a function called `evalModules`. This function takes an attrset as
-argument which can contain the field named `modules`. In there, we can put as many module as we
-want.
+In the `run.sh` file, we evaluate the `eval.nix` file and have it print out a nicely formatted version of the configuration.
 
-`evalModules` will then merge all `imports`, `options` and `config` fields of all given modules
-following some rules we will see in the next lessons. It then produces an attrset whose only
-interesting field - the result of merging all modules - is found in the `config` field. This is the
-one we print when executing the `./run` file.
+[//]: # (./run.sh)
 
-## Nixpkgs
+If you execute the run file (`./run.sh`), you should see an output that matches what we have configured.
 
-The vast majority of nixpkgs is made out of modules, all merged together in the top-level
-`evalModules`.
+[//]: # (self.eval)
 
diff --git a/lessons/module-evaluation/options.nix b/lessons/module-evaluation/options.nix
new file mode 100644
index 0000000..9d7cd31
--- /dev/null
+++ b/lessons/module-evaluation/options.nix
@@ -0,0 +1,7 @@
+{lib, ...}: {
+  options = {
+    name = lib.mkOption {
+      type = lib.types.str;
+    };
+  };
+}
diff --git a/lessons/module-evaluation/run b/lessons/module-evaluation/run
deleted file mode 100755
index 586fc86..0000000
--- a/lessons/module-evaluation/run
+++ /dev/null
@@ -1 +0,0 @@
-nix eval -f eval.nix --json | nix run nixpkgs#jq -- .
diff --git a/lessons/module-evaluation/run.sh b/lessons/module-evaluation/run.sh
new file mode 100755
index 0000000..8c5cb1a
--- /dev/null
+++ b/lessons/module-evaluation/run.sh
@@ -0,0 +1 @@
+nix eval -f eval.nix --apply 'x: x {pkgs = import <nixpkgs> {};}' --json | nix run nixpkgs#jq -- .