···

       
26
       
 
       
      extraHeader = ''xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" '';

     

       
27
       
 
       
    in ''

     

       
28
       
 
       
      {

     

       
29
       
-
       
        pandoc '${inputFile}' -w docbook ${lib.optionalString useChapters "--chapters"} \

     

       
30
       
 
       
          --smart \

     

       
31
       
 
       
          | sed -e 's|<ulink url=|<link xlink:href=|' \

     

       
32
       
 
       
              -e 's|</ulink>|</link>|' \

     

···

       
26
       
 
       
      extraHeader = ''xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" '';

     

       
27
       
 
       
    in ''

     

       
28
       
 
       
      {

     

       
29
       
+
       
        pandoc '${inputFile}' -w docbook ${lib.optionalString useChapters "--top-level-division=chapter"} \

     

       
30
       
 
       
          --smart \

     

       
31
       
 
       
          | sed -e 's|<ulink url=|<link xlink:href=|' \

     

       
32
       
 
       
              -e 's|</ulink>|</link>|' \

     

···

       
2
       
 
       
         xmlns:xlink="http://www.w3.org/1999/xlink"

     

       
3
       
 
       
         xml:id="sec-beam">

     

       
4
       
 
       


     

       
5
       
-
       
  <title>Beam Languages (Erlang &amp; Elixir)</title>

     

       
6
       
 
       
  <section xml:id="beam-introduction">

     

       
7
       
 
       
    <title>Introduction</title>

     

       
8
       
 
       
    <para>

     

       
9
       
-
       
      In this document and related Nix expressions we use the term

     

       
10
       
-
       
      <emphasis>Beam</emphasis> to describe the environment. Beam is

     

       
11
       
-
       
      the name of the Erlang Virtial Machine and, as far as we know,

     

       
12
       
-
       
      from a packaging perspective all languages that run on Beam are

     

       
13
       
-
       
      interchangable. The things that do change, like the build

     

       
14
       
-
       
      system, are transperant to the users of the package. So we make

     

       
15
       
-
       
      no distinction.

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
16
       
 
       
    </para>

     

       
17
       
 
       
  </section>

     

       
18
       
-
       
<section xml:id="build-tools">

     

       
19
       
 
       
  <title>Build Tools</title>

     

       
20
       
 
       
  <section xml:id="build-tools-rebar3">

     

       
21
       
 
       
    <title>Rebar3</title>

     

       
22
       
 
       
    <para>

     

       
23
       
-
       
      By default Rebar3 wants to manage it's own dependencies. In the

     

       
24
       
-
       
      normal non-Nix, this is perfectly acceptable. In the Nix world it

     

       
25
       
-
       
      is not. To support this we have created two versions of rebar3,

     

       
26
       
-
       
      <literal>rebar3</literal> and <literal>rebar3-open</literal>. The

     

       
27
       
-
       
      <literal>rebar3</literal> version has been patched to remove the

     

       
28
       
-
       
      ability to download anything from it. If you are not running it a

     

       
29
       
-
       
      nix-shell or a nix-build then its probably not going to work for

     

       
30
       
-
       
      you. <literal>rebar3-open</literal> is the normal, un-modified

     

       
31
       
-
       
      rebar3. It should work exactly as would any other version of

     

       
32
       
-
       
      rebar3. Any Erlang package should rely on

     

       
33
       
-
       
      <literal>rebar3</literal> and thats really what you should be

     

       
34
       
-
       
      using too.

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
35
       
 
       
    </para>

     

       
36
       
 
       
  </section>

     

       
37
       
 
       
  <section xml:id="build-tools-other">

     

       
38
       
 
       
    <title>Mix &amp; Erlang.mk</title>

     

       
39
       
 
       
    <para>

     

       
40
       
-
       
      Both Mix and Erlang.mk work exactly as you would expect. There

     

       
41
       
-
       
      is a bootstrap process that needs to be run for both of

     

       
42
       
-
       
      them. However, that is supported by the

     

       
43
       
-
       
      <literal>buildMix</literal> and <literal>buildErlangMk</literal> derivations.

     

       
44
       
 
       
    </para>

     

       
45
       
 
       
  </section>

     

       
46
       
-
       


     

       
47
       
 
       
</section>

     

       
48
       
 
       


     

       
49
       
 
       
<section xml:id="how-to-install-beam-packages">

     

       
50
       
-
       
  <title>How to install Beam packages</title>

     

       
51
       
 
       
  <para>

     

       
52
       
-
       
    Beam packages are not registered in the top level simply because

     

       
53
       
-
       
    they are not relevant to the vast majority of Nix users. They are

     

       
54
       
-
       
    installable using the <literal>beamPackages</literal> attribute

     

       
55
       
-
       
    set.

     

       
0
       
 
       

     

       
0
       
 
       

     

       
56
       
 
       


     

       
57
       
-
       
    You can list the avialable packages in the

     

       
58
       
-
       
    <literal>beamPackages</literal> with the following command:

     

       
59
       
 
       
  </para>

     

       
60
       
 
       


     

       
61
       
 
       
  <programlisting>

     
···

       
69
       
 
       
beamPackages.rebar3-pc  pc-1.1.0

     

       
70
       
 
       
  </programlisting>

     

       
71
       
 
       
  <para>

     

       
72
       
-
       
    To install any of those packages into your profile, refer to them by

     

       
73
       
-
       
    their attribute path (first column):

     

       
74
       
 
       
  </para>

     

       
75
       
 
       
  <programlisting>

     

       
76
       
 
       
$ nix-env -f &quot;&lt;nixpkgs&gt;&quot; -iA beamPackages.ibrowse

     

       
77
       
 
       
  </programlisting>

     

       
78
       
 
       
  <para>

     

       
79
       
-
       
    The attribute path of any Beam packages corresponds to the name

     

       
80
       
-
       
    of that particular package in Hex or its OTP Application/Release name.

     

       
0
       
 
       

     

       
81
       
 
       
  </para>

     

       
82
       
 
       
</section>

     

       
83
       
 
       
<section xml:id="packaging-beam-applications">

     

       
84
       
-
       
  <title>Packaging Beam Applications</title>

     

       
85
       
 
       
  <section  xml:id="packaging-erlang-applications">

     

       
86
       
 
       
    <title>Erlang Applications</title>

     

       
87
       
 
       
    <section xml:id="rebar3-packages">

     

       
88
       
 
       
      <title>Rebar3 Packages</title>

     

       
89
       
 
       
      <para>

     

       
90
       
-
       
        There is a Nix functional called

     

       
91
       
-
       
        <literal>buildRebar3</literal>. We use this function to make a

     

       
92
       
-
       
        derivation that understands how to build the rebar3 project. For

     

       
93
       
-
       
        example, the epression we use to build the <link

     

       
94
       
-
       
        xlink:href="https://github.com/erlang-nix/hex2nix">hex2nix</link>

     

       
95
       
-
       
        project follows.

     

       
96
       
 
       
      </para>

     

       
97
       
 
       
      <programlisting>

     

       
98
       
-
       
        {stdenv, fetchFromGitHub, buildRebar3, ibrowse, jsx, erlware_commons }:

     

       
99
       
 
       


     

       
100
       
-
       
          buildRebar3 rec {

     

       
101
       
-
       
            name = "hex2nix";

     

       
102
       
-
       
            version = "0.0.1";

     

       
103
       
 
       


     

       
104
       
-
       
            src = fetchFromGitHub {

     

       
105
       
-
       
              owner = "ericbmerritt";

     

       
106
       
-
       
              repo = "hex2nix";

     

       
107
       
-
       
              rev = "${version}";

     

       
108
       
-
       
              sha256 = "1w7xjidz1l5yjmhlplfx7kphmnpvqm67w99hd2m7kdixwdxq0zqg";

     

       
109
       
-
       
            };

     

       
110
       
 
       


     

       
111
       
 
       
          beamDeps = [ ibrowse jsx erlware_commons ];

     

       
112
       
 
       
        }

     

       
113
       
 
       
      </programlisting>

     

       
114
       
 
       
      <para>

     

       
115
       
-
       
        The only visible difference between this derivation and

     

       
116
       
-
       
        something like <literal>stdenv.mkDerivation</literal> is that we

     

       
117
       
-
       
        have added <literal>erlangDeps</literal> to the derivation. If

     

       
118
       
-
       
        you add your Beam dependencies here they will be correctly

     

       
119
       
-
       
        handled by the system.

     

       
0
       
 
       

     

       
120
       
 
       
      </para>

     

       
121
       
 
       
      <para>

     

       
122
       
-
       
        If your package needs to compile native code via Rebar's port

     

       
123
       
-
       
        compilation mechenism. You should add <literal>compilePort =

     

       
124
       
-
       
        true;</literal> to the derivation.

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
125
       
 
       
      </para>

     

       
126
       
 
       
    </section>

     

       
127
       
 
       
    <section xml:id="erlang-mk-packages">

     

       
128
       
 
       
      <title>Erlang.mk Packages</title>

     

       
129
       
 
       
      <para>

     

       
130
       
-
       
        Erlang.mk functions almost identically to Rebar. The only real

     

       
131
       
-
       
        difference is that <literal>buildErlangMk</literal> is called

     

       
132
       
-
       
        instead of <literal>buildRebar3</literal>

     

       
133
       
 
       
      </para>

     

       
134
       
 
       
      <programlisting>

     

       
135
       
-
       
        { buildErlangMk, fetchHex,  cowlib, ranch }:

     

       
136
       
-
       
          buildErlangMk {

     

       
137
       
-
       
            name = "cowboy";

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
138
       
 
       
            version = "1.0.4";

     

       
139
       
-
       
            src = fetchHex {

     

       
140
       
-
       
              pkg = "cowboy";

     

       
141
       
-
       
              version = "1.0.4";

     

       
142
       
-
       
              sha256 =

     

       
143
       
-
       
                "6a0edee96885fae3a8dd0ac1f333538a42e807db638a9453064ccfdaa6b9fdac";

     

       
144
       
-
       
            };

     

       
145
       
-
       
            beamDeps  = [ cowlib ranch ];

     

       
146
       
 
       


     

       
147
       
-
       
            meta = {

     

       
148
       
-
       
              description = ''Small, fast, modular HTTP server written in

     

       
149
       
-
       
                            Erlang.'';

     

       
150
       
-
       
              license = stdenv.lib.licenses.isc;

     

       
151
       
-
       
              homepage = "https://github.com/ninenines/cowboy";

     

       
152
       
-
       
            };

     

       
0
       
 
       

     

       
153
       
 
       
        }

     

       
154
       
 
       
      </programlisting>

     

       
155
       
 
       
    </section>

     

       
156
       
 
       
    <section xml:id="mix-packages">

     

       
157
       
 
       
      <title>Mix Packages</title>

     

       
158
       
 
       
      <para>

     

       
159
       
-
       
        Mix functions almost identically to Rebar. The only real

     

       
160
       
-
       
        difference is that <literal>buildMix</literal> is called

     

       
161
       
-
       
        instead of <literal>buildRebar3</literal>

     

       
162
       
 
       
      </para>

     

       
163
       
 
       
      <programlisting>

     

       
164
       
 
       
        { buildMix, fetchHex, plug, absinthe }:

     

       
0
       
 
       

     

       
165
       
 
       
        buildMix {

     

       
166
       
 
       
          name = "absinthe_plug";

     

       
167
       
 
       
          version = "1.0.0";

     

       
0
       
 
       

     

       
168
       
 
       
          src = fetchHex {

     

       
169
       
 
       
            pkg = "absinthe_plug";

     

       
170
       
 
       
            version = "1.0.0";

     

       
171
       
-
       
            sha256 =

     

       
172
       
-
       
              "08459823fe1fd4f0325a8bf0c937a4520583a5a26d73b193040ab30a1dfc0b33";

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
173
       
 
       
          };

     

       
174
       
-
       
          beamDeps  = [ plug absinthe];

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
175
       
 
       


     

       
176
       
 
       
          meta = {

     

       
177
       
-
       
            description = ''A plug for Absinthe, an experimental GraphQL

     

       
178
       
-
       
                            toolkit'';

     

       
0
       
 
       

     

       
179
       
 
       
            license = stdenv.lib.licenses.bsd3;

     

       
180
       
-
       
            homepage = "https://github.com/CargoSense/absinthe_plug";

     

       
181
       
 
       
         };

     

       
182
       
 
       
       }

     

       
183
       
 
       
      </programlisting>

     
···

       
185
       
 
       
  </section>

     

       
186
       
 
       
</section>

     

       
187
       
 
       
<section xml:id="how-to-develop">

     

       
188
       
-
       
  <title>How to develop</title>

     

       
189
       
 
       
  <section xml:id="accessing-an-environment">

     

       
190
       
 
       
    <title>Accessing an Environment</title>

     

       
191
       
 
       
    <para>

     

       
192
       
-
       
      Often, all you want to do is be able to access a valid

     

       
193
       
-
       
      environment that contains a specific package and its

     

       
194
       
-
       
      dependencies. we can do that with the <literal>env</literal>

     

       
195
       
-
       
      part of a derivation. For example, lets say we want to access an

     

       
196
       
-
       
      erlang repl with ibrowse loaded up. We could do the following.

     

       
197
       
 
       
    </para>

     

       
198
       
 
       
    <programlisting>

     

       
199
       
-
       
      ~/w/nixpkgs ❯❯❯ nix-shell -A beamPackages.ibrowse.env --run "erl"

     

       
200
       
 
       
      Erlang/OTP 18 [erts-7.0] [source] [64-bit] [smp:4:4] [async-threads:10] [hipe] [kernel-poll:false]

     

       
201
       
 
       


     

       
202
       
 
       
      Eshell V7.0  (abort with ^G)

     
···

       
237
       
 
       
      2>

     

       
238
       
 
       
    </programlisting>

     

       
239
       
 
       
    <para>

     

       
240
       
-
       
      Notice the <literal>-A beamPackages.ibrowse.env</literal>.That

     

       
241
       
-
       
      is the key to this functionality.

     

       
242
       
 
       
    </para>

     

       
243
       
 
       
  </section>

     

       
244
       
 
       
  <section xml:id="creating-a-shell">

     

       
245
       
 
       
    <title>Creating a Shell</title>

     

       
246
       
 
       
    <para>

     

       
247
       
 
       
      Getting access to an environment often isn't enough to do real

     

       
248
       
-
       
      development. Many times we need to create a

     

       
249
       
-
       
      <literal>shell.nix</literal> file and do our development inside

     

       
250
       
-
       
      of the environment specified by that file. This file looks a lot

     

       
251
       
-
       
      like the packaging described above. The main difference is that

     

       
252
       
-
       
      <literal>src</literal> points to project root and we call the

     

       
253
       
-
       
      package directly.

     

       
254
       
 
       
    </para>

     

       
255
       
 
       
    <programlisting>

     

       
256
       
 
       
{ pkgs ? import &quot;&lt;nixpkgs&quot;&gt; {} }:

     
···

       
264
       
 
       
        name = "hex2nix";

     

       
265
       
 
       
        version = "0.1.0";

     

       
266
       
 
       
        src = ./.;

     

       
267
       
-
       
        erlangDeps = [ ibrowse jsx erlware_commons ];

     

       
268
       
 
       
      };

     

       
269
       
 
       
  drv = beamPackages.callPackage f {};

     

       
270
       
 
       


     

       
271
       
 
       
in

     

       
272
       
-
       
 drv

     

       
0
       
 
       

     

       
273
       
 
       
    </programlisting>

     

       
274
       
 
       
    <section xml:id="building-in-a-shell">

     

       
275
       
-
       
    <title>Building in a shell</title>

     

       
276
       
 
       
    <para>

     

       
277
       
-
       
      We can leveral the support of the Derivation, regardless of

     

       
278
       
-
       
      which build Derivation is called by calling the commands themselv.s

     

       
279
       
 
       
    </para>

     

       
280
       
 
       
    <programlisting>

     

       
281
       
 
       
# =============================================================================

     
···

       
335
       
 
       


     

       
336
       
 
       
    </programlisting>

     

       
337
       
 
       
    <para>

     

       
338
       
-
       
      If you add the <literal>shell.nix</literal> as described and

     

       
339
       
-
       
      user rebar as follows things should simply work. Aside from the

     

       
340
       
 
       
      <literal>test</literal>, <literal>plt</literal>, and

     

       
341
       
-
       
      <literal>analyze</literal> the talks work just fine for all of

     

       
342
       
-
       
      the build Derivations.

     

       
343
       
 
       
    </para>

     

       
344
       
 
       
  </section>

     

       
345
       
 
       
</section>

     

       
346
       
 
       
</section>

     

       
347
       
 
       
<section xml:id="generating-packages-from-hex-with-hex2nix">

     

       
348
       
-
       
  <title>Generating Packages from Hex with Hex2Nix</title>

     

       
349
       
 
       
  <para>

     

       
350
       
-
       
    Updating the Hex packages requires the use of the

     

       
351
       
-
       
    <literal>hex2nix</literal> tool. Given the path to the Erlang

     

       
352
       
-
       
    modules (usually

     

       
353
       
-
       
    <literal>pkgs/development/erlang-modules</literal>). It will

     

       
354
       
-
       
    happily dump a file called

     

       
355
       
-
       
    <literal>hex-packages.nix</literal>. That file will contain all

     

       
356
       
-
       
    the packages that use a recognized build system in Hex. However,

     

       
357
       
-
       
    it can't know whether or not all those packages are buildable.

     

       
0
       
 
       

     

       
358
       
 
       
    </para>

     

       
359
       
 
       
    <para>

     

       
360
       
-
       
      To make life easier for our users, it makes good sense to go

     

       
361
       
-
       
      ahead and attempt to build all those packages and remove the

     

       
362
       
-
       
      ones that don't build. To do that, simply run the command (in

     

       
363
       
-
       
      the root of your <literal>nixpkgs</literal> repository). that follows.

     

       
