php-composer-lock - options

deps

All dependencies of the package. This option should be set by the “outer world” and can be used to inherit attributes from pkgs or inputs etc.

By separating the task of retrieving things from the outside world, it is ensured that the dependencies are overridable. Nothing will stop users from adding nixpkgs itself as a dependency, but this will make it very hard for the user of the package to override any dependencies, because they’d have to figure out a way to insert their changes into the Nixpkgs fixpoint. By adding specific attributes to deps instead, the user has a realistic chance of overriding those dependencies.

So deps should be specific, but not overly specific. For instance, the caller shouldn’t have to know the version of a dependency in order to override it. The name should suffice. (e.g. nix = nixVersions.nix_2_12 instead of inherit (nixVersions) nix_2_12.

Type: lazy attribute set of raw value

Default: { }

Example:

{nixpkgs, ...}: {
  inherit (nixpkgs) stdenv;
  inherit (nixpkgs.haskellPackages) pandoc;
}

Declared by:

deps.stdenv

The stdenv used for building this package

Type: raw value

Declared by:

env

environment variables passed to the build environment

Type: attribute set of (null or boolean or signed integer or string or path or package or list of (boolean or signed integer or string or path or package))

Default: { }

Declared by:

lock.content

The content of the lock file. All fields declared via lock.fields are contained pointing to their respective values.

Type: anything

Declared by:

lock.extraScripts

Extra shell scripts to execute when nix run .#{package}.lock is called.

This allows adding custom logic to the lock file generation.

Type: list of path

Default: [ ]

Declared by:

lock.fields

Fields of the lock file

Type: attribute set of (submodule)

Default: { }

Example:

{
  pname = true;
  version = true;
}

Declared by:

lock.fields.<name>.default

The default value in case the lock file doesn’t exist or doesn’t yet contain the field.

Type: null or anything

Default: null

Declared by:

lock.fields.<name>.script

A script to refresh the value of this lock file field. The script should write the result as json file to $out.

Type: path

Declared by:

lock.invalidationData

Pass any data that should invalidate the lock file when changed. This is useful for example when the lock file should be regenerated when the requirements change.

Type: anything

Default: { }

Example:

{
  pip = {
    lockVersion = "2";
    requirements = [
      "requests"
      "pillow"
    ];
  };
}

Declared by:

lock.lib.computeFODHash

Helper function to write the hash of a given FOD to $out.

Type: function that evaluates to a(n) path (read only)

Declared by:

lock.refresh

Script to refresh the lock file

Type: package (read only)

Declared by:

mkDerivation.enableParallelBuilding

This option has no description.

Type: null or boolean

Default: null

Declared by:

mkDerivation.enableParallelChecking

This option has no description.

Type: null or boolean

Default: null

Declared by:

mkDerivation.__contentAddressed

This option has no description.

Type: null or boolean

Default: null

Declared by:

mkDerivation.__darwinAllowLocalNetworking

This option has no description.

Type: null or boolean

Default: null

Declared by:

mkDerivation.__impureHostDeps

This option has no description.

Type: null or (list of anything)

Default: null

Declared by:

mkDerivation.__propagatedImpureHostDeps

This option has no description.

Type: null or (list of anything)

Default: null

Declared by:

mkDerivation.__structuredAttrs

This option has no description.

Type: null or boolean

Default: null

Declared by:

mkDerivation.allowSubstitutes

This option has no description.

Type: null or boolean

Default: null

Declared by:

mkDerivation.allowedReferences

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

mkDerivation.allowedRequisites

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

mkDerivation.args

This option has no description.

Type: null or (list of (string or path))

Default: null

Declared by:

mkDerivation.buildFlags

This option has no description.

Type: null or (list of anything)

Default: null

Declared by:

mkDerivation.buildInputs

This option has no description.

Type: null or (list of anything)

Default: null

Declared by:

mkDerivation.buildPhase

This option has no description.

Type: null or string

Default: null

Declared by:

mkDerivation.builder

This option has no description.

Type: null or string or path or package or (submodule)

Default: null

Declared by:

mkDerivation.checkFlags

This option has no description.

Type: null or (list of anything)

Default: null

Declared by:

mkDerivation.checkInputs

This option has no description.

Type: null or (list of anything)

Default: null

Declared by:

mkDerivation.checkPhase

This option has no description.

Type: null or string

Default: null

Declared by:

mkDerivation.checkTarget

This option has no description.

Type: null or string

Default: null

Declared by:

mkDerivation.cmakeFlags

This option has no description.

Type: null or (list of anything)

Default: null

Declared by:

mkDerivation.configureFlags

This option has no description.

Type: null or (list of anything)

Default: null

Declared by:

mkDerivation.configurePhase

This option has no description.

Type: null or string

Default: null

Declared by:

mkDerivation.configurePlatforms

This option has no description.

Type: null or (list of anything)

Default: null

Declared by:

mkDerivation.configureScript

This option has no description.

Type: null or string

Default: null

Declared by:

mkDerivation.depsBuildBuild

This option has no description.

Type: null or (list of anything)

Default: null

Declared by:

mkDerivation.depsBuildBuildPropagated

This option has no description.

Type: null or (list of anything)

Default: null

Declared by:

mkDerivation.depsBuildTarget

This option has no description.

Type: null or (list of anything)

Default: null

Declared by:

mkDerivation.depsBuildTargetPropagated

This option has no description.

Type: null or (list of anything)

Default: null

Declared by:

mkDerivation.depsHostHost

This option has no description.

Type: null or (list of anything)

Default: null

Declared by:

mkDerivation.depsHostHostPropagated

This option has no description.

Type: null or (list of anything)

Default: null

Declared by:

mkDerivation.depsTargetTarget

This option has no description.

Type: null or (list of anything)

Default: null

Declared by:

mkDerivation.depsTargetTargetPropagated

This option has no description.

Type: null or (list of anything)

Default: null

Declared by:

mkDerivation.disallowedReferences

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

mkDerivation.disallowedRequisites

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

mkDerivation.distFlags

This option has no description.

Type: null or (list of anything)

Default: null

Declared by:

mkDerivation.distPhase

This option has no description.

Type: null or string

Default: null

Declared by:

mkDerivation.distTarget

This option has no description.

Type: null or string

Default: null

Declared by:

mkDerivation.doCheck

This option has no description.

Type: null or boolean

Default: null

Declared by:

mkDerivation.doDist

This option has no description.

Type: null or boolean

Default: null

Declared by:

mkDerivation.doInstallCheck

This option has no description.

Type: null or boolean

Default: null

Declared by:

mkDerivation.dontAddDisableDepTrack

This option has no description.

Type: null or boolean

Default: null

Declared by:

mkDerivation.dontAddPrefix

This option has no description.

Type: null or boolean

Default: null

Declared by:

mkDerivation.dontAddStaticConfigureFlags

This option has no description.

Type: null or boolean

Default: null

Declared by:

mkDerivation.dontBuild

This option has no description.

Type: null or boolean

Default: null

Declared by:

mkDerivation.dontConfigure

This option has no description.

Type: null or boolean

Default: null

Declared by:

mkDerivation.dontCopyDist

This option has no description.

Type: null or boolean

Default: null

Declared by:

mkDerivation.dontDisableStatic

This option has no description.

Type: null or boolean

Default: null

Declared by:

mkDerivation.dontFixLibtool

This option has no description.

Type: null or boolean

Default: null

Declared by:

mkDerivation.dontFixup

This option has no description.

Type: null or boolean

Default: null

Declared by:

mkDerivation.dontInstall

This option has no description.

Type: null or boolean

Default: null

Declared by:

mkDerivation.dontMakeSourcesWritable

This option has no description.

Type: null or boolean

Default: null

Declared by:

mkDerivation.dontMoveBin

This option has no description.

Type: null or boolean

Default: null

Declared by:

mkDerivation.dontPatch

This option has no description.

Type: null or boolean

Default: null

Declared by:

mkDerivation.dontPatchELF

This option has no description.

Type: null or boolean

Default: null

Declared by:

mkDerivation.dontPatchShebangs

This option has no description.

Type: null or boolean

Default: null

Declared by:

mkDerivation.dontPruneLibtoolFiles

This option has no description.

Type: null or boolean

Default: null

Declared by:

mkDerivation.dontStrip

This option has no description.

Type: null or boolean

Default: null

Declared by:

mkDerivation.dontStripHost

This option has no description.

Type: null or boolean

Default: null

Declared by:

mkDerivation.dontStripTarget

This option has no description.

Type: null or boolean

Default: null

Declared by:

mkDerivation.dontUnpack

This option has no description.

Type: null or boolean

Default: null

Declared by:

mkDerivation.exportReferenceGraph

This option has no description.

Type: null or (list of (string or package))

Default: null

Declared by:

mkDerivation.fixupPhase

This option has no description.

Type: null or string

Default: null

Declared by:

mkDerivation.forceShare

This option has no description.

Type: null or (list of anything)

Default: null

Declared by:

mkDerivation.hardeningDisable

This option has no description.

Type: null or (list of anything)

Default: null

Declared by:

mkDerivation.hardeningEnable

This option has no description.

Type: null or (list of anything)

Default: null

Declared by:

mkDerivation.impureEnvVars

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

mkDerivation.installCheckFlags

This option has no description.

Type: null or (list of anything)

Default: null

Declared by:

mkDerivation.installCheckInputs

This option has no description.

Type: null or (list of anything)

Default: null

Declared by:

mkDerivation.installCheckPhase

This option has no description.

Type: null or string

Default: null

Declared by:

mkDerivation.installCheckTarget

This option has no description.

Type: null or string

Default: null

Declared by:

mkDerivation.installFlags

This option has no description.

Type: null or (list of anything)

Default: null

Declared by:

mkDerivation.installPhase

This option has no description.

Type: null or string

Default: null

Declared by:

mkDerivation.installTargets

This option has no description.

Type: null or string

Default: null

Declared by:

mkDerivation.makeFlags

This option has no description.

Type: null or (list of anything)

Default: null

Declared by:

mkDerivation.makefile

This option has no description.

Type: null or string

Default: null

Declared by:

mkDerivation.mesonFlags

This option has no description.

Type: null or (list of anything)

Default: null

Declared by:

mkDerivation.meta

This option has no description.

Type: null or (attribute set)

Default: { }

Declared by:

mkDerivation.nativeBuildInputs

This option has no description.

Type: null or (list of anything)

Default: null

Declared by:

mkDerivation.nativeCheckInputs

This option has no description.

Type: null or (list of anything)

Default: null

Declared by:

mkDerivation.outputHash

This option has no description.

Type: null or string

Default: null

Declared by:

mkDerivation.outputHashAlgo

This option has no description.

Type: null or string

Default: null

Declared by:

mkDerivation.outputHashMode

This option has no description.

Type: null or string

Default: null

Declared by:

mkDerivation.outputs

This option has no description.

Type: null or (list of string)

Default:

[
  "out"
]

Declared by:

mkDerivation.passAsFile

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

mkDerivation.passthru

This option has no description.

Type: null or (attribute set)

Default: { }

Declared by:

mkDerivation.patchFlags

This option has no description.

Type: null or string

Default: null

Declared by:

mkDerivation.patchPhase

This option has no description.

Type: null or string

Default: null

Declared by:

mkDerivation.patches

This option has no description.

Type: null or (list of anything)

Default: null

Declared by:

mkDerivation.phases

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

mkDerivation.pos

This option has no description.

Type: null or (attribute set)

Default: { }

Declared by:

mkDerivation.postBuild

This option has no description.

Type: null or string

Default: null

Declared by:

mkDerivation.postCheck

This option has no description.

Type: null or string

Default: null

Declared by:

mkDerivation.postConfigure

This option has no description.

Type: null or string

Default: null

Declared by:

mkDerivation.postDist

This option has no description.

Type: null or string

Default: null

Declared by:

mkDerivation.postFixup

This option has no description.

Type: null or string

Default: null

Declared by:

mkDerivation.postInstalCheck

This option has no description.

Type: null or string

Default: null

Declared by:

mkDerivation.postInstall

This option has no description.

Type: null or string

Default: null

Declared by:

mkDerivation.postPatch

This option has no description.

Type: null or string

Default: null

Declared by:

mkDerivation.postPhases

This option has no description.

Type: null or (list of anything)

Default: null

Declared by:

mkDerivation.postUnpack

This option has no description.

Type: null or string

Default: null

Declared by:

mkDerivation.preBuild

This option has no description.

Type: null or string

Default: null

Declared by:

mkDerivation.preBuildPhases

This option has no description.

Type: null or (list of anything)

Default: null

Declared by:

mkDerivation.preCheck

This option has no description.

Type: null or string

Default: null

Declared by:

mkDerivation.preConfigure

This option has no description.

Type: null or string

Default: null

Declared by:

mkDerivation.preConfigurePhases

This option has no description.

Type: null or (list of anything)

Default: null

Declared by:

mkDerivation.preDist

This option has no description.

Type: null or string

Default: null

Declared by:

mkDerivation.preDistPhases

This option has no description.

Type: null or (list of anything)

Default: null

Declared by:

mkDerivation.preFixup

This option has no description.

Type: null or string

Default: null

Declared by:

mkDerivation.preFixupPhases

This option has no description.

Type: null or (list of anything)

Default: null

Declared by:

mkDerivation.preInstall

This option has no description.

Type: null or string

Default: null

Declared by:

mkDerivation.preInstallCheck

This option has no description.

Type: null or string

Default: null

Declared by:

mkDerivation.preInstallPhases

This option has no description.

Type: null or (list of anything)

Default: null

Declared by:

mkDerivation.prePatch

This option has no description.

Type: null or string

Default: null

Declared by:

mkDerivation.prePhases

This option has no description.

Type: null or (list of anything)

Default: null

Declared by:

mkDerivation.preUnpack

This option has no description.

Type: null or string

Default: null

Declared by:

mkDerivation.preferLocalBuild

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

mkDerivation.prefix

This option has no description.

Type: null or string

Default: null

Declared by:

mkDerivation.prefixKey

This option has no description.

Type: null or string

Default: null

Declared by:

mkDerivation.propagatedBuildInputs

This option has no description.

Type: null or (list of anything)

Default: null

Declared by:

mkDerivation.propagatedNativeBuildInputs

This option has no description.

Type: null or (list of anything)

Default: null

Declared by:

mkDerivation.propagatedSandboxProfile

This option has no description.

Type: null or string

Default: null

Declared by:

mkDerivation.realBuilder

This option has no description.

Type: null or string or path or package or (submodule)

Default: null

Declared by:

mkDerivation.requiredSystemFeatures

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

mkDerivation.sandboxProfile

This option has no description.

Type: null or string

Default: null

Declared by:

mkDerivation.separateDebugInfo

This option has no description.

Type: null or boolean

Default: null

Declared by:

mkDerivation.setSourceRoot

This option has no description.

Type: null or string

Default: null

Declared by:

mkDerivation.setupHook

This option has no description.

Type: null or string or path or package or (submodule)

Default: null

Declared by:

mkDerivation.shellHook

This option has no description.

Type: null or string

Default: null

Declared by:

mkDerivation.sourceRoot

This option has no description.

Type: null or string or path or package or (submodule)

Default: null

Declared by:

mkDerivation.src

This option has no description.

Type: null or string or path or package or (submodule)

Default: null

Declared by:

mkDerivation.srcs

This option has no description.

Type: null or (list of (string or path or package))

Default: null

Declared by:

mkDerivation.strictDeps

This option has no description.

Type: null or boolean

Default: null

Declared by:

mkDerivation.stripAllFlags

This option has no description.

Type: null or (list of anything)

Default: null

Declared by:

mkDerivation.stripAllList

This option has no description.

Type: null or (list of anything)

Default: null

Declared by:

mkDerivation.stripDebugFlags

This option has no description.

Type: null or (list of anything)

Default: null

Declared by:

mkDerivation.stripDebugList

This option has no description.

Type: null or (list of anything)

Default: null

Declared by:

mkDerivation.tarballs

This option has no description.

Type: null or (list of anything)

Default: null

Declared by:

mkDerivation.unpackCmd

This option has no description.

Type: null or string

Default: null

Declared by:

mkDerivation.unpackPhase

This option has no description.

Type: null or string

Default: null

Declared by:

mkDerivation.version

This option has no description.

Type: null or string

Default: null

Declared by:

name

The name of the package

Type: string

Declared by:

paths.package

Path to the directory containing the definition of the current package. Relative to ‘paths.projectRoot’.

This helps locating package definitions for lock & update scripts.

Type: path or string

Declared by:

paths.cacheFile

Path to the eval cache file of the current package. Relative to “${paths.projectRoot}/${paths.package}”".

Type: string

Default: "cache.json"

Declared by:

paths.lockFile

Path to the lock file of the current package. Relative to “${paths.projectRoot}/${paths.package}”".

Type: string

Default: "lock.json"

Declared by:

paths.projectRoot

Path to the root of the project on which dream2nix operates. Must contain the marker file specified by ‘paths.projectRootFile’

This helps locating lock files at evaluation time.

Type: path

Example: ./.

Declared by:

paths.projectRootFile

File name to look for to determine the root of the project. Ensure ‘paths.projectRoot’ contains a file named like this.

This helps locating package definitions for lock & update scripts.

Type: string

Default: ".git"

Example: ".git"

Declared by:

php-composer-lock.composerJson

The content of the composer.json

Type: attribute set

Declared by:

php-composer-lock.composerJsonFile

The composer.json file to use.

Type: path

Default:

''
  ''${cfg.source}/composer.json
''

Declared by:

php-composer-lock.composerLock

The content of the composer.lock

Type: attribute set

Declared by:

php-composer-lock.composerLockFile

The composer.lock file to use.

Type: null or path

Default:

''
  ''${cfg.source}/composer.lock
''

Declared by:

php-composer-lock.source

Source of the package

Type: path or package

Declared by:

php-composer-lock.withDevDependencies

Whether to include development dependencies. Usually it’s a bad idea to disable this, as development dependencies can contain important build time dependencies.

Type: boolean

Default: true

Declared by:

public

The final result of the evaluated package. Contains everything that nix expects from a derivation. Contains fields like name, outputs, drvPath, outPath, etc. Can be build with nix-build or nix build.

Type: lazy attribute set of anything

Declared by:

public.docs

The manual of the package as a website

Type: package (read only)

Declared by:

version

The version of the package

Type: string

Declared by: