Loading lib/meta.nix +285 −74 Original line number Diff line number Diff line /* Some functions for manipulating meta attributes, as well as the name attribute. */ /** Some functions for manipulating meta attributes, as well as the name attribute. */ { lib }: Loading @@ -11,74 +13,190 @@ in rec { /* Add to or override the meta attributes of the given /** Add to or override the meta attributes of the given derivation. Example: # Inputs `newAttrs` : 1\. Function argument `drv` : 2\. Function argument # Examples :::{.example} ## `lib.meta.addMetaAttrs` usage example ```nix addMetaAttrs {description = "Bla blah";} somePkg ``` ::: */ addMetaAttrs = newAttrs: drv: drv // { meta = (drv.meta or {}) // newAttrs; }; /* Disable Hydra builds of given derivation. /** Disable Hydra builds of given derivation. # Inputs `drv` : 1\. Function argument */ dontDistribute = drv: addMetaAttrs { hydraPlatforms = []; } drv; /* /** Change the [symbolic name of a derivation](https://nixos.org/manual/nix/stable/language/derivations.html#attr-name). :::{.warning} Dependent derivations will be rebuilt when the symbolic name is changed. ::: # Inputs `name` : 1\. Function argument `drv` : 2\. Function argument */ setName = name: drv: drv // {inherit name;}; /* Like `setName`, but takes the previous name as an argument. /** Like `setName`, but takes the previous name as an argument. # Inputs `updater` : 1\. Function argument `drv` : 2\. Function argument # Examples :::{.example} ## `lib.meta.updateName` usage example Example: ```nix updateName (oldName: oldName + "-experimental") somePkg ``` ::: */ updateName = updater: drv: drv // {name = updater (drv.name);}; /* Append a suffix to the name of a package (before the version part). */ /** Append a suffix to the name of a package (before the version part). # Inputs `suffix` : 1\. Function argument */ appendToName = suffix: updateName (name: let x = builtins.parseDrvName name; in "${x.name}-${suffix}-${x.version}"); /* Apply a function to each derivation and only to derivations in an attrset. /** Apply a function to each derivation and only to derivations in an attrset. # Inputs `f` : 1\. Function argument `set` : 2\. Function argument */ mapDerivationAttrset = f: set: lib.mapAttrs (name: pkg: if lib.isDerivation pkg then (f pkg) else pkg) set; /* Set the nix-env priority of the package. /** Set the nix-env priority of the package. # Inputs `priority` : 1\. Function argument `drv` : 2\. Function argument */ setPrio = priority: addMetaAttrs { inherit priority; }; /* Decrease the nix-env priority of the package, i.e., other /** Decrease the nix-env priority of the package, i.e., other versions/variants of the package will be preferred. # Inputs `drv` : 1\. Function argument */ lowPrio = setPrio 10; /* Apply lowPrio to an attrset with derivations /** Apply lowPrio to an attrset with derivations # Inputs `set` : 1\. Function argument */ lowPrioSet = set: mapDerivationAttrset lowPrio set; /* Increase the nix-env priority of the package, i.e., this /** Increase the nix-env priority of the package, i.e., this version/variant of the package will be preferred. # Inputs `drv` : 1\. Function argument */ hiPrio = setPrio (-10); /* Apply hiPrio to an attrset with derivations /** Apply hiPrio to an attrset with derivations # Inputs `set` : 1\. Function argument */ hiPrioSet = set: mapDerivationAttrset hiPrio set; /* Check to see if a platform is matched by the given `meta.platforms` /** Check to see if a platform is matched by the given `meta.platforms` element. A `meta.platform` pattern is either Loading @@ -92,9 +210,28 @@ rec { We can inject these into a pattern for the whole of a structured platform, and then match that. Example: # Inputs `platform` : 1\. Function argument `elem` : 2\. Function argument # Examples :::{.example} ## `lib.meta.platformMatch` usage example ```nix lib.meta.platformMatch { system = "aarch64-darwin"; } "aarch64-darwin" => true ``` ::: */ platformMatch = platform: elem: ( # Check with simple string comparison if elem was a string. Loading @@ -112,7 +249,8 @@ rec { ) platform ); /* Check if a package is available on a given platform. /** Check if a package is available on a given platform. A package is available on a platform if both Loading @@ -121,23 +259,50 @@ rec { 2. None of `meta.badPlatforms` pattern matches the given platform. Example: # Inputs `platform` : 1\. Function argument `pkg` : 2\. Function argument # Examples :::{.example} ## `lib.meta.availableOn` usage example ```nix lib.meta.availableOn { system = "aarch64-darwin"; } pkg.zsh => true ``` ::: */ availableOn = platform: pkg: ((!pkg?meta.platforms) || any (platformMatch platform) pkg.meta.platforms) && all (elem: !platformMatch platform elem) (pkg.meta.badPlatforms or []); /* Get the corresponding attribute in lib.licenses /** Get the corresponding attribute in lib.licenses from the SPDX ID. For SPDX IDs, see https://spdx.org/licenses Type: # Type ``` getLicenseFromSpdxId :: str -> AttrSet ``` # Examples :::{.example} ## `lib.meta.getLicenseFromSpdxId` usage example Example: ```nix lib.getLicenseFromSpdxId "MIT" == lib.licenses.mit => true lib.getLicenseFromSpdxId "mIt" == lib.licenses.mit Loading @@ -145,6 +310,9 @@ rec { lib.getLicenseFromSpdxId "MY LICENSE" => trace: warning: getLicenseFromSpdxId: No license matches the given SPDX ID: MY LICENSE => { shortName = "MY LICENSE"; } ``` ::: */ getLicenseFromSpdxId = let Loading @@ -156,15 +324,34 @@ rec { { shortName = licstr; } ); /* Get the path to the main program of a package based on meta.mainProgram /** Get the path to the main program of a package based on meta.mainProgram Type: getExe :: package -> string # Inputs Example: `x` : 1\. Function argument # Type ``` getExe :: package -> string ``` # Examples :::{.example} ## `lib.meta.getExe` usage example ```nix getExe pkgs.hello => "/nix/store/g124820p9hlv4lj8qplzxw1c44dxaw1k-hello-2.12/bin/hello" getExe pkgs.mustache-go => "/nix/store/am9ml4f4ywvivxnkiaqwr0hyxka1xjsf-mustache-go-1.3.0/bin/mustache" ``` ::: */ getExe = x: getExe' x (x.meta.mainProgram or ( # This could be turned into an error when 23.05 is at end of life Loading @@ -173,14 +360,38 @@ rec { x )); /* Get the path of a program of a derivation. /** Get the path of a program of a derivation. # Inputs `x` : 1\. Function argument `y` Type: getExe' :: derivation -> string -> string Example: : 2\. Function argument # Type ``` getExe' :: derivation -> string -> string ``` # Examples :::{.example} ## `lib.meta.getExe'` usage example ```nix getExe' pkgs.hello "hello" => "/nix/store/g124820p9hlv4lj8qplzxw1c44dxaw1k-hello-2.12/bin/hello" getExe' pkgs.imagemagick "convert" => "/nix/store/5rs48jamq7k6sal98ymj9l4k2bnwq515-imagemagick-7.1.1-15/bin/convert" ``` ::: */ getExe' = x: y: assert assertMsg (isDerivation x) Loading Loading
lib/meta.nix +285 −74 Original line number Diff line number Diff line /* Some functions for manipulating meta attributes, as well as the name attribute. */ /** Some functions for manipulating meta attributes, as well as the name attribute. */ { lib }: Loading @@ -11,74 +13,190 @@ in rec { /* Add to or override the meta attributes of the given /** Add to or override the meta attributes of the given derivation. Example: # Inputs `newAttrs` : 1\. Function argument `drv` : 2\. Function argument # Examples :::{.example} ## `lib.meta.addMetaAttrs` usage example ```nix addMetaAttrs {description = "Bla blah";} somePkg ``` ::: */ addMetaAttrs = newAttrs: drv: drv // { meta = (drv.meta or {}) // newAttrs; }; /* Disable Hydra builds of given derivation. /** Disable Hydra builds of given derivation. # Inputs `drv` : 1\. Function argument */ dontDistribute = drv: addMetaAttrs { hydraPlatforms = []; } drv; /* /** Change the [symbolic name of a derivation](https://nixos.org/manual/nix/stable/language/derivations.html#attr-name). :::{.warning} Dependent derivations will be rebuilt when the symbolic name is changed. ::: # Inputs `name` : 1\. Function argument `drv` : 2\. Function argument */ setName = name: drv: drv // {inherit name;}; /* Like `setName`, but takes the previous name as an argument. /** Like `setName`, but takes the previous name as an argument. # Inputs `updater` : 1\. Function argument `drv` : 2\. Function argument # Examples :::{.example} ## `lib.meta.updateName` usage example Example: ```nix updateName (oldName: oldName + "-experimental") somePkg ``` ::: */ updateName = updater: drv: drv // {name = updater (drv.name);}; /* Append a suffix to the name of a package (before the version part). */ /** Append a suffix to the name of a package (before the version part). # Inputs `suffix` : 1\. Function argument */ appendToName = suffix: updateName (name: let x = builtins.parseDrvName name; in "${x.name}-${suffix}-${x.version}"); /* Apply a function to each derivation and only to derivations in an attrset. /** Apply a function to each derivation and only to derivations in an attrset. # Inputs `f` : 1\. Function argument `set` : 2\. Function argument */ mapDerivationAttrset = f: set: lib.mapAttrs (name: pkg: if lib.isDerivation pkg then (f pkg) else pkg) set; /* Set the nix-env priority of the package. /** Set the nix-env priority of the package. # Inputs `priority` : 1\. Function argument `drv` : 2\. Function argument */ setPrio = priority: addMetaAttrs { inherit priority; }; /* Decrease the nix-env priority of the package, i.e., other /** Decrease the nix-env priority of the package, i.e., other versions/variants of the package will be preferred. # Inputs `drv` : 1\. Function argument */ lowPrio = setPrio 10; /* Apply lowPrio to an attrset with derivations /** Apply lowPrio to an attrset with derivations # Inputs `set` : 1\. Function argument */ lowPrioSet = set: mapDerivationAttrset lowPrio set; /* Increase the nix-env priority of the package, i.e., this /** Increase the nix-env priority of the package, i.e., this version/variant of the package will be preferred. # Inputs `drv` : 1\. Function argument */ hiPrio = setPrio (-10); /* Apply hiPrio to an attrset with derivations /** Apply hiPrio to an attrset with derivations # Inputs `set` : 1\. Function argument */ hiPrioSet = set: mapDerivationAttrset hiPrio set; /* Check to see if a platform is matched by the given `meta.platforms` /** Check to see if a platform is matched by the given `meta.platforms` element. A `meta.platform` pattern is either Loading @@ -92,9 +210,28 @@ rec { We can inject these into a pattern for the whole of a structured platform, and then match that. Example: # Inputs `platform` : 1\. Function argument `elem` : 2\. Function argument # Examples :::{.example} ## `lib.meta.platformMatch` usage example ```nix lib.meta.platformMatch { system = "aarch64-darwin"; } "aarch64-darwin" => true ``` ::: */ platformMatch = platform: elem: ( # Check with simple string comparison if elem was a string. Loading @@ -112,7 +249,8 @@ rec { ) platform ); /* Check if a package is available on a given platform. /** Check if a package is available on a given platform. A package is available on a platform if both Loading @@ -121,23 +259,50 @@ rec { 2. None of `meta.badPlatforms` pattern matches the given platform. Example: # Inputs `platform` : 1\. Function argument `pkg` : 2\. Function argument # Examples :::{.example} ## `lib.meta.availableOn` usage example ```nix lib.meta.availableOn { system = "aarch64-darwin"; } pkg.zsh => true ``` ::: */ availableOn = platform: pkg: ((!pkg?meta.platforms) || any (platformMatch platform) pkg.meta.platforms) && all (elem: !platformMatch platform elem) (pkg.meta.badPlatforms or []); /* Get the corresponding attribute in lib.licenses /** Get the corresponding attribute in lib.licenses from the SPDX ID. For SPDX IDs, see https://spdx.org/licenses Type: # Type ``` getLicenseFromSpdxId :: str -> AttrSet ``` # Examples :::{.example} ## `lib.meta.getLicenseFromSpdxId` usage example Example: ```nix lib.getLicenseFromSpdxId "MIT" == lib.licenses.mit => true lib.getLicenseFromSpdxId "mIt" == lib.licenses.mit Loading @@ -145,6 +310,9 @@ rec { lib.getLicenseFromSpdxId "MY LICENSE" => trace: warning: getLicenseFromSpdxId: No license matches the given SPDX ID: MY LICENSE => { shortName = "MY LICENSE"; } ``` ::: */ getLicenseFromSpdxId = let Loading @@ -156,15 +324,34 @@ rec { { shortName = licstr; } ); /* Get the path to the main program of a package based on meta.mainProgram /** Get the path to the main program of a package based on meta.mainProgram Type: getExe :: package -> string # Inputs Example: `x` : 1\. Function argument # Type ``` getExe :: package -> string ``` # Examples :::{.example} ## `lib.meta.getExe` usage example ```nix getExe pkgs.hello => "/nix/store/g124820p9hlv4lj8qplzxw1c44dxaw1k-hello-2.12/bin/hello" getExe pkgs.mustache-go => "/nix/store/am9ml4f4ywvivxnkiaqwr0hyxka1xjsf-mustache-go-1.3.0/bin/mustache" ``` ::: */ getExe = x: getExe' x (x.meta.mainProgram or ( # This could be turned into an error when 23.05 is at end of life Loading @@ -173,14 +360,38 @@ rec { x )); /* Get the path of a program of a derivation. /** Get the path of a program of a derivation. # Inputs `x` : 1\. Function argument `y` Type: getExe' :: derivation -> string -> string Example: : 2\. Function argument # Type ``` getExe' :: derivation -> string -> string ``` # Examples :::{.example} ## `lib.meta.getExe'` usage example ```nix getExe' pkgs.hello "hello" => "/nix/store/g124820p9hlv4lj8qplzxw1c44dxaw1k-hello-2.12/bin/hello" getExe' pkgs.imagemagick "convert" => "/nix/store/5rs48jamq7k6sal98ymj9l4k2bnwq515-imagemagick-7.1.1-15/bin/convert" ``` ::: */ getExe' = x: y: assert assertMsg (isDerivation x) Loading
