# Go Nx plugin
**First-class support of [Go](https://go.dev) in a [Nx](https://nx.dev) workspace**
[](https://github.com/nx-go/nx-go/releases/latest)
[](https://nx.dev)
[](https://npmjs.com/package/@nx-go/nx-go)
[](https://github.com/nx-go/nx-go/blob/main/LICENSE)
[](https://sonarcloud.io/dashboard?id=nx-go_nx-go)
## ✨ Features
- 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
## 🚀 Getting started
You need to have a [stable version of Go](https://go.dev/dl/) installed on your machine. And.. you are ready!
### Generate a Nx workspace with Go support
```shell
npx create-nx-workspace go-workspace --preset=@nx-go/nx-go
```
### Add to an exisiting workspace
```shell
nx add @nx-go/nx-go
```
### Migrate to latest version
```shell
nx migrate @nx-go/nx-go
```
### Don't want to use a multi-module Go workspace?
The plugin configures a [multi-module Go workspace](https://go.dev/doc/tutorial/workspaces) 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.
```shell
nx g @nx-go/nx-go:convert-to-one-mod
```
## 📖 Generators & executors
### Generators
- `application`: [Generate a Go application](./docs/generators/application.md)
- `library`: [Generate a Go library](./docs/generators/library.md)
### Executors
- `build`: [Build a Go project](./docs/executors/build.md)
- `generate`: [Generate code using Go](./docs/executors/generate.md)
- `lint`: [Format and lint a Go project](./docs/executors/lint.md)
- `serve`: [Run a Go application](./docs/executors/serve.md)
- `test`: [Run tests of a Go project](./docs/executors/test.md)
- `tidy`: [Ensures go.mod file matches a project source code](./docs/executors/tidy.md)
> [!TIP]
> You can use `nx list @nx-go/nx-go` to see list capabilities.
Want to try out these capabilities quickly? Visit our [playground](https://github.com/nx-go/nx-go-playground)!
Need more customization? A [plugin configuration](./docs/options.md) is also available.
## 🧩 Compatibility
| 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](https://go.dev/dl/), 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
Licensed under MIT
