Check project types

[eljamm]

Ideally, we'd only evaluate the modules without building anything.

Continuation of #991

[fricklerhandwerk]

This must be a path, since we need to render it in documentation. Can't render an expression

[eljamm]

With pathInStore:

nix-repl> :p evaluated-modules.config.projects.Omnom.nixos.services.omnom.examples.base.module
error:
       … while evaluating the attribute 'value'
         at /nix/store/qmm7hgw60vp7vj9lma95hl329d0j3n6n-source/lib/modules.nix:1084:7:
         1083|     // {
         1084|       value = addErrorContext "while evaluating the option `${showOption loc}':" value;
             |       ^
         1085|       inherit (res.defsFinal') highestPrio;

       … while calling the 'addErrorContext' builtin
         at /nix/store/qmm7hgw60vp7vj9lma95hl329d0j3n6n-source/lib/modules.nix:1084:15:
         1083|     // {
         1084|       value = addErrorContext "while evaluating the option `${showOption loc}':" value;
             |               ^
         1085|       inherit (res.defsFinal') highestPrio;

       (stack trace truncated; use '--show-trace' to show the full trace)

       error: A definition for option `projects.Omnom.nixos.services.omnom.examples.base.module' is not of type `path in the Nix store'. Definition values:
       - In `<unknown-file>': /home/user/ngipkgs/projects/Omnom/example.nix

with deferredModule:

nix-repl> :p evaluated-modules.config.projects.Omnom.nixos.services.omnom.examples.base.module
{
  imports = [
    {
      _file = "<unknown-file>, via option projects.Omnom.nixos.services.omnom.examples.base.module";
      imports = [ /home/user/ngipkgs/projects/Omnom/example.nix ];
    }
  ];
}

Still, the module isn't being rendered in the overview in both cases, AFAIK.

[fricklerhandwerk]

What about just path then?

[eljamm]

What about just path then?

That works, but it means we can't do something like this anymore

[fricklerhandwerk]

Hm but that link shows an actual module, not an example

[eljamm]

I meant that by using path all modules will need to be stored in files and we won't be able to declare them like that.

[fricklerhandwerk]

Yeah and that's alright. We require them as a string in a file for documentation, that's how it is.

[eljamm]

To check the module types for a project, run:

nix build .#checks.x86_64-linux.projects/<PROJECT_NAME>/nixos/check

For example:

nix build .#checks.x86_64-linux.projects/Omnom/nixos/check

Wrong types

  metadata = {
    summary = "Omnom is a webpage bookmarking and snapshotting service.";
    subgrants = [
      "omnom"
      "omnom-ActivityPub"
      123123 # <----
    ];
  };

 error: A definition for option `projects.Omnom.metadata.subgrants."[definition 1-entry 3]"' is not of type `string'. Definition values:
 - In `<unknown-file>': 123123

  examples.base = {
    module = ""; # <----
    description = "Basic Omnom configuration, mainly used for testing purposes";
    tests.basic = null;
  };

 error: A definition for option `projects.Omnom.nixos.services.omnom.examples.base.module' is not of type `module'. Definition values:
 - In `<unknown-file>': ""

Missing attributes

  examples.base = {
    module = ./example.nix;
    description = "Basic Omnom configuration, mainly used for testing purposes";
    # tests.basic = null; # <----
  };

 error: The option `projects.Omnom.nixos.services.omnom.examples.base.tests' was accessed but has no value defined. Try setting the option.

Extra/Undefined attributes

  examples.base = {
    module = ./example.nix;
    description = "Basic Omnom configuration, mainly used for testing purposes";
    tests.basic = null;
    hello = "world"; # <----
  };

 error: The option `projects.Omnom.nixos.services.omnom.examples.base.hello' does not exist. Definition values:
 - In `<unknown-file>': "world"

[eljamm]

I've split off a few fixes to a separate PR and dropped the treewide renaming of nixos.modules.{services,projects} to nixos.{services,projects} as that was breaking a few things. I think it would be better to look into doing that properly, later.