commit 35de51aa26aa3f2357984ebef214f3f380162b30 · pyrox.dev/nixpkgs

.github/CODEOWNERS

···

       225
       225
        
       

     

       226
       226
        
       # Cinnamon

     

       227
       227
        
       /pkgs/desktops/cinnamon @mkg20001

     

       228
       228
       +
       

     

       229
       229
       +
       #nim

     

       230
       230
       +
       /pkgs/development/compilers/nim  @ehmry

     

       231
       231
       +
       /pkgs/development/nim-packages  @ehmry

     

       232
       232
       +
       /pkgs/top-level/nim-packages.nix  @ehmry

.github/labeler.yml

···

       72
       72
        
         - nixos/**/*

     

       73
       73
        
         - pkgs/os-specific/linux/nixos-rebuild/**/*

     

       74
       74
        
       

     

       75
       75
       +
       "6.topic: nim":

     

       76
       76
       +
         - doc/languages-frameworks/nim.section.md

     

       77
       77
       +
         - pkgs/development/compilers/nim/*

     

       78
       78
       +
         - pkgs/development/nim-packages/**/*

     

       79
       79
       +
         - pkgs/top-level/nim-packages.nix

     

       80
       80
       +
       

     

       75
       81
        
       "6.topic: ocaml":

     

       76
       82
        
         - doc/languages-frameworks/ocaml.section.md

     

       77
       83
        
         - pkgs/development/compilers/ocaml/**/*

doc/languages-frameworks/index.xml

···

       23
       23
        
        <xi:include href="javascript.section.xml" />

     

       24
       24
        
        <xi:include href="lua.section.xml" />

     

       25
       25
        
        <xi:include href="maven.section.xml" />

     

       26
       26
       +
        <xi:include href="nim.section.xml" />

     

       26
       27
        
        <xi:include href="ocaml.section.xml" />

     

       27
       28
        
        <xi:include href="perl.section.xml" />

     

       28
       29
        
        <xi:include href="php.section.xml" />

+91

doc/languages-frameworks/nim.section.md