364
       
 
       
    </para>

     

       
365
       
 
       
    <programlisting>

     

       
366
       
 
       
$ nix-build -A beamPackages

     

       
367
       
 
       
    </programlisting>

     

       
368
       
 
       
    <para>

     

       
369
       
-
       
      That will build every package in

     

       
370
       
-
       
      <literal>beamPackages</literal>. Then you can go through and

     

       
371
       
-
       
      manually remove the ones that fail. Hopefully, someone will

     

       
372
       
-
       
      improve <literal>hex2nix</literal> in the future to automate

     

       
373
       
-
       
      that.

     

       
374
       
 
       
    </para>

     

       
375
       
 
       
</section>

     

       
376
       
 
       
</section>

     

···

       
2
       
 
       
         xmlns:xlink="http://www.w3.org/1999/xlink"

     

       
3
       
 
       
         xml:id="sec-beam">

     

       
4
       
 
       


     

       
5
       
+
       
  <title>BEAM Languages (Erlang, Elixir &amp; LFE)</title>

     

       
6
       
 
       
  <section xml:id="beam-introduction">

     

       
7
       
 
       
    <title>Introduction</title>

     

       
8
       
 
       
    <para>

     

       
9
       
+
       
      In this document and related Nix expressions, we use the term,

     

       
