Skip to content

Update to latest flake-schemas #388

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
edolstra merged 3 commits into from
Mar 18, 2026
Merged

Update to latest flake-schemas #388

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
50c3cc2
Update to latest flake-schemas
edolstra Mar 18, 2026
825f8b0
nix develop: Fix assertion failure if outputs attribute is missing
edolstra Mar 18, 2026
3594a9c
Add tests for devShells and devShell
edolstra Mar 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
105 changes: 74 additions & 31 deletions src/libcmd/builtin-flake-schemas.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,34 @@
in
builtins.isAttrs module || builtins.isFunction module;

mkApp = system: app: {
forSystems = [ system ];
evalChecks.isValidApp =
app ? type
&& app.type == "app"
&& app ? program
&& builtins.isString app.program
&&
builtins.removeAttrs app [
"type"
"program"
"meta"
] == { };
what = "app";
shortDescription = app.meta.description or "";
};

mkPackage = isFlakeCheck: what: system: package: {
forSystems = [ system ];
shortDescription = package.meta.description or "";
derivationAttrPath = [ ];
inherit what isFlakeCheck;
};

singleDerivationInventory =
what: isFlakeCheck: output:
self.lib.mkChildren (builtins.mapAttrs (mkPackage isFlakeCheck what) output);

schemasSchema = {
version = 1;
doc = ''
Expand Down Expand Up @@ -46,33 +74,24 @@
inventory =
output:
self.lib.mkChildren (
builtins.mapAttrs (
system: apps:
let
forSystems = [ system ];
in
{
inherit forSystems;
children = builtins.mapAttrs (appName: app: {
inherit forSystems;
evalChecks.isValidApp =
app ? type
&& app.type == "app"
&& app ? program
&& builtins.isString app.program
&&
builtins.removeAttrs app [
"type"
"program"
"meta"
] == { };
what = "app";
}) apps;
}
) output
builtins.mapAttrs (system: apps: {
forSystems = [ system ];
children = builtins.mapAttrs (appName: app: mkApp system app) apps;
}) output
);
};

defaultAppSchema = {
version = 1;
doc = ''
**DEPRECATED**. Use `apps.<system>.default` instead.
'';
roles.nix-run = { };
appendSystem = true;
defaultAttrPath = [ ];
inventory = output: self.lib.mkChildren (builtins.mapAttrs mkApp output);
};

packagesSchema = {
version = 1;
doc = ''
Expand All @@ -87,6 +106,20 @@
inventory = self.lib.derivationsInventory "package" false;
};

defaultPackageSchema = {
version = 1;
doc = ''
**DEPRECATED**. Use `packages.<system>.default` instead.
'';
roles.nix-build = { };
roles.nix-run = { };
roles.nix-develop = { };
roles.nix-search = { };
appendSystem = true;
defaultAttrPath = [ ];
inventory = singleDerivationInventory "package" false;
};

ociImagesSchema = {
version = 1;
doc = ''
Expand Down Expand Up @@ -167,6 +200,17 @@
inventory = self.lib.derivationsInventory "development environment" false;
};

devShellSchema = {
version = 1;
doc = ''
**DEPRECATED**. Use `devShells.<system>.default` instead.
'';
roles.nix-develop = { };
appendSystem = true;
defaultAttrPath = [ ];
inventory = singleDerivationInventory "development environment" false;
};

formatterSchema = {
version = 1;
doc = ''
Expand Down Expand Up @@ -410,24 +454,23 @@
self.lib.mkChildren (
builtins.mapAttrs (systemType: packagesForSystem: {
forSystems = [ systemType ];
children = builtins.mapAttrs (packageName: package: {
forSystems = [ systemType ];
shortDescription = package.meta.description or "";
derivationAttrPath = [ ];
inherit what;
isFlakeCheck = isFlakeCheck;
}) packagesForSystem;
children = builtins.mapAttrs (
packageName: mkPackage isFlakeCheck what systemType
) packagesForSystem;
}) output
);
};