···

       1
       1
       +
       # Nim {#nim}

     

       2
       2
       +
       

     

       3
       3
       +
       ## Overview {#nim-overview}

     

       4
       4
       +
       

     

       5
       5
       +
       The Nim compiler, a builder function, and some packaged libraries are available

     

       6
       6
       +
       in Nixpkgs. Until now each compiler release has been effectively backwards

     

       7
       7
       +
       compatible so only the latest version is available.

     

       8
       8
       +
       

     

       9
       9
       +
       ## Nim program packages in Nixpkgs {#nim-program-packages-in-nixpkgs}

     

       10
       10
       +
       

     

       11
       11
       +
       Nim programs can be built using `nimPackages.buildNimPackage`. In the

     

       12
       12
       +
       case of packages not containing exported library code the attribute

     

       13
       13
       +
       `nimBinOnly` should be set to `true`.

     

       14
       14
       +
       

     

       15
       15
       +
       The following example shows a Nim program that depends only on Nim libraries:

     

       16
       16
       +
       

     

       17
       17
       +
       ```nix

     

       18
       18
       +
       { lib, nimPackages, fetchurl }:

     

       19
       19
       +
       

     

       20
       20
       +
       nimPackages.buildNimPackage rec {

     

       21
       21
       +
         pname = "hottext";

     

       22
       22
       +
         version = "1.4";

     

       23
       23
       +
       

     

       24
       24
       +
         nimBinOnly = true;

     

       25
       25
       +
       

     

       26
       26
       +
         src = fetchurl {

     

       27
       27
       +
           url = "https://git.sr.ht/~ehmry/hottext/archive/v${version}.tar.gz";

     

       28
       28
       +
           sha256 = "sha256-hIUofi81zowSMbt1lUsxCnVzfJGN3FEiTtN8CEFpwzY=";

     

       29
       29
       +
         };

     

       30
       30
       +
       

     

       31
       31
       +
         buildInputs = with nimPackages; [

     

       32
       32
       +
           bumpy

     

       33
       33
       +
           chroma

     

       34
       34
       +
           flatty

     

       35
       35
       +
           nimsimd

     

       36
       36
       +
           pixie

     

       37
       37
       +
           sdl2

     

       38
       38
       +
           typography

     

       39
       39
       +
           vmath

     

       40
       40
       +
           zippy

     

       41
       41
       +
         ];

     

       42
       42
       +
       }

     

       43
       43
       +
       

     

       44
       44
       +
       ```

     

       45
       45
       +
       

     

       46
       46
       +
       ## Nim library packages in Nixpkgs {#nim-library-packages-in-nixpkgs}

     

       47
       47
       +
       

     

       48
       48
       +
       

     

       49
       49
       +
       Nim libraries can also be built using `nimPackages.buildNimPackage`, but

     

       50
       50
       +
       often the product of a fetcher is sufficient to satisfy a dependency.

     

       51
       51
       +
       The `fetchgit`, `fetchFromGitHub`, and `fetchNimble` functions yield an

     

       52
       52
       +
       output that can be discovered during the `configurePhase` of `buildNimPackage`.

     

       53
       53
       +
       

     

       54
       54
       +
       Nim library packages are listed in

     

       55
       55
       +
       [pkgs/top-level/nim-packages.nix](https://github.com/NixOS/nixpkgs/blob/master/pkgs/top-level/nim-packages.nix) and implemented at

     

       56
       56
       +
       [pkgs/development/nim-packages](https://github.com/NixOS/nixpkgs/tree/master/pkgs/development/nim-packages).

     

       57
       57
       +
       

     

       58
       58
       +
       The following example shows a Nim library that propagates a dependency on a

     

       59
       59
       +
       non-Nim package:

     

       60
       60
       +
       ```nix

     

       61
       61
       +
       { lib, buildNimPackage, fetchNimble, SDL2 }:

     

       62
       62
       +
       

     

       63
       63
       +
       buildNimPackage rec {

     

       64
       64
       +
         pname = "sdl2";

     

       65
       65
       +
         version = "2.0.4";

     

       66
       66
       +
         src = fetchNimble {

     

       67
       67
       +
           inherit pname version;

     

       68
       68
       +
           hash = "sha256-Vtcj8goI4zZPQs2TbFoBFlcR5UqDtOldaXSH/+/xULk=";

     

       69
       69
       +
         };

     

       70
       70
       +
         propagatedBuildInputs = [ SDL2 ];

     

       71
       71
       +
       }

     

       72
       72
       +
       ```

     

       73
       73
       +
       

     

       74
       74
       +
       ## `buildNimPackage` parameters {#buildnimpackage-parameters}

     

       75
       75
       +
       

     

       76
       76
       +
       All parameters from `stdenv.mkDerivation` function are still supported. The

     

       77
       77
       +
       following are specific to `buildNimPackage`:

     

       78
       78
       +
       

     

       79
       79
       +
       * `nimBinOnly ? false`: If `true` then build only the programs listed in

     

       80
       80
       +
         the Nimble file in the packages sources.

     

       81
       81
       +
       * `nimbleFile`: Specify the Nimble file location of the package being built

     

       82
       82
       +
         rather than discover the file at build-time.

     

       83
       83
       +
       * `nimRelease ? true`: Build the package in *release* mode.

     

       84
       84
       +
       * `nimDefines ? []`: A list of Nim defines. Key-value tuples are not supported.

     

       85
       85
       +
       * `nimFlags ? []`: A list of command line arguments to pass to the Nim compiler.

     

       86
       86
       +
         Use this to specify defines with arguments in the form of `-d:${name}=${value}`.

     

       87
       87
       +
       * `nimDoc` ? false`: Build and install HTML documentation.

     

       88
       88
       +
       

     

       89
       89
       +
       * `buildInputs` ? []: The packages listed here will be searched for `*.nimble`

     

       90
       90
       +
         files which are used to populate the Nim library path. Otherwise the standard

     

       91
       91
       +
         behavior is in effect.