rest server done

Author: andrearcaina

README.md

@@ -8,13 +8,18 @@ Inspired by the fact that I hate rewriting and copy pasting code that I have alr
 
 P.S. This was encountered while working on [fáfnir](https://github.com/andrearcaina/fafnir).
 
+> The idea is that these are backend services (like microservices), not an entire backend monolith implementation. For starters though this generates a good strtucture, but for it to be an entire monolith it would need to require extra setup from yourself.
+
 
 ### TODO
 
 In no particular order:
 
 - [ ] Add REST, gRPC, and GraphQL templates to my liking
-- [ ] Add SQLc support to my liking
-- [ ] Implement quality of life features like:
-    - [ ] Flags for every possible option
-    - [ ] Interactive UI for when flags are not provided
+    - [X] REST
+    - [ ] gRPC
+    - [ ] GraphQL
+- [X] Add SQLc support to my liking
+- [X] Implement quality of life features like:
+    - [X] Flags for every possible option
+    - [X] Interactive UI for when flags are not provided

cmd/generate.go

@@ -32,8 +32,9 @@ func init() {
 	rootCmd.AddCommand(generateCmd)
 
 	generateCmd.Flags().StringVarP(&cfg.OutputPath, "path", "p", ".", "The directory to write the generated file to")
+	generateCmd.Flags().BoolVarP(&cfg.Default, "default", "d", false, "Use default configuration values")
 
-	// following flags are just for test data
-	generateCmd.Flags().StringVar(&cfg.Form.SomeFlag, "some-flag", "", "A flag to specify who to say hello to")
-	generateCmd.Flags().StringVar(&cfg.Form.AnotherFlag, "another-flag", "", "Another flag")
+	generateCmd.Flags().StringVarP(&cfg.Form.Name, "name", "n", "", "The name for the go.mod module")
+	generateCmd.Flags().StringVarP((*string)(&cfg.Form.ServerTypeFlag), "server", "s", "", "Type of server to generate (rest/grpc/graphql)")
+	generateCmd.Flags().BoolVar(&cfg.Form.DatabaseFlag, "database", true, "Generate database files")
 }

go.mod

@@ -2,18 +2,21 @@ module github.com/andrearcaina/goforge
 
 go 1.24.5
 
-require github.com/spf13/cobra v1.10.2
+require (
+	github.com/charmbracelet/huh v0.8.0
+	github.com/charmbracelet/huh/spinner v0.0.0-20251215014908-6f7d32faaff3
+	github.com/charmbracelet/lipgloss v1.1.0
+	github.com/spf13/cobra v1.10.2
+)
 
 require (
 	github.com/atotto/clipboard v0.1.4 // indirect
 	github.com/aymanbagabas/go-osc52/v2 v2.0.1 // indirect
 	github.com/catppuccin/go v0.3.0 // indirect
 	github.com/charmbracelet/bubbles v0.21.1-0.20250623103423-23b8fd6302d7 // indirect
-	github.com/charmbracelet/bubbletea v1.3.6 // indirect
+	github.com/charmbracelet/bubbletea v1.3.10 // indirect
 	github.com/charmbracelet/colorprofile v0.2.3-0.20250311203215-f60798e515dc // indirect
-	github.com/charmbracelet/huh v0.8.0 // indirect
-	github.com/charmbracelet/lipgloss v1.1.0 // indirect
-	github.com/charmbracelet/x/ansi v0.9.3 // indirect
+	github.com/charmbracelet/x/ansi v0.10.1 // indirect
 	github.com/charmbracelet/x/cellbuf v0.0.13 // indirect
 	github.com/charmbracelet/x/exp/strings v0.0.0-20240722160745-212f7b056ed0 // indirect
 	github.com/charmbracelet/x/term v0.2.1 // indirect
@@ -31,7 +34,6 @@ require (
 	github.com/rivo/uniseg v0.4.7 // indirect
 	github.com/spf13/pflag v1.0.9 // indirect
 	github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e // indirect
-	golang.org/x/sync v0.15.0 // indirect
-	golang.org/x/sys v0.33.0 // indirect
+	golang.org/x/sys v0.36.0 // indirect
 	golang.org/x/text v0.23.0 // indirect
 )

go.sum

@@ -1,28 +1,46 @@
+github.com/MakeNowJust/heredoc v1.0.0 h1:cXCdzVdstXyiTqTvfqk9SDHpKNjxuom+DOlyEeQ4pzQ=
+github.com/MakeNowJust/heredoc v1.0.0/go.mod h1:mG5amYoWBHf8vpLOuehzbGGw0EHxpZZ6lCpQ4fNJ8LE=
 github.com/atotto/clipboard v0.1.4 h1:EH0zSVneZPSuFR11BlR9YppQTVDbh5+16AmcJi4g1z4=
 github.com/atotto/clipboard v0.1.4/go.mod h1:ZY9tmq7sm5xIbd9bOK4onWV4S6X0u6GY7Vn0Yu86PYI=
 github.com/aymanbagabas/go-osc52/v2 v2.0.1 h1:HwpRHbFMcZLEVr42D4p7XBqjyuxQH5SMiErDT4WkJ2k=
 github.com/aymanbagabas/go-osc52/v2 v2.0.1/go.mod h1:uYgXzlJ7ZpABp8OJ+exZzJJhRNQ2ASbcXHWsFqH8hp8=
+github.com/aymanbagabas/go-udiff v0.3.1 h1:LV+qyBQ2pqe0u42ZsUEtPiCaUoqgA9gYRDs3vj1nolY=
+github.com/aymanbagabas/go-udiff v0.3.1/go.mod h1:G0fsKmG+P6ylD0r6N/KgQD/nWzgfnl8ZBcNLgcbrw8E=
 github.com/catppuccin/go v0.3.0 h1:d+0/YicIq+hSTo5oPuRi5kOpqkVA5tAsU6dNhvRu+aY=
 github.com/catppuccin/go v0.3.0/go.mod h1:8IHJuMGaUUjQM82qBrGNBv7LFq6JI3NnQCF6MOlZjpc=
 github.com/charmbracelet/bubbles v0.21.1-0.20250623103423-23b8fd6302d7 h1:JFgG/xnwFfbezlUnFMJy0nusZvytYysV4SCS2cYbvws=
 github.com/charmbracelet/bubbles v0.21.1-0.20250623103423-23b8fd6302d7/go.mod h1:ISC1gtLcVilLOf23wvTfoQuYbW2q0JevFxPfUzZ9Ybw=
-github.com/charmbracelet/bubbletea v1.3.6 h1:VkHIxPJQeDt0aFJIsVxw8BQdh/F/L2KKZGsK6et5taU=
-github.com/charmbracelet/bubbletea v1.3.6/go.mod h1:oQD9VCRQFF8KplacJLo28/jofOI2ToOfGYeFgBBxHOc=
+github.com/charmbracelet/bubbletea v1.3.10 h1:otUDHWMMzQSB0Pkc87rm691KZ3SWa4KUlvF9nRvCICw=
+github.com/charmbracelet/bubbletea v1.3.10/go.mod h1:ORQfo0fk8U+po9VaNvnV95UPWA1BitP1E0N6xJPlHr4=
 github.com/charmbracelet/colorprofile v0.2.3-0.20250311203215-f60798e515dc h1:4pZI35227imm7yK2bGPcfpFEmuY1gc2YSTShr4iJBfs=
 github.com/charmbracelet/colorprofile v0.2.3-0.20250311203215-f60798e515dc/go.mod h1:X4/0JoqgTIPSFcRA/P6INZzIuyqdFY5rm8tb41s9okk=
 github.com/charmbracelet/huh v0.8.0 h1:Xz/Pm2h64cXQZn/Jvele4J3r7DDiqFCNIVteYukxDvY=
 github.com/charmbracelet/huh v0.8.0/go.mod h1:5YVc+SlZ1IhQALxRPpkGwwEKftN/+OlJlnJYlDRFqN4=
+github.com/charmbracelet/huh/spinner v0.0.0-20251215014908-6f7d32faaff3 h1:KUeWGoKnmyrLaDIa0smE6pK5eFMZWNIxPGweQR12iLg=
+github.com/charmbracelet/huh/spinner v0.0.0-20251215014908-6f7d32faaff3/go.mod h1:OMqKat/mm9a/qOnpuNOPyYO9bPzRNnmzLnRZT5KYltg=
 github.com/charmbracelet/lipgloss v1.1.0 h1:vYXsiLHVkK7fp74RkV7b2kq9+zDLoEU4MZoFqR/noCY=
 github.com/charmbracelet/lipgloss v1.1.0/go.mod h1:/6Q8FR2o+kj8rz4Dq0zQc3vYf7X+B0binUUBwA0aL30=
-github.com/charmbracelet/x/ansi v0.9.3 h1:BXt5DHS/MKF+LjuK4huWrC6NCvHtexww7dMayh6GXd0=
-github.com/charmbracelet/x/ansi v0.9.3/go.mod h1:3RQDQ6lDnROptfpWuUVIUG64bD2g2BgntdxH0Ya5TeE=
+github.com/charmbracelet/x/ansi v0.10.1 h1:rL3Koar5XvX0pHGfovN03f5cxLbCF2YvLeyz7D2jVDQ=
+github.com/charmbracelet/x/ansi v0.10.1/go.mod h1:3RQDQ6lDnROptfpWuUVIUG64bD2g2BgntdxH0Ya5TeE=
 github.com/charmbracelet/x/cellbuf v0.0.13 h1:/KBBKHuVRbq1lYx5BzEHBAFBP8VcQzJejZ/IA3iR28k=
 github.com/charmbracelet/x/cellbuf v0.0.13/go.mod h1:xe0nKWGd3eJgtqZRaN9RjMtK7xUYchjzPr7q6kcvCCs=
+github.com/charmbracelet/x/conpty v0.1.0 h1:4zc8KaIcbiL4mghEON8D72agYtSeIgq8FSThSPQIb+U=
+github.com/charmbracelet/x/conpty v0.1.0/go.mod h1:rMFsDJoDwVmiYM10aD4bH2XiRgwI7NYJtQgl5yskjEQ=
+github.com/charmbracelet/x/errors v0.0.0-20240508181413-e8d8b6e2de86 h1:JSt3B+U9iqk37QUU2Rvb6DSBYRLtWqFqfxf8l5hOZUA=
+github.com/charmbracelet/x/errors v0.0.0-20240508181413-e8d8b6e2de86/go.mod h1:2P0UgXMEa6TsToMSuFqKFQR+fZTO9CNGUNokkPatT/0=
+github.com/charmbracelet/x/exp/golden v0.0.0-20241011142426-46044092ad91 h1:payRxjMjKgx2PaCWLZ4p3ro9y97+TVLZNaRZgJwSVDQ=
+github.com/charmbracelet/x/exp/golden v0.0.0-20241011142426-46044092ad91/go.mod h1:wDlXFlCrmJ8J+swcL/MnGUuYnqgQdW9rhSD61oNMb6U=
 github.com/charmbracelet/x/exp/strings v0.0.0-20240722160745-212f7b056ed0 h1:qko3AQ4gK1MTS/de7F5hPGx6/k1u0w4TeYmBFwzYVP4=
 github.com/charmbracelet/x/exp/strings v0.0.0-20240722160745-212f7b056ed0/go.mod h1:pBhA0ybfXv6hDjQUZ7hk1lVxBiUbupdw5R31yPUViVQ=
 github.com/charmbracelet/x/term v0.2.1 h1:AQeHeLZ1OqSXhrAWpYUtZyX1T3zVxfpZuEQMIQaGIAQ=
 github.com/charmbracelet/x/term v0.2.1/go.mod h1:oQ4enTYFV7QN4m0i9mzHrViD7TQKvNEEkHUMCmsxdUg=
+github.com/charmbracelet/x/termios v0.1.1 h1:o3Q2bT8eqzGnGPOYheoYS8eEleT5ZVNYNy8JawjaNZY=
+github.com/charmbracelet/x/termios v0.1.1/go.mod h1:rB7fnv1TgOPOyyKRJ9o+AsTU/vK5WHJ2ivHeut/Pcwo=
+github.com/charmbracelet/x/xpty v0.1.2 h1:Pqmu4TEJ8KeA9uSkISKMU3f+C1F6OGBn8ABuGlqCbtI=
+github.com/charmbracelet/x/xpty v0.1.2/go.mod h1:XK2Z0id5rtLWcpeNiMYBccNNBrP2IJnzHI0Lq13Xzq4=
 github.com/cpuguy83/go-md2man/v2 v2.0.6/go.mod h1:oOW0eioCTA6cOiMLiUPZOpcVxMig6NIQQ7OS05n1F4g=
+github.com/creack/pty v1.1.24 h1:bJrF4RRfyJnbTJqzRLHzcGaZK1NeM5kTC9jGgovnR1s=
+github.com/creack/pty v1.1.24/go.mod h1:08sCNb52WyoAwi2QDyzUCTgcvVFhUzewun7wtTfvcwE=
 github.com/dustin/go-humanize v1.0.1 h1:GzkhY7T5VNhEkwH0PVJgjz+fX1rhBrR7pRT3mDkpeCY=
 github.com/dustin/go-humanize v1.0.1/go.mod h1:Mu1zIs6XwVuF/gI1OepvI0qD18qycQx+mFykh5fBlto=
 github.com/erikgeiser/coninput v0.0.0-20211004153227-1c3628e74d0f h1:Y/CXytFA4m6baUTXGLOoWe4PQhGxaX0KpnayAqC48p4=
@@ -56,12 +74,12 @@ github.com/spf13/pflag v1.0.9/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An
 github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e h1:JVG44RsyaB9T2KIHavMF/ppJZNG9ZpyihvCd0w101no=
 github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e/go.mod h1:RbqR21r5mrJuqunuUZ/Dhy/avygyECGrLceyNeo4LiM=
 go.yaml.in/yaml/v3 v3.0.4/go.mod h1:DhzuOOF2ATzADvBadXxruRBLzYTpT36CKvDb3+aBEFg=
-golang.org/x/sync v0.15.0 h1:KWH3jNZsfyT6xfAfKiz6MRNmd46ByHDYaZ7KSkCtdW8=
-golang.org/x/sync v0.15.0/go.mod h1:1dzgHSNfp02xaA81J2MS99Qcpr2w7fw1gpm99rleRqA=
+golang.org/x/exp v0.0.0-20231006140011-7918f672742d h1:jtJma62tbqLibJ5sFQz8bKtEM8rJBtfilJ2qTU199MI=
+golang.org/x/exp v0.0.0-20231006140011-7918f672742d/go.mod h1:ldy0pHrwJyGW56pPQzzkH36rKxoZW1tw7ZJpeKx+hdo=
 golang.org/x/sys v0.0.0-20210809222454-d867a43fc93e/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.33.0 h1:q3i8TbbEz+JRD9ywIRlyRAQbM0qF7hu24q3teo2hbuw=
-golang.org/x/sys v0.33.0/go.mod h1:BJP2sWEmIv4KK5OTEluFJCKSidICx8ciO85XgH3Ak8k=
+golang.org/x/sys v0.36.0 h1:KVRy2GtZBrk1cBYA7MKu5bEZFxQk4NIDV6RLVcC8o0k=
+golang.org/x/sys v0.36.0/go.mod h1:OgkHotnGiDImocRcuBABYBEXf8A9a87e/uXjp9XT3ks=
 golang.org/x/text v0.23.0 h1:D71I7dUrlY+VX0gQShAThNGHFxZ13dGLBHQLVl1mJlY=
 golang.org/x/text v0.23.0/go.mod h1:/BLNzu4aZCJ1+kcD0DNRotWKage4q2rGVAg4o22unh4=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=

internal/goforge/forge.go

@@ -6,22 +6,33 @@ import (
 
 	"github.com/andrearcaina/goforge/internal/spec"
 	"github.com/andrearcaina/goforge/internal/ui"
+	"github.com/charmbracelet/huh/spinner"
 )
 
-func Forge(initial *spec.Config) error {
-	// try to run the ui
-	cfg, err := ui.Run(initial)
-	if err != nil {
-		return errors.New("ui failed")
+func Forge(cfg *spec.Config) error {
+	if cfg.Default {
+		cfg.Form = spec.Form{
+			Name:           "example-server",
+			ServerTypeFlag: "rest",
+		}
+	} else {
+		if err := ui.Run(cfg); err != nil {
+			return errors.New("failed to run ui form")
+		}
 	}
 
-	// try to generate the file
-	if err := Generate(cfg); err != nil {
-		return errors.New("generating file failed")
+	var err error
+	_ = spinner.New().
+		Title("Forging your project...").
+		Action(func() {
+			err = Generate(cfg)
+		}).Run()
+
+	if err != nil {
+		return fmt.Errorf("failed to generate the file: %w", err)
 	}
 
-	fmt.Println("File generated successfully")
+	ui.OutputSuccess(cfg)
 
-	// success if none fails
 	return nil
 }

internal/goforge/generator.go

@@ -1,43 +1,118 @@
 package goforge
 
 import (
+	"errors"
+	"fmt"
 	"os"
 	"path/filepath"
 	"text/template"
+	"time"
 
 	"github.com/andrearcaina/goforge/internal/spec"
 	"github.com/andrearcaina/goforge/internal/templates"
 )
 
 func Generate(cfg *spec.Config) error {
-	// parse the template from the embedded FS
-	tmpl, err := template.ParseFS(templates.FS, "hello.go.tmpl")
-	if err != nil {
+	if cfg.Form.ServerTypeFlag == "rest" {
+		return generateRESTServer(cfg)
+	}
+
+	return errors.New("unknown server type")
+}
+
+func generateRESTServer(cfg *spec.Config) error {
+	dirs := []string{
+		"cmd/server",
+		"internal/api",
+		"internal/config",
+	}
+
+	if cfg.Form.DatabaseFlag {
+		dirs = append(dirs, "internal/db")
+	}
+
+	for _, dir := range dirs {
+		fullPath := filepath.Join(cfg.OutputPath, dir)
+		if err := os.MkdirAll(fullPath, 0755); err != nil {
+			return err
+		}
+	}
+
+	if err := generateFile("go.mod.tmpl", filepath.Join(cfg.OutputPath, "go.mod"), cfg); err != nil {
 		return err
 	}
 
-	var out *os.File
-	if cfg.OutputPath != "" {
-		// ensure the directory exists
-		fullPath := filepath.Join(cfg.OutputPath, "hello.go")
+	if err := generateFile("config.go.tmpl", filepath.Join(cfg.OutputPath, "internal/config/config.go"), cfg); err != nil {
+		return err
+	}
+	if err := generateFile("main.go.tmpl", filepath.Join(cfg.OutputPath, "cmd/server/main.go"), cfg); err != nil {
+		return err
+	}
 
-		// if it doesn't exist, create it
-		if err := os.MkdirAll(filepath.Dir(fullPath), 0755); err != nil {
+	if err := generateFile("rest/server.go.tmpl", filepath.Join(cfg.OutputPath, "internal/api/server.go"), cfg); err != nil {
+		return err
+	}
+
+	if err := generateFile("rest/handler.go.tmpl", filepath.Join(cfg.OutputPath, "internal/api/handler.go"), cfg); err != nil {
+		return err
+	}
+
+	if err := generateFile("rest/service.go.tmpl", filepath.Join(cfg.OutputPath, "internal/api/service.go"), cfg); err != nil {
+		return err
+	}
+
+	if err := generateFile("rest/types.go.tmpl", filepath.Join(cfg.OutputPath, "internal/api/types.go"), cfg); err != nil {
+		return err
+	}
+
+	if cfg.Form.DatabaseFlag {
+		if err := os.MkdirAll(filepath.Join(cfg.OutputPath, "internal/db/generated"), 0755); err != nil {
 			return err
 		}
 
-		// create the file
-		f, err := os.Create(fullPath)
-		if err != nil {
+		if err := generateFile("db/db.go.tmpl", filepath.Join(cfg.OutputPath, "internal/db/db.go"), cfg); err != nil {
 			return err
 		}
 
-		defer f.Close()
-		out = f
-	} else {
-		out = os.Stdout
+		if err := generateFile("sqlc.yaml.tmpl", filepath.Join(cfg.OutputPath, "sqlc.yaml"), cfg); err != nil {
+			return err
+		}
+
+		timestamp := time.Now().Format("20060102150405")
+		migrationFile := fmt.Sprintf("db/migrations/%s_init.sql", timestamp)
+		if err := generateFile("db/migrations/init.sql.tmpl", filepath.Join(cfg.OutputPath, "internal", migrationFile), cfg); err != nil {
+			return err
+		}
+
+		if err := generateFile("db/queries/user.sql.tmpl", filepath.Join(cfg.OutputPath, "internal/db/queries/user.sql"), cfg); err != nil {
+			return err
+		}
+	}
+
+	return nil
+}
+
+func generateFile(tmplPath, outputPath string, data interface{}) error {
+	tmpl, err := template.ParseFS(templates.FS, tmplPath)
+	if err != nil {
+		return err
+	}
+
+	// ensure the directory exists
+	if err := os.MkdirAll(filepath.Dir(outputPath), 0755); err != nil {
+		return err
+	}
+
+	// create the file
+	out, err := os.Create(outputPath)
+	if err != nil {
+		return err
+	}
+	defer out.Close()
+
+	if err := tmpl.Execute(out, data); err != nil {
+		return err
 	}
 
-	// execute the template (write to file or stdout)
-	return tmpl.Execute(out, cfg)
+	return nil
 }

internal/spec/config.go

@@ -1,11 +1,22 @@
 package spec
 
+// ServerTypeFlag is an enum and can be one of the following values
+type ServerTypeFlag string
+
+const (
+	REST    ServerTypeFlag = "rest"
+	GRPC    ServerTypeFlag = "grpc"
+	GraphQL ServerTypeFlag = "graphql"
+)
+
 type Config struct {
 	OutputPath string
+	Default    bool
 	Form       Form
 }
 
 type Form struct {
-	SomeFlag    string
-	AnotherFlag string
+	Name           string
+	ServerTypeFlag ServerTypeFlag
+	DatabaseFlag   bool
 }