Distributing an overlay with nur

[mpickering]

I have recently released a project I would like to distribute in a NUR like manner.

https://github.com/mpickering/haskell-nix-plugin

It is currently packaged as an overlay. The intended usage is something like..

let
  plugin-overlay-git = builtins.fetchGit
   { url = https://github.com/mpickering/haskell-nix-plugin.git;}  ;
  plugin-overlay = import "${plugin-overlay-git}/overlay.nix";
  nixpkgs = import <nixpkgs> { overlays = [plugin-overlay]; };

  hl = nixpkgs.haskell.lib;
  hp = nixpkgs.haskellPackages;
in
  (hp.withPlugin(plugs: ps: hl.addPlugin plugs.dump-core ps.either)).DumpCore

Could I instead add the "overlay" to NUR and a user would instead write,

let
  plugin-overlay = import nixpkgs.nur.repos.mpickering.haskell-plugins.overlay;
  nixpkgs = import <nixpkgs> { overlays = [plugin-overlay]; };

Can you think of a nicer overall packaging strategy for this project?

[Mic92]

I would propose to put nixos modules and overlays in a seperate namespace within the repository. This helps later to make overlays/modules discoverable in a search engine:

let
  nixpkgs = import <nixpkgs> { overlays = [
     nixpkgs.nur.repos.mpickering.overlays.haskell-plugins
  ]; };
in

[Mic92]

I will extend the documentation for that.

[Mic92]

The current solution is a bit problematic, because nixpkgs is required to get the nix source for the overlay. This needs a better solution.

[Mic92]

this pull request will solve the problem: #27