10
       
+
       
      <emphasis>BEAM</emphasis>, to describe the environment. BEAM is the name

     

       
11
       
+
       
      of the Erlang Virtual Machine and, as far as we're concerned, from a

     

       
12
       
+
       
      packaging perspective, all languages that run on the BEAM are

     

       
13
       
+
       
      interchangeable. That which varies, like the build system, is transparent

     

       
14
       
+
       
      to users of any given BEAM package, so we make no distinction.

     

       
15
       
+
       
    </para>

     

       
16
       
+
       
  </section>

     

       
17
       
+
       
  <section xml:id="beam-structure">

     

       
18
       
+
       
    <title>Structure</title>

     

       
19
       
+
       
    <para>

     

       
20
       
+
       
      All BEAM-related expressions are available via the top-level

     

       
21
       
+
       
      <literal>beam</literal> attribute, which includes:

     

       
22
       
+
       
    </para>

     

       
23
       
+
       
    <itemizedlist>

     

       
24
       
+
       
      <listitem>

     

       
25
       
+
       
        <para>

     

       
26
       
+
       
          <literal>interpreters</literal>: a set of compilers running on the

     

       
27
       
+
       
          BEAM, including multiple Erlang/OTP versions

     

       
28
       
+
       
          (<literal>beam.interpreters.erlangR19</literal>, etc), Elixir

     

       
29
       
+
       
          (<literal>beam.interpreters.elixir</literal>) and LFE

     

       
30
       
+
       
          (<literal>beam.interpreters.lfe</literal>).

     

       
31
       
+
       
        </para>

     

       
32
       
+
       
      </listitem>

     

       
33
       
+
       
      <listitem>

     

       
34
       
+
       
        <para>

     

       
35
       
+
       
          <literal>packages</literal>: a set of package sets, each compiled with

     

       
36
       
+
       
          a specific Erlang/OTP version, e.g.

     

       
37
       
+
       
          <literal>beam.packages.erlangR19</literal>.

     

       
38
       
+
       
        </para>

     

       
39
       
+
       
      </listitem>

     

       
40
       
+
       
    </itemizedlist>

     

       
41
       
+
       
    <para>

     

       
42
       
+
       
      The default Erlang compiler, defined by

     

       
43
       
+
       
      <literal>beam.interpreters.erlang</literal>, is aliased as

     

       
44
       
+
       
      <literal>erlang</literal>. The default BEAM package set is defined by

     

       
45
       
+
       
      <literal>beam.packages.erlang</literal> and aliased at the top level as

     

       
46
       
+
       
      <literal>beamPackages</literal>.

     

       
47
       
+
       
    </para>

     

       
48
       
+
       
    <para>

     

       
49
       
+
       
      To create a package set built with a custom Erlang version, use the

     

       
50
       
+
       
      lambda, <literal>beam.packagesWith</literal>, which accepts an Erlang/OTP

     

       
51
       
+
       
      derivation and produces a package set similar to

     

       
52
       
+
       
      <literal>beam.packages.erlang</literal>.

     

       
53
       
+
       
    </para>

     

       
54
       
+
       
    <para>

     

       
55
       
+
       
      Many Erlang/OTP distributions available in

     

       
56
       
+
       
      <literal>beam.interpreters</literal> have versions with ODBC and/or Java

     

       
57
       
+
       
      enabled. For example, there's

     

       
58
       
+
       
      <literal>beam.interpreters.erlangR19_odbc_javac</literal>, which

     

       
59
       
+
       
      corresponds to <literal>beam.interpreters.erlangR19</literal>.

     

       
60
       
+
       
    </para>

     

       
61
       
+
       
    <para xml:id="erlang-call-package">

     

       
62
       
+
       
      We also provide the lambda,

     

       
63
       
+
       
      <literal>beam.packages.erlang.callPackage</literal>, which simplifies

     

       
64
       
+
       
      writing BEAM package definitions by injecting all packages from

     

       
65
       
+
       
      <literal>beam.packages.erlang</literal> into the top-level context.

     

       
66
       
 
       
    </para>

     

       
67
       
 
       
  </section>

     

       
68
       
+
       
  <section xml:id="build-tools">

     

       
69
       
 
       
  <title>Build Tools</title>

     

       
70
       
 
       
  <section xml:id="build-tools-rebar3">

     

       
71
       
 
       
    <title>Rebar3</title>

     

       
72
       
 
       
    <para>

     

       
73
       
+
       
      By default, Rebar3 wants to manage its own dependencies. This is perfectly

     

       
74
       
+
       
      acceptable in the normal, non-Nix setup, but in the Nix world, it is not.

     

       
75
       
+
       
      To rectify this, we provide two versions of Rebar3:

     

       
76
       
+
       
      <itemizedlist>

     

       
77
       
+
       
        <listitem>

     

       
78
       
+
       
          <para>

     

       
79
       
+
       
            <literal>rebar3</literal>: patched to remove the ability to download

     

       
80
       
