[Nix#9865] Provide suggestions in error messages for getAttr #64

New issue

Open

opened 2024-03-16 06:44:43 +00:00 by lix-bot · 2 comments

lix-bot commented

2024-03-16 06:44:43 +00:00

Member

Upstream-Issue: NixOS/nix#9865

Is your feature request related to a problem? Please describe.

Errors involving installables or names explicitly lexically appearing in Nix code, including using the CLI for non-flakes purposes, provide name suggestions for attributes:

 » nix eval -f '<nixpkgs>' lib.f1x                                           
error: attribute 'f1x' in selection path 'lib.f1x' not found
       Did you mean one of fix, fix' or max?

However, this is not the case in dynamically getting attributes, which can be annoying when the offending string came from the user somehow.

co/nix » ./outputs/out/bin/nix --extra-experimental-features 'nix-command' eval -f '<nixpkgs>' --apply 'x: with x {}; builtins.getAttr "f1x" lib'
error:
       … while calling the 'getAttr' builtin
         at «string»:1:15:
            1| x: with x {}; builtins.getAttr "f1x" lib
             |               ^

       … in the attribute set under consideration

       error: attribute 'f1x' missing

Describe the solution you'd like

I would like to have getAttr try to provide suggestions for the intended attributes.

Describe alternatives you've considered

Well, we can simply make it appear lexically in Nix code, which would make everyone supremely happy I anticipate :)

nix-repl> import (builtins.toFile "test.nix" "x: x.f1x") lib 
error: attribute 'f1x' missing

       at /nix/store/nlcfifyf5b7vizi722dsjvzshvpfd1d7-test.nix:1:4:

            1| x: x.f1x
             |    ^
       Did you mean one of fix, fix' or max?

Additional context

Tested in 1c260fa6d1f47d83954792771d0614db163cc3bc.

Priorities

Add 👍 to issues you find important.

Upstream-Issue: https://git.lix.systems/NixOS/nix/issues/9865 **Is your feature request related to a problem? Please describe.** Errors involving installables or names explicitly lexically appearing in Nix code, including using the CLI for non-flakes purposes, provide name suggestions for attributes: ``` » nix eval -f '<nixpkgs>' lib.f1x error: attribute 'f1x' in selection path 'lib.f1x' not found Did you mean one of fix, fix' or max? ``` However, this is not the case in dynamically getting attributes, which can be annoying when the offending string came from the user somehow. ``` co/nix » ./outputs/out/bin/nix --extra-experimental-features 'nix-command' eval -f '<nixpkgs>' --apply 'x: with x {}; builtins.getAttr "f1x" lib' error: … while calling the 'getAttr' builtin at «string»:1:15: 1| x: with x {}; builtins.getAttr "f1x" lib | ^ … in the attribute set under consideration error: attribute 'f1x' missing ``` **Describe the solution you'd like** I would like to have getAttr try to provide suggestions for the intended attributes. **Describe alternatives you've considered** Well, we can simply make it appear lexically in Nix code, which would make everyone supremely happy I anticipate :) ``` nix-repl> import (builtins.toFile "test.nix" "x: x.f1x") lib error: attribute 'f1x' missing at /nix/store/nlcfifyf5b7vizi722dsjvzshvpfd1d7-test.nix:1:4: 1| x: x.f1x | ^ Did you mean one of fix, fix' or max? ``` **Additional context** Tested in 1c260fa6d1f47d83954792771d0614db163cc3bc. **Priorities** Add :+1: to [issues you find important](https://github.com/NixOS/nix/issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc).

lix-bot added the

imported

label

2024-03-16 06:44:43 +00:00

lix-project referenced this issue from a commit

2025-01-29 18:11:12 +00:00

Merge pull request #64 from nix-community/dotted-attrs

jade added the

Area/evaluator

labels

2025-02-14 08:43:18 +00:00

jade added this to the Error reporting project

2025-02-14 08:43:32 +00:00

jade commented

2025-03-10 19:05:27 +00:00

Owner

This is important to being able to make a flakey-profile based nix-env replacement! :)

Likely not dissimilar to what flox does, but we probably don't want the entirety of flox for this.

This is important to being able to make a flakey-profile based nix-env replacement! :) Likely not dissimilar to what flox does, but we probably don't want the entirety of flox for this.

lix-bot commented

2025-05-09 23:08:17 +00:00

Author

Member

This issue was mentioned on Gerrit on the following CLs:

commit message in cl/3110 ("builtins.getAttr: give suggestions in error messages")

This issue was mentioned on Gerrit on the following CLs: * commit message in [cl/3110](https://gerrit.lix.systems/c/lix/+/3110) ("builtins.getAttr: give suggestions in error messages")