gomod2nix/docs/nix-reference.md

23 lines
804 B
Markdown
Raw Normal View History

2022-06-14 10:18:04 +00:00
# Gomod2nix Nix API
## Public functions
### buildGoApplication
Arguments:
- **modules** Path to `gomod2nix.toml` (_default: `pwd + "/gomod2nix.toml"`).
2022-06-14 10:18:04 +00:00
- **src** Path to sources (_default: `pwd`).
- **pwd** Path to working directory (_default: `null`).
- **go** The Go compiler to use (can be omitted).
- **subPackages** Only build these specific sub packages.
- **allowGoReference** Allow references to the Go compiler in the output closure (_default: `false`).
All other arguments are passed verbatim to `stdenv.mkDerivation`.
### mkGoEnv
Arguments:
- **pwd** Path to working directory.
- **modules** Path to `gomod2nix.toml` (_default: `pwd + "/gomod2nix.toml"`).
- **toolsGo** Path to `tools.go` (_default: `pwd + "/tools.go"`).
2022-06-14 10:18:04 +00:00
All other arguments are passed verbatim to `stdenv.mkDerivation`.