+
       
            anything. When not running it via <literal>nix-shell</literal> or

     

       
81
       
+
       
            <literal>nix-build</literal>, it's probably not going to work as

     

       
82
       
+
       
            desired.

     

       
83
       
+
       
          </para>

     

       
84
       
+
       
        </listitem>

     

       
85
       
+
       
        <listitem>

     

       
86
       
+
       
          <para>

     

       
87
       
+
       
            <literal>rebar3-open</literal>: the normal, unmodified Rebar3. It

     

       
88
       
+
       
            should work exactly as would any other version of Rebar3. Any Erlang

     

       
89
       
+
       
            package should rely on <literal>rebar3</literal> instead. See <xref

     

       
90
       
+
       
            linkend="rebar3-packages"/>.

     

       
91
       
+
       
          </para>

     

       
92
       
+
       
        </listitem>

     

       
93
       
+
       
      </itemizedlist>

     

       
94
       
 
       
    </para>

     

       
95
       
 
       
  </section>

     

       
96
       
 
       
  <section xml:id="build-tools-other">

     

       
97
       
 
       
    <title>Mix &amp; Erlang.mk</title>

     

       
98
       
 
       
    <para>

     

       
99
       
+
       
      Both Mix and Erlang.mk work exactly as expected. There is a bootstrap

     

       
100
       
+
       
      process that needs to be run for both, however, which is supported by the

     

       
101
       
+
       
      <literal>buildMix</literal> and <literal>buildErlangMk</literal>

     

       
102
       
+
       
      derivations, respectively.

     

       
103
       
 
       
    </para>

     

       
104
       
 
       
  </section>

     

       
0
       
 
       

     

       
105
       
 
       
</section>

     

       
106
       
 
       


     

       
107
       
 
       
<section xml:id="how-to-install-beam-packages">

     

       
108
       
+
       
  <title>How to Install BEAM Packages</title>

     

       
109
       
 
       
  <para>

     

       
110
       
+
       
    BEAM packages are not registered at the top level, simply because they are

     

       
111
       
+
       
    not relevant to the vast majority of Nix users. They are installable using

     

       
112
       
+
       
    the <literal>beam.packages.erlang</literal> attribute set (aliased as

     

       
113
       
+
       
    <literal>beamPackages</literal>), which points to packages built by the

     

       
114
       
+
       
    default Erlang/OTP version in Nixpkgs, as defined by

     

       
115
       
+
       
    <literal>beam.interpreters.erlang</literal>.

     

       
116
       
 
       


     

       
117
       
+
       
    To list the available packages in

     

       
118
       
+
       
    <literal>beamPackages</literal>, use the following command:

     

       
119
       
 
       
  </para>

     

       
120
       
 
       


     

       
121
       
 
       
  <programlisting>

     
···

       
129
       
 
       
beamPackages.rebar3-pc  pc-1.1.0

     

       
130
       
 
       
  </programlisting>

     

       
131
       
 
       
  <para>

     

       
132
       
+
       
    To install any of those packages into your profile, refer to them by their

     

       
133
       
+
       
    attribute path (first column):

     

       
134
       
 
       
  </para>

     

       
135
       
 
       
  <programlisting>

     

       
136
       
 
       
$ nix-env -f &quot;&lt;nixpkgs&gt;&quot; -iA beamPackages.ibrowse

     

       
137
       
 
       
  </programlisting>

     

       
138
       
 
       
  <para>

     

       
139
       
+
       
    The attribute path of any BEAM package corresponds to the name of that

     

       
140
       
+
       
    particular package in <link xlink:href="https://hex.pm">Hex</link> or its

     

       
141
       
+
       
    OTP Application/Release name.

     

       
142
       
 
       
  </para>

     

       
143
       
 
       
</section>

     

       
144
       
 
       
<section xml:id="packaging-beam-applications">

     

       
145
       
+
       
  <title>Packaging BEAM Applications</title>

     

       
146
       
 
       
  <section  xml:id="packaging-erlang-applications">

     

       
147
       
 
       
    <title>Erlang Applications</title>

     

       
148
       
 
       
    <section xml:id="rebar3-packages">

     

       
149
       
 
       
      <title>Rebar3 Packages</title>

     

       
150
       
 
       
      <para>

     

       
151
       
+
       
        The Nix function, <literal>buildRebar3</literal>, defined in

     

       
152
       
+
       
        <literal>beam.packages.erlang.buildRebar3</literal> and aliased at the

     

       
153
       
+
       
        top level, can be used to build a derivation that understands how to

     

       
154
       
+
       
        build a Rebar3 project. For example, we can build <link

     

       
155
       
+
       
        xlink:href="https://github.com/erlang-nix/hex2nix">hex2nix</link> as

     

       
156
       
+
       
        follows:

     

       
157
       
 
       
      </para>

     

       
158
       
 
       
      <programlisting>

     

       
159
       
+
       
        { stdenv, fetchFromGitHub, buildRebar3, ibrowse, jsx, erlware_commons }:

     

       
160
       
 
       


     

       
161
       
+
       
        buildRebar3 rec {

     

       
162
       
+
       
          name = "hex2nix";

     

       
163
       
+
       
          version = "0.0.1";

     

       
164
       
 
       


     

       
165
       
+
       
          src = fetchFromGitHub {

     

       
166
       
+
       
            owner = "ericbmerritt";

     

       
167
       
+
       
            repo = "hex2nix";

     

       
168
       
+
       
            rev = "${version}";

     

       
169
       
+
       
            sha256 = "1w7xjidz1l5yjmhlplfx7kphmnpvqm67w99hd2m7kdixwdxq0zqg";

     

       
170
       
+
       
          };

     

       
171
       
 
       


     

       
172
       
 
       
          beamDeps = [ ibrowse jsx erlware_commons ];

     

       
173
       
 
       
        }

     

       
174
       
 
       
      </programlisting>

     

       
175
       
 
       
      <para>

     

       
176
       
+
       
        Such derivations are callable with

     

       
177
       
+
       
        <literal>beam.packages.erlang.callPackage</literal> (see <xref

     

       
178
       
+
       
        linkend="erlang-call-package"/>). To call this package using the normal

     

       
179
       
+
       
        <literal>callPackage</literal>, refer to dependency packages via

     

       
180
       
+
       
        <literal>beamPackages</literal>, e.g.

     

       
181
       
+
       
        <literal>beamPackages.ibrowse</literal>.

     

       
182
       
 
       
      </para>

     

       
183
       
 
       
      <para>

     

       
184
       
+
       
        Notably, <literal>buildRebar3</literal> includes

     

       
185
       
+
       
        <literal>beamDeps</literal>, while

     

       
186
       
+
       
        <literal>stdenv.mkDerivation</literal> does not. BEAM dependencies added

     

       
187
       
+
       
        there will be correctly handled by the system.

     

       
188
       
+
       
      </para>

     

       
189
       
+
       
      <para>

     

       
190
       
+
       
        If a package needs to compile native code via Rebar3's port compilation

     

       
191
       
+
       
        mechanism, add <literal>compilePort = true;</literal> to the derivation.

     

       
192
       
 
       
      </para>

     

       
193
       
 
       
    </section>

     

       
194
       
 
       
    <section xml:id="erlang-mk-packages">

     

       
195
       
 
       
      <title>Erlang.mk Packages</title>

     

       
196
       
 
       
      <para>

     

       
197
       
+
       
        Erlang.mk functions similarly to Rebar3, except we use

     

       
198
       
+
       
        <literal>buildErlangMk</literal> instead of

     

       
199
       
+
       
        <literal>buildRebar3</literal>.

     

       
200
       
 
       
      </para>

     

       
201
       
 
       
      <programlisting>

     

       
202
       
+
       
        { buildErlangMk, fetchHex, cowlib, ranch }:

     

       
203
       
+
       


     

       
204
       
