diff --git a/.trunk/trunk.yaml b/.trunk/trunk.yaml index c204ca0..a9805aa 100644 --- a/.trunk/trunk.yaml +++ b/.trunk/trunk.yaml @@ -1,6 +1,6 @@ version: 0.1 cli: - version: 0.13.1-beta + version: 0.15.0-beta lint: enabled: - actionlint@1.6.13 @@ -12,4 +12,4 @@ lint: ignore: - linters: [ALL] paths: - - dist/** \ No newline at end of file + - dist/** diff --git a/CHANGELOG.md b/CHANGELOG.md index 0bd916c..f79001b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -18,4 +18,4 @@ to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). [unreleased]: https://github.com/loopholelabs/frpc-go/compare/v0.5.1...HEAD [v0.5.1]: https://github.com/loopholelabs/frpc-go/releases/tag/v0.5.1 -[v0.5.0]: https://github.com/loopholelabs/frisbee-go/compare/v0.4.6...v0.5.0 \ No newline at end of file +[v0.5.0]: https://github.com/loopholelabs/frisbee-go/compare/v0.4.6...v0.5.0 diff --git a/MAINTAINERS.md b/MAINTAINERS.md index 686aece..64f52b5 100644 --- a/MAINTAINERS.md +++ b/MAINTAINERS.md @@ -1,3 +1,3 @@ - Shivansh Vij @shivanshvij - Alex Sørlie Glomsaas @supermanifolds -- Felicitas Pojtinger @pojntfx \ No newline at end of file +- Felicitas Pojtinger @pojntfx diff --git a/README.md b/README.md index 801e954..445d3bd 100644 --- a/README.md +++ b/README.md @@ -3,36 +3,36 @@ [![License: Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-brightgreen.svg)](https://www.apache.org/licenses/LICENSE-2.0) [![Tests](https://github.com/loopholelabs/frpc-go/actions/workflows/tests.yaml/badge.svg)](https://github.com/loopholelabs/frpc-go/actions/workflows/tests.yaml) -This is the [Go](http://golang.org) implementation of [fRPC](https://frpc.io), a high-performance RPC framework for -designed for performance and stability, and it uses [frisbee-go](https://github.com/loopholelabs/frisbee) messaging framework under the hood. +This is the [Go](http://golang.org) implementation of [fRPC](https://frpc.io), a high-performance RPC framework for +designed for performance and stability, and it uses [frisbee-go](https://frpc.io/frisbee) messaging framework under the hood. **This library requires Go1.18 or later.** ## Important note about releases and stability This repository generally follows [Semantic Versioning](https://semver.org/). However, **this library is currently in -Beta** and is still considered experimental. Breaking changes of the library will _not_ trigger a new major release. The +Alpha** and is still considered experimental. Breaking changes of the library will _not_ trigger a new major release. The same is true for selected other new features explicitly marked as -**EXPERIMENTAL** in CHANGELOG.md. +**EXPERIMENTAL** in [the changelog](/CHANGELOG.md). ## Usage and Documentation Usage instructions and documentation for fRPC is available at [https://frpc.io/](https://frpc.io/). -The fRPC Generator is still in very early **Alpha**. While it is functional and being used within other products +The fRPC is still in very early **Alpha**. While it is functional and being used within other products we're building at [Loophole Labs][loophomepage], the `proto3` spec has a myriad of edge-cases that make it difficult to -guarantee validity of generated RPC frameworks without extensive real-world use. +guarantee validity of generated RPC code without extensive real-world use. That being said, as the library matures and usage of fRPC grows we'll be able to increase our testing -coverage and fix any edge case bugs. One of the major benefits to the RPC framework is that reading the generated code +coverage and fix any edge cases and bugs. One of the major benefits to the RPC framework is that reading the generated code is extremely straight forward, making it easy to debug potential issues down the line. ### Unsupported Features -The Frisbee RPC Generator currently does not support the following features, though they are actively being worked on: +fRPC currently does not support the following features, though they are actively being worked on: -- `OneOf` Message Types - Streaming Messages between the client and server +- `OneOf` Message Types Example `Proto3` files can be found [here](/examples). diff --git a/pkg/generator/imports.go b/pkg/generator/imports.go index 205fdb1..993e2f5 100644 --- a/pkg/generator/imports.go +++ b/pkg/generator/imports.go @@ -18,19 +18,19 @@ package generator var ( requiredImports = []string{ - "github.com/loopholelabs/frisbee/pkg/packet", "github.com/loopholelabs/polyglot-go", "errors", } serviceImports = []string{ - "github.com/loopholelabs/frisbee", + "github.com/loopholelabs/frisbee-go", "github.com/rs/zerolog", "crypto/tls", "context", } methodImports = []string{ + "github.com/loopholelabs/frisbee-go/pkg/packet", "sync", "sync/atomic", }