Skip to content
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.

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

nixos: Data module imports #96641

Merged
merged 2 commits into from Oct 9, 2020
Merged

nixos: Data module imports #96641

merged 2 commits into from Oct 9, 2020

Conversation

@zimbatm
Copy link
Member

@zimbatm zimbatm commented Aug 29, 2020

Motivation for this change

This extends the capabilities of NixOS modules to be able to import JSON or TOML configurations :)

Things done
  • Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS linux)
  • Built on platform(s)
    • NixOS
    • macOS
    • other Linux distributions
  • Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)
  • Tested compilation of all pkgs that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review wip"
  • Tested execution of all binary files (usually in ./result/bin/)
  • Determined the impact on package closure size (by running nix path-info -S before and after)
  • Ensured that relevant documentation is up to date
  • Fits CONTRIBUTING.md.
@Infinisil
Copy link
Member

@Infinisil Infinisil commented Aug 30, 2020

I don't like the idea of adding such implicit behavior. How about an explicit usage like this instead:

{ lib, ... }: {
  imports = [
    (lib.modules.fromJSON ./path/to.json)
  ];
}

Which would be implemented like

{
  fromJSON = file: {
    _file = file;
    config = importJSON file;
  };
}

zimbatm added 2 commits Sep 12, 2020
Complements the `lib.importJSON`. `builtins.readTOML` has been
introduced in Nix 2.1.
The vision here is that configuration tools can generate .json or .toml
files, which can be plugged into an existing configuration.

Eg:

    { lib, ... }:
    {
      imports = [
        (lib.modules.importJSON ./hardware-configuration.json)
      ];
    }
@zimbatm zimbatm force-pushed the data-module-imports branch from ffb27e7 to 035627d Sep 12, 2020
@zimbatm
Copy link
Member Author

@zimbatm zimbatm commented Sep 12, 2020

Great idea @Infinisil . Updated!

@zimbatm zimbatm merged commit d8e4c8e into NixOS:master Oct 9, 2020
16 checks passed
@zimbatm zimbatm deleted the data-module-imports branch Oct 9, 2020
@nixos-discourse
Copy link

@nixos-discourse nixos-discourse commented Jul 2, 2021

This pull request has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/having-a-go-at-using-toml-to-configure-nixos/13897/1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

3 participants