Options
app
The app
Type: raw value
appNixpkgs
Nixpkgs configuration for app
Type: nixpkgs config
check
The check
Type: raw value
checkNixpkgs
Nixpkgs configuration for check
Type: nixpkgs config
defaultApp
Whether to set this as the default app
Type: boolean
Default: false
defaultCheck
Whether to set this as the default check
Type: boolean
Default: false
defaultDevShell
Whether to set this as the default devShell
Type: boolean
Default: false
defaultFormatter
Whether to set this as the default formatter
Type: boolean
Default: false
defaultLegacyPackage
Whether to set this as the default legacyPackage
Type: boolean
Default: false
defaultNixosConfiguration
Whether to set this as the default nixosConfiguration
Type: boolean
Default: false
defaultNixosModule
Whether to set this as the default nixosModule
Type: boolean
Default: false
defaultPackage
Whether to set this as the default package
Type: boolean
Default: false
devShell
The devShell
Type: raw value
devShellNixpkgs
Nixpkgs configuration for devShell
Type: nixpkgs config
docTestsAsChecks
Convert all "perch.lib.docs.function" tests to checks
Type: boolean
Default: false
dummy.attrsOfSubmodule
Dummy option to test attrs of option flattening.
Type: attribute set of (submodule)
Default: { }
dummy.attrsOfSubmodule.<name>.suboption
Dummy suboption to test attrs of option flattening.
Type: string
Default: ""
Example: test test test
dummy.listOfSubmodule
Dummy option to test list of option flattening.
Type: list of (submodule)
Default: { }
dummy.listOfSubmodule.*.suboption
- Read-only
Dummy suboption to test list of option flattening.
Type: string
Default: ""
dummy.submodule
Dummy option to test direct option flattening.
Type: submodule
Default: { }
dummy.submodule.suboption
Dummy suboption to test direct option flattening.
Type: string
Default:
(x: builtins.trace x x) "hello world :)"
eval.allowedArgs
List of allowed argument names for module evaluation
Type: list of string
Default: [ ]
eval.privateConfig
Private configuration paths not exposed in output flake modules
Type: list of list of string
Default: [ ]
eval.publicConfig
Public configuration paths are exposed in output flake modules
Type: list of list of string
Default: [ ]
flake.apps
Attribute set of all apps in the flake
Type: attribute set of (attribute set)
flake.checks
Attribute set of all checks in the flake
Type: attribute set of (attribute set)
flake.config
Evaluated flake config attrset
Type: raw value
Default: { }
flake.devShells
Attribute set of all devShells in the flake
Type: attribute set of (attribute set)
flake.formatter
Attribute set of all formatter in the flake
Type: attribute set
flake.legacyPackages
Attribute set of all legacyPackages in the flake
Type: attribute set of (attribute set)
flake.lib
Attribute set of all library functions in the flake
Type: nested attribute set of raw value
Default: { }
flake.modules
Modules prepared for use in other flakes
Type: attribute set of module
Default: { }
flake.nixosConfigurations
Attribute set of all nixosConfigurations in the flake
Type: attribute set
flake.nixosModules
Attribute set of all nixosModules in the flake
Type: attribute set
flake.options
Evaluated flake options attrset
Type: raw value
Default: { }
flake.overlays
Attribute set of all overlays in the flake
Type: attribute set of (nixpkgs overlay)
Default: { }
flake.packages
Attribute set of all packages in the flake
Type: attribute set of (attribute set)
flakeTests.args
Additional arguments for "nix flake check"
Type: list of string
Default:
[
"--override-input"
"self'"
(builtins.toString (
builtins.path {
path = config.flakeTests.root;
name = "self-prime";
}
))
]
flakeTests.asApps
Aggregate checks of flakes from a specified path to apps in this flake
Type: boolean
Default: false
flakeTests.asChecks
Aggregate checks of flakes from a specified path to checks in this flake
IMPORTANT: this will require the recursive-nix feature which will most likely fail due to a current regression in nix (nixpkgs issue 14529)
Type: boolean
Default: false
flakeTests.asPackages
Aggregate checks of flakes from a specified path to packages in this flake
Type: boolean
Default: false
flakeTests.commands
Extra commands to run for each flake during flake testing
Type: list of string
Default: [ ]
flakeTests.path
Path to test flakes
Type: absolute path
Default:
lib.path.append config.flakeTests.root config.flakeTests.prefix
flakeTests.prefix
The prefix from the root at which test flakes are located
Type: string
Default: "test"
flakeTests.root
The root of the repository used to get test flakes and to set "self'" input
Type: absolute path
Default:
specialArgs.root
formatter
The formatter
Type: raw value
formatterNixpkgs
Nixpkgs configuration for formatter
Type: nixpkgs config
legacyPackage
The legacyPackage
Type: raw value
legacyPackageNixpkgs
Nixpkgs configuration for legacyPackage
Type: nixpkgs config
nixosConfiguration
The module result for nixosConfiguration
Type: raw value
nixosConfigurationNixpkgs
Nixpkgs configuration for nixosConfiguration
Type: nixpkgs config
nixosModule
Result of the nixosModule
Type: attribute set
overlays
Attribute set of all overlays in the flake
Type: attribute set of (nixpkgs overlay)
Default: { }
package
The package
Type: raw value
packageNixpkgs
Nixpkgs configuration for package
Type: nixpkgs config
packagesAsApps
Convert all packages to apps and put them in flake outputs
Type: boolean
Default: false
packagesAsLegacyPackages
Convert all packages to legacy packages and put them in flake outputs
Type: boolean
Default: false
traceDocTestsInChecks
Whether to trace successful passes of library tests in checks
Type: boolean
Default: false