···

       
20
       
20
       
 
       
build-helpers/fetchers.chapter.md

     

       
21
       
21
       
 
       
build-helpers/trivial-build-helpers.chapter.md

     

       
22
       
22
       
 
       
build-helpers/testers.chapter.md

     

       
23
       
23
       
+
       
build-helpers/dev-shell-tools.chapter.md

     

       
23
       
24
       
 
       
build-helpers/special.md

     

       
24
       
25
       
 
       
build-helpers/images.md

     

       
25
       
26
       
 
       
hooks/index.md

     

···

       
1
       
1
       
+
       
# Development Shell helpers {#chap-devShellTools}

     

       
2
       
2
       
+
       


     

       
3
       
3
       
+
       
The `nix-shell` command has popularized the concept of transient shell environments for development or testing purposes.

     

       
4
       
4
       
+
       
<!--

     

       
5
       
5
       
+
       
  We should try to document the product, not its development process in the Nixpkgs reference manual,

     

       
6
       
6
       
+
       
  but *something* needs to be said to provide context for this library.

     

       
7
       
7
       
+
       
  This is the most future proof sentence I could come up with while Nix itself does yet make use of this.

     

       
8
       
8
       
+
       
  Relevant is the current status of the devShell attribute "project": https://github.com/NixOS/nix/issues/7501

     

       
9
       
9
       
+
       
  -->

     

       
10
       
10
       
+
       
However, `nix-shell` is not the only way to create such environments, and even `nix-shell` itself can indirectly benefit from this library.

     

       
11
       
11
       
+
       


     

       
12
       
12
       
+
       
This library provides a set of functions that help create such environments.

     

       
13
       
13
       
+
       


     

       
14
       
14
       
+
       
<!-- ## `devShellTools.<function>` {#sec-devShellTools-<function>} -->

     

···

       
1
       
1
       
+
       


     

       
2
       
2
       
+
       
# `devShellTools`

     

       
3
       
3
       
+
       


     

       
4
       
4
       
+
       
This directory implements the `pkgs.devShellTools` library.

     

       
5
       
5
       
+
       


     

       
6
       
6
       
+
       
# Contributing to `devShellTools`

     

       
7
       
7
       
+
       


     

       
8
       
8
       
+
       
- Documentation should be contributed to the Nixpkgs manual, not here.

     

       
9
       
9
       
+
       


     

       
10
       
10
       
+
       
- Tests are available in the `tests` directory.

     

       
11
       
11
       
+
       
  You may run them with `nix-build -A tests.devShellTools`.

     

       
12
       
12
       
+
       


     

       
13
       
13
       
+
       
- See [../../README.md](../../README.md) for more information on contributing to Nixpkgs.

     

···

       
1
       
1
       
+
       
{ }:

     

       
2
       
2
       
+
       


     

       
3
       
3
       
+
       
{

     

       
4
       
4
       
+
       
}

     

···

       
1
       
1
       
+
       
{ ... }:

     

       
2
       
2
       
+
       


     

       
3
       
3
       
+
       
{

     

       
4
       
4
       
+
       


     

       
5
       
5
       
+
       
}

     

···

       
83
       
83
       
 
       
    inherit gccTests;

     

       
84
       
84
       
 
       
  };

     

       
85
       
85
       
 
       


     

       
86
       
86
       
+
       
  devShellTools = callPackage ../build-support/dev-shell-tools/tests { };

     

       
87
       
87
       
+
       


     

       
86
       
88
       
 
       
  stdenv-inputs = callPackage ./stdenv-inputs { };

     

       
87
       
89
       
 
       
  stdenv = callPackage ./stdenv { };

     

       
88
       
90
       
 
       


     

···

       
837
       
837
       
 
       


     

       
838
       
838
       
 
       
  grsync = callPackage ../applications/misc/grsync { };

     

       
839
       
839
       
 
       


     

       
840
       
840
       
+
       
  devShellTools = callPackage ../build-support/dev-shell-tools { };

     

       
841
       
841
       
+
       


     

       
840
       
842
       
 
       
  dockerTools = callPackage ../build-support/docker {

     

       
841
       
843
       
 
       
    writePython3 = buildPackages.writers.writePython3;

     

       
842
       
844
       
 
       
  } // { __attrsFailEvaluation = true; };