lib.trivial.importJSON: add example

Add parity with importTOML.
NixOS · Jun 7, 2024 · 474d1b0 · 474d1b0
1 parent bdb3c20
commit 474d1b0
Showing 1 changed file with 31 additions and 0 deletions.
diff --git a/lib/trivial.nix b/lib/trivial.nix
@@ -623,6 +623,37 @@ in {
   /**
     Reads a JSON file.
 
+    # Examples
+    :::{.example}
+    ## `lib.trivial.importJSON` usage example
+
+    example.json
+    ```json
+    {
+      "title": "Example JSON",
+      "hello": {
+        "world": "foo",
+        "bar": {
+          "foobar": true
+        }
+      }
+    }
+    ```
+
+    ```nix
+    importJSON ./example.json
+    => {
+      title = "Example JSON";
+      hello = {
+        world = "foo";
+        bar = {
+          foobar = true;
+        };
+      };
+    }
+    ```
+
+    :::
 
     # Inputs