- Generate Go applications and libraries in seconds within your Nx workspace
- Execute, build, format and test projects with a customizable configuration
- Efficient caching and dependency graph tools for Go projects
- Use official Go commands in the background
You need to have a stable version of Go installed on your machine. And.. you are ready!
npx create-nx-workspace go-workspace --preset=@nx-go/nx-go
nx add @nx-go/nx-go
nx migrate @nx-go/nx-go
The plugin configures a multi-module Go workspace by default, to simplify project management and improve the quality of the Nx graph. If you don't want to take advantage of this feature, you can use generator convert-to-one-mod
after the plugin installation. Generators will automatically adapt to your configuration.
nx g @nx-go/nx-go:convert-to-one-mod
application
: Generate a Go applicationlibrary
: Generate a Go library
build
: Build a Go projectgenerate
: Generate code using Golint
: Format and lint a Go projectserve
: Run a Go applicationtest
: Run tests of a Go projecttidy
: Ensures go.mod file matches a project source code
Tip
You can use nx list @nx-go/nx-go
to see list capabilities.
Want to try out these capabilities quickly? Visit our playground!
Need more customization? A plugin configuration is also available.
nx-go version | Nx version |
---|---|
3.x | 17.x to 20.x |
2.x | 13.x to 16.x |
1.x | < 13.x |
This plugin is only tested on stable versions of Go, older versions does not receive support. However, you can expect a fair degree of compatibility. Please note that multi-module Go workspaces require Go 1.18 or later.
Bram Borggreve Creator |
Maxime Malgorn Maintainer |
Licensed under MIT