chore: update the documentation according to the new import style

go-fuego · Sep 1, 2024 · df1b3c5 · df1b3c5
1 parent 4b668b4
commit df1b3c5
Show file tree

Hide file tree

Showing 10 changed files with 57 additions and 18 deletions.
diff --git a/README.md b/README.md
@@ -168,6 +168,7 @@ package main
 
 import (
 	"net/http"
+
 	"github.com/go-fuego/fuego"
 )
 
@@ -211,8 +212,9 @@ import (
 	"strings"
 
 	chiMiddleware "github.com/go-chi/chi/v5/middleware"
-	"github.com/go-fuego/fuego"
 	"github.com/rs/cors"
+
+	"github.com/go-fuego/fuego"
 )
 
 type Received struct {

diff --git a/documentation/docs/guides/middlewares.md b/documentation/docs/guides/middlewares.md
@@ -16,8 +16,9 @@ You can add middlewares to the whole server using the `Use` method:
 package main
 
 import (
-	"github.com/go-fuego/fuego"
 	"net/http"
+
+	"github.com/go-fuego/fuego"
 )
 
 func main() {
@@ -48,8 +49,9 @@ You can also add middlewares to a group of routes using the `Group` method:
 package main
 
 import (
-	"github.com/go-fuego/fuego"
 	"net/http"
+
+	"github.com/go-fuego/fuego"
 )
 
 func main() {

diff --git a/documentation/docs/guides/openapi.md b/documentation/docs/guides/openapi.md
@@ -109,6 +109,8 @@ import (
 	"net/http"
 
 	httpSwagger "github.com/swaggo/http-swagger"
+
+	"github.com/go-fuego/fuego"
 )
 
 func openApiHandler(specURL string) http.Handler {

diff --git a/documentation/docs/guides/options.md b/documentation/docs/guides/options.md
@@ -32,9 +32,13 @@ func main() {
 You can change the address of the server with the `WithAddr` option.
 
 ```go
-s := fuego.NewServer(
-	fuego.WithAddr("localhost:8080"),
-)
+import "github.com/go-fuego/fuego"
+
+func main() {
+	s := fuego.NewServer(
+		fuego.WithAddr("localhost:8080"),
+	)
+}
 ```
 
 ### Port (Deprecated)
@@ -44,9 +48,13 @@ s := fuego.NewServer(
 You can change the port of the server with the `WithPort` option.
 
 ```go
-s := fuego.NewServer(
-	fuego.WithPort(8080),
-)
+import "github.com/go-fuego/fuego"
+
+func main() {
+	s := fuego.NewServer(
+		fuego.WithPort(8080),
+	)
+}
 ```
 
 ### CORS
@@ -58,12 +66,18 @@ because it applies on routes that aren't registered. For example,
 but it's a request that needs to be handled by the CORS middleware.
 
 ```go
-import "github.com/rs/cors"
+import (
+	"github.com/rs/cors"
 
-s := fuego.NewServer(
-	fuego.WithCorsMiddleware(cors.New(cors.Options{
-		AllowedOrigins: []string{"*"},
-		AllowedMethods: []string{"GET", "POST", "PUT", "DELETE"},
-	}).Handler),
+	"github.com/go-fuego/fuego"
 )
+
+func main() {
+	s := fuego.NewServer(
+		fuego.WithCorsMiddleware(cors.New(cors.Options{
+			AllowedOrigins: []string{"*"},
+			AllowedMethods: []string{"GET", "POST", "PUT", "DELETE"},
+		}).Handler),
+	)
+}
 ```
diff --git a/documentation/docs/guides/serialization.mdx b/documentation/docs/guides/serialization.mdx
@@ -103,8 +103,9 @@ package main
 import (
 	"net/http"
 
-	"github.com/go-fuego/fuego"
 	jsoniter "github.com/json-iterator/go"
+
+	"github.com/go-fuego/fuego"
 )
 
 var json = jsoniter.ConfigCompatibleWithStandardLibrary

diff --git a/documentation/docs/guides/transformation.mdx b/documentation/docs/guides/transformation.mdx
@@ -22,6 +22,7 @@ package main
 import (
 	"context"
 	"strings"
+
 	"github.com/go-fuego/fuego"
 )
 

diff --git a/documentation/docs/tutorials/02-crud.md b/documentation/docs/tutorials/02-crud.md
@@ -66,9 +66,10 @@ func (s RealBooksService) GetBooks(id string) (Books, error) {
 package main
 
 import (
+	"github.com/go-fuego/fuego"
+
 	// ADD NEXT LINE
 	"hello-fuego/controllers"
-	"github.com/go-fuego/fuego"
 )
 
 func main() {
@@ -105,8 +106,9 @@ that can generates CRUD routes and controllers for you!
 package main
 
 import (
-	"hello-fuego/controllers"
 	"github.com/go-fuego/fuego"
+
+	"hello-fuego/controllers"
 )
 
 func main() {

diff --git a/documentation/docs/tutorials/rendering/gomponents.md b/documentation/docs/tutorials/rendering/gomponents.md
@@ -6,6 +6,11 @@ Just use the `fuego.Gomponent` type as a return type for your handler,
 and return the gomponent.
 
 ```go
+import (
+	"github.com/go-fuego/fuego"
+	"github.com/go-fuego/fuego/examples/full-app-gourmet/store"
+)
+
 // highlight-next-line
 func (rs Ressource) adminIngredients(c fuego.ContextNoBody) (fuego.Gomponent, error) {
 	searchParams := components.SearchParams{

diff --git a/documentation/docs/tutorials/rendering/std.md b/documentation/docs/tutorials/rendering/std.md
@@ -11,6 +11,11 @@ Just use the `fuego.HTML` type as a return type for your handler, and return
 `c.Render()` with the template name and data.
 
 ```go
+import (
+	"github.com/go-fuego/fuego"
+	"github.com/go-fuego/fuego/examples/full-app-gourmet/store/types"
+)
+
 // highlight-next-line
 func (rs Ressource) unitPreselected(c fuego.ContextNoBody) (fuego.HTML, error) {
 	id := c.QueryParam("IngredientID")

diff --git a/documentation/docs/tutorials/rendering/templ.md b/documentation/docs/tutorials/rendering/templ.md
@@ -8,6 +8,11 @@ with the `fuego.Templ` return type.
 Example from [a recipe app](https://github.com/go-fuego/fuego/tree/main/examples/full-app-gourmet):
 
 ```go
+import (
+	"github.com/go-fuego/fuego"
+	"github.com/go-fuego/fuego/examples/full-app-gourmet/store"
+)
+
 // highlight-next-line
 func (rs Ressource) adminIngredients(c fuego.ContextNoBody) (fuego.Templ, error) {
 	searchParams := components.SearchParams{