# FIXME: distinguish between available and active schemas?
schemas.schemas = schemasSchema;
schemas.apps = appsSchema;
schemas.defaultApp = defaultAppSchema;
schemas.packages = packagesSchema;
schemas.defaultPackage = defaultPackageSchema;
schemas.legacyPackages = legacyPackagesSchema;
schemas.checks = checksSchema;
schemas.devShells = devShellsSchema;
schemas.devShell = devShellSchema;
schemas.formatter = formatterSchema;
schemas.templates = templatesSchema;
schemas.hydraJobs = hydraJobsSchema;
Expand Down
3 changes: 3 additions & 0 deletions src/libcmd/installable-flake.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,8 +167,11 @@ std::vector<AttrPath> InstallableFlake::getAttrPaths(bool useDefaultAttrPath, re
}
};
doSchema("apps");
doSchema("defaultApp");
doSchema("devShells");
doSchema("devShell");
doSchema("packages");
doSchema("defaultPackage");
doSchema("legacyPackages");
for (auto & schema : schemas)
if (!schemasSeen.contains(schema.first))
Expand Down
3 changes: 2 additions & 1 deletion src/nix/develop.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -388,7 +388,8 @@ struct Common : InstallableCommand, MixProfile

/* Substitute occurrences of output paths. */
auto outputs = buildEnvironment.vars.find("outputs");
assert(outputs != buildEnvironment.vars.end());
if (outputs == buildEnvironment.vars.end())
throw Error("derivation does not have an 'outputs' attribute");

StringMap rewrites;
if (buildEnvironment.providesStructuredAttrs()) {
Expand Down
1 change: 1 addition & 0 deletions tests/functional/config.nix.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ rec {
eval "$buildCommand"
'')];
PATH = path;
outputs = args.outputs or [ "out" ];
} // caArgs // optionalAttrs (builtins ? derivationWithMeta) {
__meta = removeAttrs (args.meta or {}) ["position"];
} // removeAttrs args ["builder" "meta"])
Expand Down
31 changes: 31 additions & 0 deletions tests/functional/flakes/develop.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,3 +161,34 @@ EOF
[[ -z "$(nix develop --no-write-lock-file .#hello-structured </dev/null)" ]]

clearStore

# Check that devShells has precedence over devShell and packages. Note that devShell is deprecated.
cat <<EOF >"$TEST_HOME/flake.nix"
{
inputs.nixpkgs.url = "$TEST_HOME/nixpkgs";
outputs = {self, nixpkgs}: {
devShells.$system.default = (import ./config.nix).mkDerivation {
name = "hello";
buildCommand = "set -x; mkdir \$out";
x = "foo";
};
devShell.$system = (import ./config.nix).mkDerivation {
name = "hello";
buildCommand = "set -x; mkdir \$out";
x = "bar";
};
packages.$system.default = (import ./config.nix).mkDerivation {
name = "hello";
buildCommand = "set -x; mkdir \$out";
x = "xyzzy";
};
};
}
EOF

[[ $(nix develop . -L --command sh -c "echo \$x") == "foo" ]]
[[ $(nix develop ".#devShell.$system" -L --command sh -c "echo \$x") == "bar" ]]
sed -i "$TEST_HOME/flake.nix" -e 's/devShells/devShells2/' # remove devShells
[[ $(nix develop . -L --command sh -c "echo \$x") == "bar" ]]
sed -i "$TEST_HOME/flake.nix" -e 's/devShell/devShell2/' # remove devShell
[[ $(nix develop . -L --command sh -c "echo \$x") == "xyzzy" ]]
2 changes: 1 addition & 1 deletion tests/functional/flakes/dubious-query.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ expectStderr 0 nix --offline build --dry-run "git+file://$repoDir?bar#foo" \

# Check that the anchor (#) is taken as a whole, not split, and throws an error.
expectStderr 1 nix --offline build --dry-run "git+file://$repoDir#foo?bar" \
| grepQuiet "error: flake 'git+file://$repoDir' does not provide attribute 'packages.$system.foo?bar', 'legacyPackages.$system.foo?bar' or 'foo?bar'"
| grepQuiet "error: flake 'git+file://$repoDir' does not provide attribute 'packages.$system.foo?bar', 'defaultPackage.$system.foo?bar', 'legacyPackages.$system.foo?bar' or 'foo?bar'"

# Check that a literal `?` in the query doesn't print dubious query warning.
expectStderr 0 nix --offline build --dry-run "git+file://$repoDir?#foo" \
Expand Down
Loading