Convert applications using Go modules to Nix expressions
Find a file
2022-05-30 18:34:43 +08:00
.github/workflows Github actions: Clean up superflous test.yml file 2022-05-29 16:24:58 +08:00
builder support impure env GOPROXY 2022-05-30 11:13:30 +08:00
generate generate: Set correct working directory for go mod download 2022-05-28 22:56:52 +08:00
lib Replace dependency on Nix with go-nix 2022-05-28 22:56:52 +08:00
schema Add back internal caching for previously generated packages 2022-05-28 22:56:52 +08:00
tests tests: Handle test cases without a go.mod 2022-05-30 18:33:40 +08:00
.envrc Add python test script 2020-12-03 16:23:39 +01:00
.gitignore fix symlink nested package 2022-05-20 15:54:53 +08:00
default.nix gomod2nix: Filter builder expressions from cli build 2022-05-30 18:33:40 +08:00
flake.lock Bump flake inputs 2022-05-30 18:10:53 +08:00
flake.nix flake.nix: Update to latest flake schema 2022-05-26 18:31:19 +08:00
go.mod Replace dependency on Nix with go-nix 2022-05-28 22:56:52 +08:00
go.sum Replace dependency on Nix with go-nix 2022-05-28 22:56:52 +08:00
gomod2nix.toml root: Use new format for building self 2022-05-28 22:56:52 +08:00
LICENSE Add README file 2020-12-03 16:23:39 +01:00
main.go generate: Set correct working directory for go mod download 2022-05-28 22:56:52 +08:00
overlay.nix flake.nix: Use overlay from separate overlay.nix expression 2022-05-26 18:17:02 +08:00
README.md Add README file 2020-12-03 16:23:39 +01:00
shell.nix shell.nix: Add golangci-lint 2022-05-30 18:34:43 +08:00

Gomod2nix

Convert applications using Go modules -> Nix

Usage

From the Go project directory execute:

$ gomod2nix

This will create gomod2nix.toml that's used like so

let
  pkgs = import <nixpkgs> {
    overlays = [
      (self: super: {
        buildGoApplication = super.callPackage ./builder { };
      })
    ];
  };
in pkgs.buildGoApplication {
  pname = "gomod2nix-example";
  version = "0.1";
  src = ./.;
  modules = ./gomod2nix.toml;
}

FAQ

Why not continue work on vgo2nix?

Vgo2nix was built on top of the old Nixpkgs build abstraction buildGoPackage, this abstraction was built pre-modules and suffered from some fundamental design issues with modules, such as only allowing a single version of a Go package path inside the same build closure, something that Go itself allows for.

We need a better build abstraction that takes Go modules into account, while remaining import from derivation-free.

Will this be included in Nixpkgs

Yes. Once the API is considered stable.

License

This project is licensed under the MIT License. See the LICENSE file for details.