Something went wrong. Try again.
What happens if I push all of nixpkgs
Something went wrong. Try again.
Nix
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542# Functions for copying sources to the Nix store.{ lib }:
# Tested in lib/tests/sources.shlet inherit (lib.strings) match split storeDir ; inherit (lib) boolToString filter isString readFile ; inherit (lib.filesystem) pathIsRegularFile ;
/** A basic filter for `cleanSourceWith` that removes directories of version control system, backup files (*~) and some generated files.
# Inputs
`name`
: 1\. Function argument
`type`
: 2\. Function argument */ cleanSourceFilter = name: type: let baseName = baseNameOf (toString name); in !( # Filter out version control software files/directories ( baseName == ".git" || type == "directory" && (baseName == ".svn" || baseName == "CVS" || baseName == ".hg" || baseName == ".jj") ) || # Filter out editor backup / swap files. lib.hasSuffix "~" baseName || match "^\\.sw[a-z]$" baseName != null || match "^\\..*\\.sw[a-z]$" baseName != null ||
# Filter out generates files. lib.hasSuffix ".o" baseName || lib.hasSuffix ".so" baseName || # Filter out nix-build result symlinks (type == "symlink" && lib.hasPrefix "result" baseName) || # Filter out sockets and other types of files we can't have in the store. (type == "unknown") );
/** Filters a source tree removing version control files and directories using cleanSourceFilter.
# Inputs
`src`
: 1\. Function argument
# Examples :::{.example} ## `cleanSource` usage example
```nix cleanSource ./. ```
::: */ cleanSource = src: cleanSourceWith { filter = cleanSourceFilter; inherit src; };
/** Like `builtins.filterSource`, except it will compose with itself, allowing you to chain multiple calls together without any intermediate copies being put in the nix store.
# Examples :::{.example} ## `cleanSourceWith` usage example
```nix lib.cleanSourceWith { filter = f; src = lib.cleanSourceWith { filter = g; src = ./.; }; } # Succeeds!
builtins.filterSource f (builtins.filterSource g ./.) # Fails! ```
::: */ cleanSourceWith = { # A path or cleanSourceWith result to filter and/or rename. src, # Optional with default value: constant true (include everything) # The function will be combined with the && operator such # that src.filter is called lazily. # For implementing a filter, see # https://nixos.org/nix/manual/#builtin-filterSource # Type: A function (path -> type -> bool) filter ? _path: _type: true, # Optional name to use as part of the store path. # This defaults to `src.name` or otherwise `"source"`. name ? null, }: let orig = toSourceAttributes src; in fromSourceAttributes { inherit (orig) origSrc; filter = path: type: filter path type && orig.filter path type; name = if name != null then name else orig.name; };
/** Add logging to a source, for troubleshooting the filtering behavior.
# Inputs
`src`
: Source to debug. The returned source will behave like this source, but also log its filter invocations.
# Type
``` sources.trace :: sourceLike -> Source ``` */ trace = # Source to debug. The returned source will behave like this source, but also log its filter invocations. src: let attrs = toSourceAttributes src; in fromSourceAttributes ( attrs // { filter = path: type: let r = attrs.filter path type; in builtins.trace "${attrs.name}.filter ${path} = ${boolToString r}" r; } ) // { satisfiesSubpathInvariant = src ? satisfiesSubpathInvariant && src.satisfiesSubpathInvariant; };
/** Filter sources by a list of regular expressions.
# Inputs
`src`
: 1\. Function argument
`regexes`
: 2\. Function argument
# Examples :::{.example} ## `sourceByRegex` usage example
```nix src = sourceByRegex ./my-subproject [".*\.py$" "^database.sql$"] ```
::: */ sourceByRegex = src: regexes: let isFiltered = src ? _isLibCleanSourceWith; origSrc = if isFiltered then src.origSrc else src; in lib.cleanSourceWith { filter = ( path: type: let relPath = lib.removePrefix (toString origSrc + "/") (toString path); in lib.any (re: match re relPath != null) regexes ); inherit src; };
/** Get all files ending with the specified suffices from the given source directory or its descendants, omitting files that do not match any suffix. The result of the example below will include files like `./dir/module.c` and `./dir/subdir/doc.xml` if present.
# Inputs
`src`
: Path or source containing the files to be returned
`exts`
: A list of file suffix strings
# Type
``` sourceLike -> [String] -> Source ```
# Examples :::{.example} ## `sourceFilesBySuffices` usage example
```nix sourceFilesBySuffices ./. [ ".xml" ".c" ] ```
::: */ sourceFilesBySuffices = # Path or source containing the files to be returned src: # A list of file suffix strings exts: let filter = name: type: let base = baseNameOf (toString name); in type == "directory" || lib.any (ext: lib.hasSuffix ext base) exts; in cleanSourceWith { inherit filter src; };
pathIsGitRepo = path: (_commitIdFromGitRepoOrError path) ? value;
/** Get the commit id of a git repo.
# Inputs
`path`
: 1\. Function argument
# Examples :::{.example} ## `commitIdFromGitRepo` usage example
```nix commitIdFromGitRepo <nixpkgs/.git> ```
::: */ commitIdFromGitRepo = path: let commitIdOrError = _commitIdFromGitRepoOrError path; in commitIdOrError.value or (throw commitIdOrError.error);
# Get the commit id of a git repo.
# Returns `{ value = commitHash }` or `{ error = "... message ..." }`.
# Example: commitIdFromGitRepo <nixpkgs/.git> # not exported, used for commitIdFromGitRepo _commitIdFromGitRepoOrError = let readCommitFromFile = file: path: let fileName = path + "/${file}"; packedRefsName = path + "/packed-refs"; absolutePath = base: path: if lib.hasPrefix "/" path then path else toString (/. + "${base}/${path}"); in if pathIsRegularFile path # Resolve git worktrees. See gitrepository-layout(5) then let m = match "^gitdir: (.*)$" (lib.fileContents path); in if m == null then { error = "File contains no gitdir reference: " + path; } else let gitDir = absolutePath (dirOf path) (lib.head m); commonDir'' = if pathIsRegularFile "${gitDir}/commondir" then lib.fileContents "${gitDir}/commondir" else gitDir; commonDir' = lib.removeSuffix "/" commonDir''; commonDir = absolutePath gitDir commonDir'; refFile = lib.removePrefix "${commonDir}/" "${gitDir}/${file}"; in readCommitFromFile refFile commonDir
else if pathIsRegularFile fileName # Sometimes git stores the commitId directly in the file but # sometimes it stores something like: «ref: refs/heads/branch-name» then let fileContent = lib.fileContents fileName; matchRef = match "^ref: (.*)$" fileContent; in if matchRef == null then { value = fileContent; } else readCommitFromFile (lib.head matchRef) path
else if pathIsRegularFile packedRefsName # Sometimes, the file isn't there at all and has been packed away in the # packed-refs file, so we have to grep through it: then let fileContent = readFile packedRefsName; matchRef = match "([a-z0-9]+) ${file}"; isRef = s: isString s && (matchRef s) != null; # there is a bug in libstdc++ leading to stackoverflow for long strings: # https://github.com/NixOS/nix/issues/2147#issuecomment-659868795 refs = filter isRef (split "\n" fileContent); in if refs == [ ] then { error = "Could not find " + file + " in " + packedRefsName; } else { value = lib.head (matchRef (lib.head refs)); }
else { error = "Not a .git directory: " + toString path; }; in readCommitFromFile "HEAD";
pathHasContext = builtins.hasContext or (lib.hasPrefix storeDir);
canCleanSource = src: src ? _isLibCleanSourceWith || !(pathHasContext (toString src));
# -------------------------------------------------------------------------- # # Internal functions #
# toSourceAttributes : sourceLike -> SourceAttrs # # Convert any source-like object into a simple, singular representation. # We don't expose this representation in order to avoid having a fifth path- # like class of objects in the wild. # (Existing ones being: paths, strings, sources and x//{outPath}) # So instead of exposing internals, we build a library of combinator functions. toSourceAttributes = src: let isFiltered = src ? _isLibCleanSourceWith; in { # The original path origSrc = if isFiltered then src.origSrc else src; filter = if isFiltered then src.filter else _: _: true; name = if isFiltered then src.name else "source"; };
# fromSourceAttributes : SourceAttrs -> Source # # Inverse of toSourceAttributes for Source objects. fromSourceAttributes = { origSrc, filter, name, }: { _isLibCleanSourceWith = true; inherit origSrc filter name; outPath = builtins.path { inherit filter name; path = origSrc; }; };
# urlToName : (URL | Path | String) -> String # # Transform a URL (or path, or string) into a clean package name. urlToName = url: let inherit (lib.strings) stringLength; base = baseNameOf (lib.removeSuffix "/" (lib.last (lib.splitString ":" (toString url)))); # chop away one git or archive-related extension removeExt = name: let matchExt = match "(.*)\\.(git|tar|zip|gz|tgz|bz|tbz|bz2|tbz2|lzma|txz|xz|zstd)$" name; in if matchExt != null then lib.head matchExt else name; # apply function f to string x while the result shrinks shrink = f: x: let v = f x; in if stringLength v < stringLength x then shrink f v else x; in shrink removeExt base;
# shortRev : (String | Integer) -> String # # Given a package revision (like "refs/tags/v12.0"), produce a short revision ("12.0"). shortRev = rev: let baseRev = baseNameOf (toString rev); matchHash = match "[a-f0-9]+" baseRev; matchVer = match "([A-Za-z]+[-_. ]?)*(v)?([0-9.]+.*)" baseRev; in if matchHash != null then builtins.substring 0 7 baseRev else if matchVer != null then lib.last matchVer else baseRev;
# revOrTag : String -> String -> String # # Turn git `rev` and `tag` pair into a revision usable in `repoRevToName*`. revOrTag = rev: tag: if tag != null then tag else if rev != null then rev else "HEAD";
# repoRevToNameFull : (URL | Path | String) -> (String | Integer | null) -> (String | null) -> String # # See `repoRevToName` below. repoRevToNameFull = repo_: rev_: suffix_: let repo = urlToName repo_; rev = if rev_ != null then "-${shortRev rev_}" else ""; suffix = if suffix_ != null then "-${suffix_}" else ""; in "${repo}${rev}${suffix}-source";
# repoRevToName : String -> (URL | Path | String) -> (String | Integer | null) -> String -> String # # Produce derivation.name attribute for a given repository URL/path/name and (optionally) its revision/version tag. # # This is used by fetch(zip|git|FromGitHub|hg|svn|etc) to generate discoverable # /nix/store paths. # # This uses a different implementation depending on the `pretty` argument: # "source" -> name everything as "source" # "versioned" -> name everything as "${repo}-${rev}-source" # "full" -> name everything as "${repo}-${rev}-${fetcher}-source" repoRevToName = kind: # match on `kind` first to minimize the thunk if kind == "source" then ( repo: rev: suffix: "source" ) else if kind == "versioned" then ( repo: rev: suffix: repoRevToNameFull repo rev null ) else if kind == "full" then repoRevToNameFull else throw "repoRevToName: invalid kind";
in{
pathType = lib.warnIf (lib.oldestSupportedReleaseIsAtLeast 2305) "lib.sources.pathType has been moved to lib.filesystem.pathType." lib.filesystem.pathType;
pathIsDirectory = lib.warnIf (lib.oldestSupportedReleaseIsAtLeast 2305) "lib.sources.pathIsDirectory has been moved to lib.filesystem.pathIsDirectory." lib.filesystem.pathIsDirectory;
pathIsRegularFile = lib.warnIf (lib.oldestSupportedReleaseIsAtLeast 2305) "lib.sources.pathIsRegularFile has been moved to lib.filesystem.pathIsRegularFile." lib.filesystem.pathIsRegularFile;
inherit pathIsGitRepo commitIdFromGitRepo
cleanSource cleanSourceWith cleanSourceFilter pathHasContext canCleanSource
urlToName shortRev revOrTag repoRevToName
sourceByRegex sourceFilesBySuffices
trace ;}