+
       
        buildErlangMk {

     

       
205
       
+
       
          name = "cowboy";

     

       
206
       
+
       
          version = "1.0.4";

     

       
207
       
+
       


     

       
208
       
+
       
          src = fetchHex {

     

       
209
       
+
       
            pkg = "cowboy";

     

       
210
       
 
       
            version = "1.0.4";

     

       
211
       
+
       
            sha256 = "6a0edee96885fae3a8dd0ac1f333538a42e807db638a9453064ccfdaa6b9fdac";

     

       
212
       
+
       
          };

     

       
213
       
+
       


     

       
214
       
+
       
          beamDeps = [ cowlib ranch ];

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
215
       
 
       


     

       
216
       
+
       
          meta = {

     

       
217
       
+
       
            description = ''

     

       
218
       
+
       
              Small, fast, modular HTTP server written in Erlang

     

       
219
       
+
       
            '';

     

       
220
       
+
       
            license = stdenv.lib.licenses.isc;

     

       
221
       
+
       
            homepage = https://github.com/ninenines/cowboy;

     

       
222
       
+
       
          };

     

       
223
       
 
       
        }

     

       
224
       
 
       
      </programlisting>

     

       
225
       
 
       
    </section>

     

       
226
       
 
       
    <section xml:id="mix-packages">

     

       
227
       
 
       
      <title>Mix Packages</title>

     

       
228
       
 
       
      <para>

     

       
229
       
+
       
        Mix functions similarly to Rebar3, except we use

     

       
230
       
+
       
        <literal>buildMix</literal> instead of <literal>buildRebar3</literal>.

     

       
0
       
 
       

     

       
231
       
 
       
      </para>

     

       
232
       
 
       
      <programlisting>

     

       
233
       
 
       
        { buildMix, fetchHex, plug, absinthe }:

     

       
234
       
+
       


     

       
235
       
 
       
        buildMix {

     

       
236
       
 
       
          name = "absinthe_plug";

     

       
237
       
 
       
          version = "1.0.0";

     

       
238
       
+
       


     

       
239
       
 
       
          src = fetchHex {

     

       
240
       
 
       
            pkg = "absinthe_plug";

     

       
241
       
 
       
            version = "1.0.0";

     

       
242
       
+
       
            sha256 = "08459823fe1fd4f0325a8bf0c937a4520583a5a26d73b193040ab30a1dfc0b33";

     

       
243
       
+
       
          };

     

       
244
       
+
       


     

       
245
       
+
       
          beamDeps = [ plug absinthe ];

     

       
246
       
+
       


     

       
247
       
+
       
          meta = {

     

       
248
       
+
       
            description = ''

     

       
249
       
+
       
              A plug for Absinthe, an experimental GraphQL toolkit

     

       
250
       
+
       
            '';

     

       
251
       
+
       
            license = stdenv.lib.licenses.bsd3;

     

       
252
       
+
       
            homepage = https://github.com/CargoSense/absinthe_plug;

     

       
253
       
 
       
          };

     

       
254
       
+
       
        }

     

       
255
       
+
       
      </programlisting>

     

       
256
       
+
       
      <para>

     

       
257
       
+
       
        Alternatively, we can use <literal>buildHex</literal> as a shortcut:

     

       
258
       
+
       
      </para>

     

       
259
       
+
       
      <programlisting>

     

       
260
       
+
       
        { buildHex, buildMix, plug, absinthe }:

     

       
261
       
+
       


     

       
262
       
+
       
        buildHex {

     

       
263
       
+
       
          name = "absinthe_plug";

     

       
264
       
+
       
          version = "1.0.0";

     

       
265
       
+
       


     

       
266
       
+
       
          sha256 = "08459823fe1fd4f0325a8bf0c937a4520583a5a26d73b193040ab30a1dfc0b33";

     

       
267
       
+
       


     

       
268
       
+
       
          builder = buildMix;

     

       
269
       
+
       


     

       
270
       
+
       
          beamDeps = [ plug absinthe ];

     

       
271
       
 
       


     

       
272
       
 
       
          meta = {

     

       
273
       
+
       
            description = ''

     

       
274
       
+
       
              A plug for Absinthe, an experimental GraphQL toolkit

     

       
275
       
+
       
            '';

     

       
276
       
 
       
            license = stdenv.lib.licenses.bsd3;

     

       
277
       
+
       
            homepage = https://github.com/CargoSense/absinthe_plug;

     

       
278
       
 
       
         };

     

       
279
       
 
       
       }

     

       
280
       
 
       
      </programlisting>

     
···

       
282
       
 
       
  </section>

     

       
283
       
 
       
</section>

     

       
284
       
 
       
<section xml:id="how-to-develop">

     

       
285
       
+
       
  <title>How to Develop</title>

     

       
286
       
 
       
  <section xml:id="accessing-an-environment">

     

       
287
       
 
       
    <title>Accessing an Environment</title>

     

       
288
       
 
       
    <para>

     

       
289
       
+
       
      Often, we simply want to access a valid environment that contains a

     

       
290
       
+
       
      specific package and its dependencies. We can accomplish that with the

     

       
291
       
+
       
      <literal>env</literal> attribute of a derivation. For example, let's say

     

       
292
       
+
       
      we want to access an Erlang REPL with <literal>ibrowse</literal> loaded

     

       
293
       
+
       
      up. We could do the following:

     

       
294
       
 
       
    </para>

     

       
295
       
 
       
    <programlisting>

     

       
296
       
+
       
      $ nix-shell -A beamPackages.ibrowse.env --run "erl"

     

       
297
       
 
       
      Erlang/OTP 18 [erts-7.0] [source] [64-bit] [smp:4:4] [async-threads:10] [hipe] [kernel-poll:false]

     

       
298
       
 
       


     

       
299
       
 
       
      Eshell V7.0  (abort with ^G)

     
···

       
334
       
 
       
      2>

     

       
335
       
 
       
    </programlisting>

     

       
336
       
 
       
    <para>

     

       
337
       
+
       
      Notice the <literal>-A beamPackages.ibrowse.env</literal>. That is the key

     

       
338
       
+
       
      to this functionality.

     

       
339
       
 
       
    </para>

     

       
340
       
 
       
  </section>

     

       
341
       
 
       
  <section xml:id="creating-a-shell">

     

       
342
       
 
       
    <title>Creating a Shell</title>

     

       
343
       
 
       
    <para>

     

       
344
       
 
       
      Getting access to an environment often isn't enough to do real

     

       
345
       
+
       
      development. Usually, we need to create a <literal>shell.nix</literal>

     

       
346
       
+
       
      file and do our development inside of the environment specified therein.

     

       
347
       
+
       
      This file looks a lot like the packaging described above, except that

     

       
348
       
+
       
      <literal>src</literal> points to the project root and we call the package

     

       
349
       
+
       
      directly.

     

       
0
       
 
       

     

       
350
       
 
       
    </para>

     

       
351
       
 
       
    <programlisting>

     

       
352
       
 
       
{ pkgs ? import &quot;&lt;nixpkgs&quot;&gt; {} }:

     
···

       
360
       
 
       
        name = "hex2nix";

     

       
361
       
 
       
        version = "0.1.0";

     

       
362
       
 
       
        src = ./.;

     

       
363
       
+
       
        beamDeps = [ ibrowse jsx erlware_commons ];

     

       
364
       
 
       
      };

     

       
365
       
 
       
  drv = beamPackages.callPackage f {};

     

       
366
       
 
       


     

       
367
       
 
       
in

     

       
368
       
+
       


     

       
369
       
+
       
  drv

     

       
370
       
 
       
    </programlisting>

     

       
371
       
 
       
    <section xml:id="building-in-a-shell">

     

       
372
       
+
       
    <title>Building in a Shell (for Mix Projects)</title>

     

       
373
       
 
       
    <para>

     

       
374
       
+
       
      We can leverage the support of the derivation, irrespective of the build

     

       
375
       
+
       
      derivation, by calling the commands themselves.

     

       
376
       
 
       
    </para>

     

       
377
       
 
       
    <programlisting>

     

       
378
       
 
       
# =============================================================================

     
···

       
432
       
 
       


     

       
433
       
 
       
    </programlisting>

     

       
434
       
 
       
    <para>

     

       
435
       
+
       
      Using a <literal>shell.nix</literal> as described (see <xref

     

       
436
       
+
       
      linkend="creating-a-shell"/>) should just work. Aside from

     

       
