toSource
lib.fileset.toSource
Add the local files contained in fileset
to the store as a single store path rooted at root
.
The result is the store path as a string-like value, making it usable e.g. as the src
of a derivation, or in string interpolation:
stdenv.mkDerivation {
src = lib.fileset.toSource { ... };
# ...
}
The name of the store path is always source
.
Inputs
Takes an attribute set with the following attributes
root
(Path; required)-
The local directory path that will correspond to the root of the resulting store path. Paths in strings, including Nix store paths, cannot be passed as
root
.root
has to be a directory.Changing
root
only affects the directory structure of the resulting store path, it does not change which files are added to the store. The only way to change which files get added to the store is by changing thefileset
attribute. fileset
(FileSet; required)-
The file set whose files to import into the store. File sets can be created using other functions in this library. This argument can also be a path, which gets implicitly coerced to a file set.
If a directory does not recursively contain any file, it is omitted from the store path contents.
Type
toSource :: {
root :: Path,
fileset :: FileSet,
} -> SourceLike
Examples
lib.fileset.toSource
usage example
# Import the current directory into the store
# but only include files under ./src
toSource {
root = ./.;
fileset = ./src;
}
=> "/nix/store/...-source"
# Import the current directory into the store
# but only include ./Makefile and all files under ./src
toSource {
root = ./.;
fileset = union
./Makefile
./src;
}
=> "/nix/store/...-source"
# Trying to include a file outside the root will fail
toSource {
root = ./.;
fileset = unions [
./Makefile
./src
../LICENSE
];
}
=> <error>
# The root needs to point to a directory that contains all the files
toSource {
root = ../.;
fileset = unions [
./Makefile
./src
../LICENSE
];
}
=> "/nix/store/...-source"
# The root has to be a local filesystem path
toSource {
root = "/nix/store/...-source";
fileset = ./.;
}
=> <error>