Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mochams/rebar3_go
A rebar3 plugin that eases creating and building go ports in erlang projects
https://github.com/mochams/rebar3_go
erlang go rebar3 rebar3-plugin
Last synced: 3 days ago
JSON representation
A rebar3 plugin that eases creating and building go ports in erlang projects
- Host: GitHub
- URL: https://github.com/mochams/rebar3_go
- Owner: mochams
- License: apache-2.0
- Created: 2024-12-24T11:51:05.000Z (13 days ago)
- Default Branch: develop
- Last Pushed: 2024-12-27T16:30:02.000Z (9 days ago)
- Last Synced: 2025-01-01T16:22:21.372Z (4 days ago)
- Topics: erlang, go, rebar3, rebar3-plugin
- Language: Erlang
- Homepage: https://hexdocs.pm/rebar3_go/
- Size: 25.4 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# rebar3_go 🚀
[](http://www.erlang.org)
[](https://hex.pm/packages/rebar3_go)
[](https://hexdocs.pm/rebar3_go/)
[](https://github.com/mochams/rebar3_go)
A rebar3 plugin for managing Go modules in Erlang/OTP applications.
## Features
- Adds Go modules to your Erlang/OTP project
- Compiles Go modules in your project
- Formats Go code in your project
- Tests Go modules in your project
- Supports standalone and release/umbrella applications
- Minimal configuration required
## Requirements
- Erlang/OTP
- Go
## Installation
```erlang
%% Add the following to your rebar.config.
{project_plugins, [rebar3_go]}.
%% Optional: Add the following to your rebar.config
{provider_hooks, [
{pre, [
{compile, {go, compile}}
]}
]}.
```
## Usage
```bash
# To add a Go module to your project (Standalone applications)
rebar3 go add -m
# To add a Go module to your project (Release/Umbrella applications)
rebar3 go add -m -a
# To compile go modules
rebar3 go compile
# To format go code
rebar3 go fmt
# To test go modules
rebar3 go test
```
## Directory Structure
### Standalone App
```bash
.
├── src # Erlang source code
├── go.work # Go workspace definition
├── go_src # Go source code
│ ├── module1 # Go module 1
│ │ ├── main.go
│ │ └── go.mod
│ └── module2 # Go module 2
│ ├── main.go
│ └── go.mod
├── priv # Priv directory
│ └── go # Compiled Go code
│ ├── module1 # Compiled Go module 1
│ └── module2 # Compiled Go module 2
```
### Release/Umbrella App
```bash
.
├── apps
│ ├── app1 # App 1
│ │ ├── src # Erlang source code
│ │ ├── go.work # Go workspace definition
│ │ ├── go_src # Go source code
│ │ │ ├── module1 # Go module 1
│ │ │ │ ├── main.go
│ │ │ │ └── go.mod
│ │ │ └── module2 # Go module 2
│ │ │ ├── main.go
│ │ │ └── go.mod
│ │ └── priv # Priv directory
│ │ └── go # Compiled Go code
│ │ ├── module1 # Compiled Go module 1
│ │ └── module2 # Compiled Go module 2
│ └── app2 # App 2
│ ├── src # Erlang source code
│ ├── go.work # Go workspace definition
│ ├── go_src # Go source code
│ │ ├── module1 # Go module 1
│ │ │ ├── main.go
│ │ │ └── go.mod
│ │ └── module2 # Go module 2
│ │ ├── main.go
│ │ └── go.mod
│ └── priv # Priv directory
│ └── go # Compiled Go code
│ ├── module1 # Compiled Go module 1
│ └── module2 # Compiled Go module 2
└── rebar.config
```
## Commands
### Add Module Command
0. The plugin adds a Go module to the project.
`Syntax(Standalone app)`
```bash
rebar3 go add -m
```
`Syntax(Release/Umbrella app)`
```bash
rebar3 go add -m -a
```
1. First time adding a Go module to your project, the plugin creates a `go.work` file in the app root directory.
> In standalone applications, the `go.work` file will be created in the root directory of the application.
> In release/umbrella applications, the `go.work` file will be created in the root directory of the specified app.
2. The plugin creates a `go_src/` directory and creates the `main.go` and `go.mod` files in it.
3. The plugin adds the module name to the `go.work` file.
### Compile Command
0. The plugin compiles the Go modules in the project.
`Syntax`
```bash
rebar3 go compile
```
1. The plugins goes through all applications in the project and checks if they have a `go_src` directory.
2. If a `go_src` directory is found, the plugin compiles the Go module(s) in the directory else it skips the application.
3. The plugin compiles the Go module(s) and copies the compiled code to the `priv/go` directory.
### Format Command
0. The plugin formats the Go code in the project.
`Syntax`
```bash
rebar3 go fmt
```
1. The plugin runs the command `go fmt ./...` in each go module.
### Test Command
0. The plugin tests the Go modules in the project.
`Syntax`
```bash
rebar3 go test
```
1. The plugin runs the command `go test ./... -cover` in each go module.
2. The plugin aborts the whole operation if any of the tests fail.
## Roadmap
- [x] Add module command
- [x] Compile command
- [x] Format command
- [x] Test module command
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
## Acknowledgments
Inspired by the needs of the Erlang/OTP community for reliable Go port communication.
## Complementary Libraries
- [Erlgo](https://github.com/mochams/erlgo): Send and Receive messages between Erlang and Go.
Now go forth and make your Erlang and Go code talk to each other like old friends! 🚀✨