Skip to content

Commit 5e554a2

Browse files
committed
docs: update deprecated flags in muxt-complete.md
- --find-receiver-type → --use-receiver-type - --find-receiver-type-package → --use-receiver-type-package - --logger → --output-routes-func-with-logger-param - --path-prefix → --output-routes-func-with-path-prefix-param - --find-receiver-type → --use-receiver-type - --logger → --output-routes-func-with-logger-param - --find-receiver-type → --use-receiver-type - --find-receiver-type → --use-receiver-type - --find-receiver-type-package → --use-receiver-type-package - --find-receiver-type → --use-receiver-type - --find-templates-variable → --use-templates-variable - --find-receiver-type → --use-receiver-type
1 parent 12e4276 commit 5e554a2

6 files changed

Lines changed: 28 additions & 28 deletions

File tree

docs/explanation/advanced-patterns.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -128,10 +128,10 @@ import (
128128
//go:embed admin/ public/ shared/
129129
var templateSource embed.FS
130130

131-
//go:generate muxt generate --find-templates-variable=publicTmpl --output-routes-func=PublicRoutes --output-file=routes_public.go --output-receiver-interface=PublicHandler
131+
//go:generate muxt generate --use-templates-variable=publicTmpl --output-routes-func=PublicRoutes --output-file=routes_public.go --output-receiver-interface=PublicHandler
132132
var publicTmpl = template.Must(template.Must(template.ParseFS(templateSource, "shared/*.gohtml")).ParseFS(templateSource, "public/*.gohtml"))
133133

134-
//go:generate muxt generate --find-templates-variable=adminTmpl --output-routes-func=AdminRoutes --output-file=routes_admin.go --output-receiver-interface=AdminHandler
134+
//go:generate muxt generate --use-templates-variable=adminTmpl --output-routes-func=AdminRoutes --output-file=routes_admin.go --output-receiver-interface=AdminHandler
135135
var adminTmpl = template.Must(template.Must(template.ParseFS(templateSource, "shared/*.gohtml")).ParseFS(templateSource, "admin/*.gohtml"))
136136
```
137137

@@ -230,7 +230,7 @@ func TestGetPortfolio(t *testing.T) {
230230
//go:embed *.gohtml
231231
var fs embed.FS
232232

233-
//go:generate muxt generate --find-receiver-type=Server
233+
//go:generate muxt generate --use-receiver-type=Server
234234
var templates = template.Must(
235235
template.New("").
236236
Funcs(template.FuncMap{

docs/explanation/package-structure.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ var templates = template.Must(template.ParseFS(templatesDir, "**/*.gohtml", "*.g
9090
### Pattern 1: Inline Templates
9191

9292
```go
93-
//go:generate muxt generate --find-receiver-type=Client
93+
//go:generate muxt generate --use-receiver-type=Client
9494
var templates = template.Must(template.New("GET / List()").Parse(`
9595
<ul>
9696
{{range .Result}}
@@ -131,7 +131,7 @@ var templates = template.Must(template.ParseFS(templatesDir, "*.gohtml"))
131131
//go:embed pages/*.gohtml components/*.gohtml layouts/*.gohtml
132132
var templatesDir embed.FS
133133

134-
//go:generate muxt generate --find-receiver-type=App
134+
//go:generate muxt generate --use-receiver-type=App
135135
var templates = template.Must(template.ParseFS(templatesDir,
136136
"pages/*.gohtml",
137137
"components/*.gohtml",
@@ -147,7 +147,7 @@ var templates = template.Must(template.ParseFS(templatesDir,
147147
//go:embed **/*.gohtml
148148
var templatesDir embed.FS
149149

150-
//go:generate muxt generate --find-receiver-type=App
150+
//go:generate muxt generate --use-receiver-type=App
151151
var templates = template.Must(template.ParseFS(templatesDir, "**/*.gohtml"))
152152
```
153153

@@ -159,7 +159,7 @@ var templates = template.Must(template.ParseFS(templatesDir, "**/*.gohtml"))
159159
//go:embed **/*.gohtml
160160
var templatesDir embed.FS
161161

162-
//go:generate muxt generate --find-receiver-type=App
162+
//go:generate muxt generate --use-receiver-type=App
163163
var templates = template.Must(
164164
template.New("").
165165
Funcs(customFuncs).

docs/how-to/integrate-existing-project.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ func (s *Server) UserProfile(w http.ResponseWriter, r *http.Request) {
3535
**Validate:**
3636
```bash
3737
go install github.com/typelate/muxt/cmd/muxt@latest
38-
muxt check --find-receiver-type=Server
38+
muxt check --use-receiver-type=Server
3939
```
4040

4141
**Value:** Catch template errors at build time. Team learns Muxt semantics before changing architecture.
@@ -62,13 +62,13 @@ import ("embed"; "html/template")
6262
//go:embed *.gohtml */*.gohtml
6363
var fs embed.FS
6464

65-
//go:generate muxt generate --find-receiver-type=Server --find-receiver-type-package=github.com/yourorg/yourapp/internal/domain --output-routes-func=Routes
65+
//go:generate muxt generate --use-receiver-type=Server --use-receiver-type-package=github.com/yourorg/yourapp/internal/domain --output-routes-func=Routes
6666
var templates = template.Must(template.ParseFS(fs, "*.gohtml", "*/*.gohtml"))
6767
```
6868

6969
**Critical:**
7070
- `templates` must be package-level (Muxt finds via static analysis)
71-
- `--find-receiver-type-package` points to your domain package
71+
- `--use-receiver-type-package` points to your domain package
7272
- `--output-routes-func` names the registration function (default: `TemplateRoutes`)
7373

7474
**For complex layouts:**

docs/prompts/muxt-complete.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -34,17 +34,17 @@ func (d TemplateData[T]) Header(k, v string) TemplateData[T] // Set header
3434

3535
```bash
3636
muxt generate \
37-
--find-receiver-type=Server \
38-
--find-receiver-type-package=github.com/app/server \
37+
--use-receiver-type=Server \
38+
--use-receiver-type-package=github.com/app/server \
3939
--output-file=routes.go \
4040
--output-routes-func=TemplateRoutes \
4141
--output-receiver-interface=RoutesReceiver \
42-
--logger \
43-
--path-prefix
42+
--output-routes-func-with-logger-param \
43+
--output-routes-func-with-path-prefix-param
4444
```
4545

46-
With `--logger`: `func TemplateRoutes(mux, receiver, logger *slog.Logger)`
47-
With `--path-prefix`: `func TemplateRoutes(mux, receiver, prefix string)`
46+
With `--output-routes-func-with-logger-param`: `func TemplateRoutes(mux, receiver, logger *slog.Logger)`
47+
With `--output-routes-func-with-path-prefix-param`: `func TemplateRoutes(mux, receiver, prefix string)`
4848

4949
## Generated File Structure
5050

@@ -187,8 +187,8 @@ type Server struct {
187187
**Cross-package receiver:**
188188
```bash
189189
muxt generate \
190-
--find-receiver-type=Server \
191-
--find-receiver-type-package=github.com/app/internal/server
190+
--use-receiver-type=Server \
191+
--use-receiver-type-package=github.com/app/internal/server
192192
```
193193

194194
**url.Values parameter:**

docs/prompts/muxt-guide.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ import (
9797
//go:embed *.gohtml
9898
var templateFS embed.FS
9999

100-
//go:generate muxt generate --find-receiver-type=Server
100+
//go:generate muxt generate --use-receiver-type=Server
101101
var templates = template.Must(template.ParseFS(templateFS, "*.gohtml"))
102102

103103
type Server struct{ db Database }
@@ -118,16 +118,16 @@ Run: `go generate && go run .`
118118
## CLI
119119

120120
```bash
121-
muxt generate --find-receiver-type=Server # Generate handlers
122-
muxt check --find-receiver-type=Server # Type check only
123-
muxt generate --find-receiver-type=Server --logger --path-prefix
121+
muxt generate --use-receiver-type=Server # Generate handlers
122+
muxt check --use-receiver-type=Server # Type check only
123+
muxt generate --use-receiver-type=Server --output-routes-func-with-logger-param --output-routes-func-with-path-prefix-param
124124
```
125125

126126
Key flags:
127-
- `--find-receiver-type=T` — Type with handler methods
127+
- `--use-receiver-type=T` — Type with handler methods
128128
- `--output-file=routes.go` — Output filename
129-
- `--logger` — Add `*slog.Logger` parameter
130-
- `--path-prefix` — Add path prefix parameter
129+
- `--output-routes-func-with-logger-param` — Add `*slog.Logger` parameter
130+
- `--output-routes-func-with-path-prefix-param` — Add path prefix parameter
131131
- `-C ./web` — Run from directory
132132

133133
## Generated Files

docs/prompts/muxt-quick.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ func (s Server) M() error // .Err=error
5757
//go:embed *.gohtml
5858
var templateFS embed.FS
5959

60-
//go:generate muxt generate --find-receiver-type=Server
60+
//go:generate muxt generate --use-receiver-type=Server
6161
var templates = template.Must(template.ParseFS(templateFS, "*.gohtml"))
6262

6363
type Server struct{
@@ -78,8 +78,8 @@ func main() {
7878
## Commands
7979

8080
```bash
81-
muxt generate --find-receiver-type=Server # Generate handlers
82-
muxt check --find-receiver-type=Server # Type check only
81+
muxt generate --use-receiver-type=Server # Generate handlers
82+
muxt check --use-receiver-type=Server # Type check only
8383
```
8484

8585
See [muxt-guide.md](muxt-guide.md) for complete documentation.

0 commit comments

Comments
 (0)