mention ridlfmt and add it to example (webrpc#321)

Author: LukasJenicek

README.md

@@ -20,6 +20,7 @@ simplifying the development of backend services for modern Web applications.
 - [Development](#development)
   - [Building from source](#building-from-source)
   - [Writing your own code-generator](#writing-your-own-code-generator)
+  - [Format ridl files](#format-ridl)
 - [Authors](#authors)
 - [Credits](#credits)
 - [License](#license)
@@ -214,6 +215,10 @@ For more information please see the [schema readme](./schema/README.md).
 
 See [webrpc-gen documentation](./gen).
 
+## Format ridl
+- Use [Ridlfmt](https://github.com/webrpc/ridlfmt)
+- Supports same arguments as `gofmt` 
+- See: [Example](https://github.com/webrpc/webrpc/blob/master/_examples/golang-basics/Makefile#L4)
 
 # Authors
 

_examples/golang-basics/Makefile

@@ -1,6 +1,9 @@
 all:
 	@awk -F'[ :]' '!/^all:/ && /^([A-z_-]+):/ {print "make " $$1}' Makefile
 
+format:
+	go run github.com/webrpc/ridlfmt@v0.2.0 -w example.ridl
+
 generate:
 	webrpc-gen -schema=example.ridl -target=golang -pkg=main -server -client -service="ExampleService" -out=./example.gen.go
 	webrpc-gen -schema=example.ridl -target=golang -pkg=admin -server -client -service="AdminService" -ignore="@deprecated" -out=./admin/admin.gen.go

_examples/golang-basics/example.ridl

@@ -1,8 +1,7 @@
-webrpc = v1             # version of webrpc schema format (ridl or json)
+webrpc = v1 # version of webrpc schema format (ridl or json)
 
-name = example          # name of your backend app
-version = v0.0.1        # version of your schema
-              
+name = example # name of your backend app
+version = v0.0.1 # version of your schema
 
 enum Kind: uint32
   - USER
@@ -56,43 +55,41 @@ struct ComplexType
   - mapOfUsers: map<string,User>
   - user: User
 
-
-error 1000 UserNotFound "User not found" HTTP 404
-error 2000 Unauthorized "Unauthorized access" HTTP 401
-error 3000 PermissionDenied "Permission denied" HTTP 403
-
+error 1000 UserNotFound     "User not found"      HTTP 404
+error 2000 Unauthorized     "Unauthorized access" HTTP 401
+error 3000 PermissionDenied "Permission denied"   HTTP 403
 
 service ExampleService
-  @internal
+    @internal
   - Ping()
-  @internal
+    @internal
   - Status() => (status: bool)
-  @internal
+    @internal
   - Version() => (version: Version)
-  @deprecated:GetUserV2
-  @internal
+    @deprecated:GetUserV2
+    @internal
   - GetUser(header: map<string,string>, userID: uint64) => (code: uint32, user: User)
-  @public
-  @auth:"X-Access-Key,S2S,Cookies"
+    @public
+    @auth:"X-Access-Key,S2S,Cookies"
   - GetUserV2(header: map<string,string>, userID: uint64) => (code: uint32, user: User, profile: string)
-  @public
+    @public
   - FindUser(s: SearchFilter) => (name: string, user: User)
-  @public
+    @public
   - GetIntents() => (intents: []Intent)
-  @public
+    @public
   - CountIntents(userId: uint64) => (count: map<Intent,uint32>)
 
 service ExampleServiceV2
   - Ping()
   - Status() => (status: bool)
 
 service AdminService
-  @public
-  @deprecated:Auth
+    @public
+    @deprecated:Auth
   - AuthOld() => (jwt: string)
-  @public
+    @public
   - Auth() => (jwt: string, role: string)
-  @internal
+    @internal
   - Status() => (status: bool)
-  @internal
-  - Version() => (version: Version)
+    @internal
+  - Version() => (version: Version)

_examples/golang-basics/go.mod

@@ -1,10 +1,10 @@
 module github.com/webrpc/webrpc/_example/golang-basics
 
-go 1.19
+go 1.22
 
 require (
 	github.com/go-chi/chi/v5 v5.0.12
-	github.com/stretchr/testify v1.8.1
+	github.com/stretchr/testify v1.9.0
 )
 
 require (

_examples/golang-basics/go.sum

@@ -1,19 +1,12 @@
-github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/go-chi/chi/v5 v5.0.12 h1:9euLV5sTrTNTRUU9POmDUvfxyj6LAABLUcEWO+JJb4s=
 github.com/go-chi/chi/v5 v5.0.12/go.mod h1:DslCQbL2OYiznFReuXYUmQ2hGd1aDpCnlMNITLSKoi8=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
-github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
-github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw=
-github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo=
-github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
-github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU=
-github.com/stretchr/testify v1.8.1 h1:w7B6lhMri9wdJUVmEZPGGhZzrYTPvgJArz7wNPgYKsk=
-github.com/stretchr/testify v1.8.1/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4=
+github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg=
+github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
-gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
 gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
 gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=