@nx-go/nx-go

Features

• Generate Go applications and libraries in seconds within your Nx workspace
• Zero-config setup – Automatic task inference for projects with go.mod
• Blazing-fast tasks – Optimized caching with smart inputs and outputs
• Community friendly – Integration with recognized community projects such as Air
• Reliable – Use official Go commands in the background with no external dependency

Getting started

You need to have a stable version of Go installed on your machine. And.. you are ready!

Generate a Nx workspace with Go support

npx create-nx-workspace go-workspace --preset=@nx-go/nx-go

Add to an exisiting workspace

nx add @nx-go/nx-go

Migrate to latest version

nx migrate @nx-go/nx-go

Don't want to use a multi-module Go workspace?

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

Convert to inferred tasks

You need to have a multi-module Go workspace to use inferred tasks.
Convert existing projects from executor-based to inferred task configuration:

nx g infer-targets

Generators & executors

Generators

• application: Generate a Go application
• library: Generate a Go library

Executors

• build: Build a Go project
• generate: Generate code using Go
• lint: Format and lint a Go project
• serve: Run a Go application
• serve-air: Run a Go application with Air live reload
• test: Run tests of a Go project
• tidy: Ensures go.mod file matches a project source code

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.

Compatibility

nx-go version	Nx version
4.x	20.x to 23.x
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.

Contributors

Bram Borggreve Creator

Maxime Malgorn Maintainer

Licensed under MIT