437
       
 
       
      <literal>test</literal>, <literal>plt</literal>, and

     

       
438
       
+
       
      <literal>analyze</literal>, the Make targets work just fine for all of the

     

       
439
       
+
       
      build derivations.

     

       
440
       
 
       
    </para>

     

       
441
       
 
       
  </section>

     

       
442
       
 
       
</section>

     

       
443
       
 
       
</section>

     

       
444
       
 
       
<section xml:id="generating-packages-from-hex-with-hex2nix">

     

       
445
       
+
       
  <title>Generating Packages from Hex with <literal>hex2nix</literal></title>

     

       
446
       
 
       
  <para>

     

       
447
       
+
       
    Updating the <link xlink:href="https://hex.pm">Hex</link> package set

     

       
448
       
+
       
    requires <link

     

       
449
       
+
       
    xlink:href="https://github.com/erlang-nix/hex2nix">hex2nix</link>. Given the

     

       
450
       
+
       
    path to the Erlang modules (usually

     

       
451
       
+
       
    <literal>pkgs/development/erlang-modules</literal>), it will dump a file

     

       
452
       
+
       
    called <literal>hex-packages.nix</literal>, containing all the packages that

     

       
453
       
+
       
    use a recognized build system in <link

     

       
454
       
+
       
    xlink:href="https://hex.pm">Hex</link>. It can't be determined, however,

     

       
455
       
+
       
    whether every package is buildable.

     

       
456
       
 
       
    </para>

     

       
457
       
 
       
    <para>

     

       
458
       
+
       
      To make life easier for our users, try to build every <link

     

       
459
       
+
       
      xlink:href="https://hex.pm">Hex</link> package and remove those that fail.

     

       
460
       
+
       
      To do that, simply run the following command in the root of your

     

       
461
       
+
       
      <literal>nixpkgs</literal> repository:

     

       
462
       
 
       
    </para>

     

       
463
       
 
       
    <programlisting>

     

       
464
       
 
       
$ nix-build -A beamPackages

     

       
465
       
 
       
    </programlisting>

     

       
466
       
 
       
    <para>

     

       
467
       
+
       
      That will attempt to build every package in

     

       
468
       
+
       
      <literal>beamPackages</literal>. Then manually remove those that fail.

     

       
469
       
+
       
      Hopefully, someone will improve <link

     

       
470
       
+
       
      xlink:href="https://github.com/erlang-nix/hex2nix">hex2nix</link> in the

     

       
471
       
+
       
      future to automate the process.

     

       
472
       
 
       
    </para>

     

       
473
       
 
       
</section>

     

       
474
       
 
       
</section>

     

···

       
1
       
 
       
{ stdenv, buildRebar3, fetchHex }:

     

       
2
       
 
       


     

       
3
       
 
       
{ name, version, sha256

     

       
0
       
 
       

     

       
4
       
 
       
, hexPkg ? name

     

       
5
       
 
       
, ... }@attrs:

     

       
6
       
 
       


     

       
7
       
 
       
with stdenv.lib;

     

       
8
       
 
       


     

       
9
       
 
       
let

     

       
10
       
