blob: 0349e466a166b0beaeb88bb421fe52029c38f249 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
|
# html.nix — _the_ most cursed Nix HTML DSL
A quick example to show you what it looks like:
```nix
# Note: this example is for standalone usage out of depot
{ pkgs ? import <nixpkgs> {} }:
let
# zero dependency, one file implementation
htmlNix = import ./path/to/html.nix { };
# make the magic work
inherit (htmlNix) __findFile esc withDoctype;
in
pkgs.writeText "example.html" (withDoctype (<html> {} [
(<head> {} [
(<meta> { charset = "utf-8"; } null)
(<title> {} (esc "hello world"))
])
(<body> {} [
(<h1> {} (esc "hello world"))
(<p> { class = "intro"; } (esc ''
welcome to the land of sillyness!
''))
(<ul> {} [
(<li> {} [
(esc "check out ")
(<a> { href = "https://code.tvl.fyi"; } "depot")
])
(<li> {} [
(esc "find ")
(<a> { href = "https://cl.tvl.fyi/q/hashtag:cursed"; } "cursed things")
])
])
])
]))
```
Convince yourself it works:
```console
$ $BROWSER $(nix-build example.nix)
```
Alternatively, in depot:
```console
$ $BROWSER $(nix-build -A users.sterni.nix.html.tests)
```
## Creating tags
An empty tag is passed `null` as its content argument:
```nix
<link> {
rel = "stylesheet";
href = "/main.css";
type = "text/css";
} null
# => "<link href=\"/main.css\" rel=\"stylesheet\" type=\"text/css\"/>"
```
Content is expected to be HTML:
```nix
<div> { class = "foo"; } "<strong>hi</strong>"
# => "<div class=\"foo\"><strong>hi</strong></div>"
```
If it's not, be sure to escape it:
```nix
<p> {} (esc "A => B")
# => "<p>A => B</p>"
```
Nesting tags works of course:
```nix
<div> {} (<strong> {} (<em> {} "hi"))
# => "<div><strong><em>hi</em></strong></div>"
```
If the content of a tag is a list, it's concatenated:
```nix
<h1> {} [
(esc "The ")
(<strong> {} "Nix")
(esc " ")
(<em> {} "Expression")
(esc " Language")
]
# => "<h1>The <strong>Nix</strong> <em>Expression</em> Language</h1>"
```
More detailed documentation can be found in `nixdoc`-compatible
comments in the source file (`default.nix` in this directory).
## How does this work?
*Theoretically* expressions like `<nixpkgs>` are just ordinary paths —
their actual value is determined from `NIX_PATH`. `html.nix` works
because of how this is actually implemented: At [parse time][spath-parsing]
Nix transparently translates an expression like `<foo>` into
`__findFile __nixPath "foo"`:
```
nix-repl> <nixpkgs>
/nix/var/nix/profiles/per-user/root/channels/vuizvui/nixpkgs
nix-repl> __findFile __nixPath "nixpkgs"
/nix/var/nix/profiles/per-user/root/channels/vuizvui/nixpkgs
```
This translation doesn't take any scoping issues into account --
so we can just shadow `__findFile` and make it return anything,
even a function:
```
nix-repl> __findFile = nixPath: str:
/**/ if str == "double" then x: x * 2
else if str == "triple" then x: x * 3
else throw "what?"
nix-repl> <double> 2
4
nix-repl> <triple> 3
9
nix-repl> <quadruple> 4
error: what?
```
Exactly this is what we are doing in `html.nix`:
Using `let inherit (htmlNix) __findFile; in` we shadow the builtin `__findFile`
with a function which returns a function rendering a particular HTML tag.
[spath-parsing]: https://github.com/NixOS/nix/blob/293220bed5a75efc963e33c183787e87e55e28d9/src/libexpr/parser.y#L410-L416
|