-
       
  pkg = self: buildRebar3 (attrs // {

     

       
11
       
 
       


     

       
12
       
 
       
    src = fetchHex {

     

       
13
       
 
       
      pkg = hexPkg;

     

···

       
1
       
 
       
{ stdenv, buildRebar3, fetchHex }:

     

       
2
       
 
       


     

       
3
       
 
       
{ name, version, sha256

     

       
4
       
+
       
, builder ? buildRebar3

     

       
5
       
 
       
, hexPkg ? name

     

       
6
       
 
       
, ... }@attrs:

     

       
7
       
 
       


     

       
8
       
 
       
with stdenv.lib;

     

       
9
       
 
       


     

       
10
       
 
       
let

     

       
11
       
+
       
  pkg = self: builder (attrs // {

     

       
12
       
 
       


     

       
13
       
 
       
    src = fetchHex {

     

       
14
       
 
       
      pkg = hexPkg;

     

···

       
1
       
-
       
{ stdenv, pkgs }:

     

       
2
       
 
       


     

       
3
       
 
       
let

     

       
4
       
-
       
  self = rec {

     

       
5
       
-
       
    hexPackages = import ./hex-packages.nix { stdenv = stdenv; callPackage = self.callPackage; pkgs = pkgs; };

     

       
6
       
-
       
    callPackage = pkgs.lib.callPackageWith (pkgs // self // hexPackages);

     

       
7
       
-
       
    buildRebar3 = callPackage ./build-rebar3.nix {};

     

       
8
       
-
       
    buildHex = callPackage ./build-hex.nix {};

     

       
9
       
-
       
    buildErlangMk = callPackage ./build-erlang-mk.nix {};

     

       
10
       
-
       
    buildMix = callPackage ./build-mix.nix {};

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
11
       
 
       


     

       
12
       
-
       
    ## Non hex packages

     

       
13
       
-
       
    hex = callPackage ./hex {};

     

       
14
       
-
       
    webdriver = callPackage ./webdriver {};

     

       
15
       
-
       
  };

     

       
16
       
-
       
in self // self.hexPackages

     

···

       
1
       
+
       
{ stdenv, pkgs, erlang, overrides ? (self: super: {}) }:

     

       
2
       
 
       


     

       
3
       
 
       
let

     

       
4
       
+
       
  inherit (stdenv.lib) fix' extends getVersion versionAtLeast;

     

       
5
       
+
       


     

       
6
       
+
       
  lib = pkgs.callPackage ./lib.nix {};

     

       
7
       
+
       


     

       
8
       
+
       
  # FIXME: add support for overrideScope

     

       
9
       
+
       
  callPackageWithScope = scope: drv: args: stdenv.lib.callPackageWith scope drv args;

     

       
10
       
+
       
  mkScope = scope: pkgs // scope;

     

       
11
       
+
       


     

       
12
       
+
       
  packages = self:

     

       
13
       
+
       
    let

     

       
14
       
+
       
      defaultScope = mkScope self;

     

       
15
       
+
       
      callPackage = drv: args: callPackageWithScope defaultScope drv args;

     

       
16
       
+
       
    in

     

       
17
       
+
       
      import ./hex-packages.nix {

     

       
18
       
+
       
        inherit pkgs stdenv callPackage;

     

       
19
       
+
       
      } // {

     

       
20
       
+
       
        inherit callPackage erlang;

     

       
21
       
+
       
        beamPackages = self;

     

       
22
       
+
       


     

       
23
       
+
       
        rebar = callPackage ../tools/build-managers/rebar { };

     

       
24
       
+
       
        rebar3-open = callPackage ../tools/build-managers/rebar3 {

     

       
25
       
+
       
          hermeticRebar3 = false;

     

       
26
       
+
       
        };

     

       
27
       
+
       
        rebar3 = callPackage ../tools/build-managers/rebar3 {

     

       
28
       
+
       
          hermeticRebar3 = true;

     

       
29
       
+
       
        };

     

       
30
       
+
       


     

       
31
       
+
       
        hexRegistrySnapshot = callPackage ./hex-registry-snapshot.nix { };

     

       
32
       
+
       
        fetchHex = callPackage ./fetch-hex.nix { };

     

       
33
       
+
       


     

       
34
       
+
       
        buildRebar3 = callPackage ./build-rebar3.nix {};

     

       
35
       
+
       
        buildHex = callPackage ./build-hex.nix {};

     

       
36
       
+
       
        buildErlangMk = callPackage ./build-erlang-mk.nix {};

     

       
37
       
+
       
        buildMix = callPackage ./build-mix.nix {};

     

       
38
       
+
       


     

       
39
       
+
       
        # BEAM-based languages.

     

       
40
       
+
       
        elixir = if versionAtLeast (lib.getVersion erlang) "18"

     

       
41
       
+
       
                 then callPackage ../interpreters/elixir { debugInfo = true; }

     

       
42
       
+
       
                 else throw "Elixir requires at least Erlang/OTP R18.";

     

       
43
       
+
       
        lfe = callPackage ../interpreters/lfe { };

     

       
44
       
+
       


     

       
45
       
+
       
        # Non hex packages

     

       
46
       
+
       
        hex = callPackage ./hex {};

     

       
47
       
+
       
        webdriver = callPackage ./webdriver {};

     

       
48
       
 
       


     

       
49
       
+
       
        hex2nix = callPackage ../tools/erlang/hex2nix {};

     

       
50
       
+
       
        cuter = callPackage ../tools/erlang/cuter {};

     

       
51
       
+
       
        relxExe = callPackage ../tools/erlang/relx-exe {};

     

       
52
       
+
       
      };

     

       
53
       
+
       
in fix' (extends overrides packages)

     

···

       
1
       
-
       
{ pkgs }:

     

       
2
       
 
       


     

       
3
       
 
       
rec {

     

       
4
       
 
       


     
···

       
11
       
 
       
    in f (auto // args);

     

       
12
       
 
       


     

       
13
       
 
       
  callPackage = callPackageWith pkgs;

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
14
       
 
       


     

       
15
       
 
       
  /* Uses generic-builder to evaluate provided drv containing OTP-version

     

       
16
       
 
       
  specific data.

     

···

       
1
       
+
       
{ pkgs, stdenv }:

     

       
2
       
 
       


     

       
3
       
 
       
rec {

     

       
4
       
 
       


     
···

       
11
       
 
       
    in f (auto // args);

     

       
12
       
 
       


     

       
13
       
 
       
  callPackage = callPackageWith pkgs;

     

       
14
       
+
       


     

       
15
       
+
       
  /* Erlang/OTP-specific version retrieval, returns 19 for OTP R19 */

     

       
16
       
+
       
  getVersion = x:

     

       
17
       
+
       
   let

     

       
18
       
+
       
     parse = drv: (builtins.parseDrvName drv).version;

     

       
19
       
+
       
   in builtins.replaceStrings ["B" "-"] ["." "."] (

     

       
20
       
+
       
      if builtins.isString x

     

       
21
       
+
       
      then parse x

     

       
22
       
+
       
      else x.version or (parse x.name));

     

       
23
       
 
       


     

       
24
       
 
       
  /* Uses generic-builder to evaluate provided drv containing OTP-version

     

       
25
       
 
       
  specific data.

     

···

       
3
       
 
       
%%! -smp enable

     

       
4
       
 
       
%%% ---------------------------------------------------------------------------

     

       
5
       
 
       
%%% @doc

     

       
6
       
-
       
%%% The purpose of this command is to prepare a rebar3 project so that

     

       
7
       
-
       
%%% rebar3 understands that the dependencies are all already

     

       
8
       
-
       
%%% installed. If you want a hygienic build on nix then you must run

     

       
9
       
-
       
%%% this command before running rebar3. I suggest that you add a

     

       
10
       
-
       
%%% `Makefile` to your project and have the bootstrap command be a

     

       
11
       
-
       
%%% dependency of the build commands. See the nix documentation for

     

       
12
       
 
       
%%% more information.

     

       
13
       
 
       
%%%

     

       
14
       
-
       
%%% This command designed to have as few dependencies as possible so

     

       
15
       
-
       
%%% that it can be a dependency of root level packages like rebar3. To

     

       
16
       
-
       
%%% that end it does many things in a fairly simplistic way. That is

     

       
17
       
-
       
%%% by design.

     

       
18
       
 
       
%%%

     

       
19
       
 
       
%%% ### Assumptions

     

       
20
       
 
       
%%%

     
···

       
37
       
 
       


     

       
38
       
 
       
%% @doc

     

       
39
       
 
       
%% This takes an app name in the standard OTP <name>-<version> format

     

       
40
       
-
       
%% and returns just the app name. Why? because rebar is doesn't

     

       
41
       
 
       
%% respect OTP conventions in some cases.

     

       
42
       
 
       
-spec fixup_app_name(file:name()) -> string().

     

       
43
       
 
       
fixup_app_name(Path) ->

     

···

       
3
       
 
       
%%! -smp enable

     

       
4
       
 
       
%%% ---------------------------------------------------------------------------

     

       
5
       
 
       
%%% @doc

     

       
6
       
+
       
%%% The purpose of this command is to prepare a mix project so that mix

     

       
7
       
+
       
%%% understands that the dependencies are all already installed. If you want a

     

       
8
       
+
       
%%% hygienic build on nix then you must run this command before running mix. I

     

       
9
       
+
       
%%% suggest that you add a `Makefile` to your project and have the bootstrap

     

       
10
       
+
       
%%% command be a dependency of the build commands. See the nix documentation for

     

       
0
       
 
       

     

       
11
       
 
       
%%% more information.

     

       
12
       
 
       
%%%

     

       
13
       
+
       
%%% This command designed to have as few dependencies as possible so that it can

     

       
14
       
+
       
%%% be a dependency of root level packages like mix. To that end it does many

     

       
15
       
+
       
%%% things in a fairly simplistic way. That is by design.

     

       
0
       
 
       

     

       
16
       
 
       
%%%

     

       
17
       
 
       
%%% ### Assumptions

     

       
18
       
 
       
%%%

     
···

       
35
       
 
       


     

       
36
       
 
       
%% @doc

     

       
37
       
 
       
%% This takes an app name in the standard OTP <name>-<version> format

     

       
38
       
+
       
%% and returns just the app name. Why? Because rebar doesn't

     

       
39
       
 
       
%% respect OTP conventions in some cases.

     

       
40
       
 
       
-spec fixup_app_name(file:name()) -> string().

     

       
41
       
 
       
fixup_app_name(Path) ->

     

···

       
146
       
 
       


     

       
147
       
 
       
%% @doc

     

       
148
       
 
       
%% This takes an app name in the standard OTP <name>-<version> format

     

       
149
       
-
       
%% and returns just the app name. Why? because rebar doesn't

     

       
150
       
 
       
%% respect OTP conventions in some cases.

     

       
151
       
 
       
-spec fixup_app_name(string()) -> string().

     

       
152
       
 
       
fixup_app_name(FileName) ->

     
···

       
180
       
 
       
            erlang:halt(1)

     

       
181
       
 
       
    end.

     

       
182
       
 
       


     

       
183
       
-
       
-spec gather_required_data_from_the_environment(#data{}) -> {ok, map()}.

     

       
184
       
 
       
gather_required_data_from_the_environment(ArgData) ->

     

       
185
       
 
       
    {ok, ArgData#data{ version = guard_env("version")

     

       
186
       
-
       
                     , erl_libs = os:getenv("ERL_LIBS", [])

     

       
187
       
-
       
                     , plugins = os:getenv("buildPlugins", [])

     

       
188
       
 
       
                     , root = code:root_dir()

     

       
189
       
 
       
                     , name = guard_env("name")

     

       
190
       
-
       
                     , compile_ports = nix2bool(os:getenv("compilePorts", ""))

     

       
191
       
 
       
                     , registry_snapshot = guard_env("HEX_REGISTRY_SNAPSHOT")}}.

     

       
192
       
 
       


     

       
193
       
 
       
-spec nix2bool(any()) -> boolean().

     
···

       
196
       
 
       
nix2bool("") ->

     

       
197
       
 
       
    false.

     

       
198
       
 
       


     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
199
       
 
       
-spec guard_env(string()) -> string().

     

       
200
       
 
       
guard_env(Name) ->

     

       
201
       
-
       
    case os:getenv(Name) of

     

       
202
       
 
       
        false ->

     

       
203
       
 
       
            stderr("Expected Environment variable ~s! Are you sure you are "

     

       
204
       
 
       
                   "running in a Nix environment? Either a nix-build, "

     

···

       
146
       
 
       


     

       
147
       
 
       
%% @doc

     

       
148
       
 
       
%% This takes an app name in the standard OTP <name>-<version> format

     

       
149
       
+
       
%% and returns just the app name. Why? Because rebar doesn't

     

       
150
       
 
       
%% respect OTP conventions in some cases.

     

       
151
       
 
       
-spec fixup_app_name(string()) -> string().

     

       
152
       
 
       
fixup_app_name(FileName) ->

     
···

       
180
       
 
       
            erlang:halt(1)

     

       
181
       
 
       
    end.

     

       
182
       
 
       


     

       
183
       
+
       
-spec gather_required_data_from_the_environment(#data{}) -> {ok, #data{}}.

     

       
184
       
 
       
gather_required_data_from_the_environment(ArgData) ->

     

       
185
       
 
       
    {ok, ArgData#data{ version = guard_env("version")

     

       
186
       
+
       
                     , erl_libs = get_env("ERL_LIBS", [])

     

       
187
       
+
       
                     , plugins = get_env("buildPlugins", [])

     

       
188
       
 
       
                     , root = code:root_dir()

     

       
189
       
 
       
                     , name = guard_env("name")

     

       
190
       
+
       
                     , compile_ports = nix2bool(get_env("compilePorts", ""))

     

       
191
       
 
       
                     , registry_snapshot = guard_env("HEX_REGISTRY_SNAPSHOT")}}.

     

       
192
       
 
       


     

       
193
       
 
       
-spec nix2bool(any()) -> boolean().

     
···

       
196
       
 
       
nix2bool("") ->

     

       
197
       
 
       
    false.

     

       
198
       
 
       


     

       
199
       
+
       
get_env(Name) ->

     

       
200
       
+
       
    os:getenv(Name).

     

       
201
       
+
       
get_env(Name, Def) ->

     

       
202
       
+
       
    case get_env(Name) of

     

       
203
       
+
       
        false -> Def;

     

       
204
       
+
       
        Val ->   Val

     

       
205
       
+
       
    end.

     

       
206
       
+
       


     

       
207
       
 
       
-spec guard_env(string()) -> string().

     

       
208
       
 
       
guard_env(Name) ->

     

       
209
       
+
       
    case get_env(Name) of

     

       
210
       
 
       
        false ->

     

       
211
       
 
       
            stderr("Expected Environment variable ~s! Are you sure you are "

     

       
212
       
 
       
                   "running in a Nix environment? Either a nix-build, "

     

···

       
5986
       
 
       
    erlangR18 erlangR18_odbc erlangR18_javac erlangR18_odbc_javac

     

       
5987
       
 
       
    erlangR19 erlangR19_odbc erlangR19_javac erlangR19_odbc_javac;

     

       
5988
       
 
       


     

       
5989
       
-
       
  inherit (beam.packages)

     

       
5990
       
 
       
    rebar rebar3-open rebar3

     

       
5991
       
 
       
    hexRegistrySnapshot fetchHex beamPackages

     

       
5992
       
 
       
    hex2nix cuter relxExe;

     

···

       
5986
       
 
       
    erlangR18 erlangR18_odbc erlangR18_javac erlangR18_odbc_javac

     

       
5987
       
 
       
    erlangR19 erlangR19_odbc erlangR19_javac erlangR19_odbc_javac;

     

       
5988
       
 
       


     

       
5989
       
+
       
  inherit (beam.packages.erlang)

     

       
5990
       
 
       
    rebar rebar3-open rebar3

     

       
5991
       
 
       
    hexRegistrySnapshot fetchHex beamPackages

     

       
5992
       
 
       
    hex2nix cuter relxExe;

     

···

       
1
       
 
       
{ pkgs, stdenv, callPackage, wxGTK30, darwin }:

     

       
2
       
 
       


     

       
3
       
 
       
rec {

     

       
4
       
-
       
  lib = import ../development/beam-modules/lib.nix { inherit pkgs; };

     

       
5
       
 
       


     

       
0
       
 
       

     

       
6
       
 
       
  interpreters = rec {

     

       
7
       
 
       


     

       
8
       
-
       
    # R18 is the Default version.

     

       
9
       
-
       
    erlang = erlangR18;

     

       
10
       
 
       
    erlang_odbc = erlangR18_odbc;

     

       
11
       
 
       
    erlang_javac = erlangR18_javac;

     

       
12
       
 
       
    erlang_odbc_javac = erlangR18_odbc_javac;

     
···

       
44
       
 
       
      odbcSupport = true;

     

       
45
       
 
       
    };

     

       
46
       
 
       


     

       
47
       
-
       
    # Other Beam languages.

     

       
48
       
-
       
    elixir = callPackage ../development/interpreters/elixir { debugInfo = true; };

     

       
49
       
-
       
    lfe = callPackage ../development/interpreters/lfe { };

     

       
0
       
 
       

     

       
0
       
 
       

     

       
50
       
 
       
  };

     

       
51
       
 
       


     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
52
       
 
       
  packages = rec {

     

       
53
       
-
       
    rebar = callPackage ../development/tools/build-managers/rebar { };

     

       
54
       
-
       
    rebar3-open = callPackage ../development/tools/build-managers/rebar3 { hermeticRebar3 = false; };

     

       
55
       
-
       
    rebar3 = callPackage ../development/tools/build-managers/rebar3 { hermeticRebar3 = true; };

     

       
56
       
-
       
    hexRegistrySnapshot = callPackage ../development/beam-modules/hex-registry-snapshot.nix { };

     

       
57
       
-
       
    fetchHex = callPackage ../development/beam-modules/fetch-hex.nix { };

     

       
58
       
 
       


     

       
59
       
-
       
    beamPackages = callPackage ../development/beam-modules { };

     

       
60
       
-
       
    hex2nix = beamPackages.callPackage ../development/tools/erlang/hex2nix { };

     

       
61
       
-
       
    cuter = callPackage ../development/tools/erlang/cuter { };

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
62
       
 
       


     

       
63
       
-
       
    relxExe = callPackage ../development/tools/erlang/relx-exe {};

     

       
64
       
 
       
  };

     

       
65
       
 
       
}

     

···

       
1
       
 
       
{ pkgs, stdenv, callPackage, wxGTK30, darwin }:

     

       
2
       
 
       


     

       
3
       
 
       
rec {

     

       
4
       
+
       
  lib = callPackage ../development/beam-modules/lib.nix {};

     

       
5
       
 
       


     

       
6
       
+
       
  # Each

     

       
7
       
 
       
  interpreters = rec {

     

       
8
       
 
       


     

       
9
       
+
       
    # R18 is the default version.

     

       
10
       
+
       
    erlang = erlangR18; # The main switch to change default Erlang version.

     

       
11
       
 
       
    erlang_odbc = erlangR18_odbc;

     

       
12
       
 
       
    erlang_javac = erlangR18_javac;

     

       
13
       
 
       
    erlang_odbc_javac = erlangR18_odbc_javac;

     
···

       
45
       
 
       
      odbcSupport = true;

     

       
46
       
 
       
    };

     

       
47
       
 
       


     

       
48
       
+
       
    # Other Beam languages. These are built with `beam.interpreters.erlang`. To

     

       
49
       
+
       
    # access for example elixir built with different version of Erlang, use

     

       
50
       
+
       
    # `beam.packages.erlangR19.elixir`.

     

       
51
       
+
       
    elixir = packages.erlang.elixir;

     

       
52
       
+
       
    lfe = packages.erlang.lfe;

     

       
53
       
 
       
  };

     

       
54
       
 
       


     

       
55
       
+
       
  # Helper function to generate package set with a specific Erlang version.

     

       
56
       
+
       
  packagesWith = erlang: callPackage ../development/beam-modules { inherit erlang; };

     

       
57
       
+
       


     

       
58
       
+
       
  # Each field in this tuple represents all Beam packages in nixpkgs built with

     

       
59
       
+
       
  # appropriate Erlang/OTP version.

     

       
60
       
 
       
  packages = rec {

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
61
       
 
       


     

       
62
       
+
       
    # Packages built with default Erlang version.

     

       
63
       
+
       
    erlang = packagesWith interpreters.erlang;

     

       
64
       
+
       
    erlangR16 = packagesWith interpreters.erlangR16;

     

       
65
       
+
       
    erlangR17 = packagesWith interpreters.erlangR17;

     

       
66
       
+
       
    erlangR18 = packagesWith interpreters.erlangR18;

     

       
67
       
+
       
    erlangR19 = packagesWith interpreters.erlangR19;

     

       
68
       
 
       


     

       
0
       
 
       

     

       
69
       
 
       
  };

     

       
70
       
 
       
}