@nakedev/go-scaffold 0.1.0 → 0.1.2

package/README.md

@@ -12,22 +12,26 @@ same shape as the last one.
 ## Install
 
 ```bash
-pnpm install
-pnpm run build
+npm install -g @nakedev/go-scaffold
 ```
 
-`npm link` / `pnpm link --global` may not put the binary on your `PATH`
-depending on your machine's npm/pnpm global-bin config — rather than fight
-that, run the CLI directly, or add a shell alias once:
+Or run it without installing:
+
+```bash
+npx @nakedev/go-scaffold create my-api
+```
+
+Working on the CLI itself (not just using it)? Clone the repo, then:
 
 ```bash
+pnpm install
+pnpm run build
 node bin/go-scaffold.js create my-api --defaults
-# or: alias go-scaffold="node $(pwd)/bin/go-scaffold.js"
 ```
 
-The rest of this README uses the bare `go-scaffold ...` form for brevity —
-substitute the `node bin/go-scaffold.js ...` form or your alias if you
-haven't linked it.
+`npm link` / `pnpm link --global` may not put the binary on your `PATH`
+depending on your machine's npm/pnpm global-bin config — running
+`node bin/go-scaffold.js ...` directly sidesteps that.
 
 ## Quick start
 

package/package.json

@@ -1,7 +1,11 @@
 {
   "name": "@nakedev/go-scaffold",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Scaffold Gin + GORM + Postgres Go backend projects with a consistent domain-module standard",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/NakePranob/go-scaffold.git"
+  },
   "bin": {
     "go-scaffold": "./bin/go-scaffold.js"
   },

package/templates/create/base/Makefile.hbs

@@ -7,7 +7,7 @@ PGPASSWORD ?= postgres
 .PHONY: run build test fmt vet lint tidy db-create db-drop migrate-up migrate-down{{#if openapiDocs}} openapi-bundle{{/if}}{{#if docker}} docker-up docker-down{{/if}}
 
 run:
-	go run ./cmd/api
+	@[ -f .env ] && export $$(grep -v '^#' .env | xargs); go run ./cmd/api
 
 build:
 	go build -o bin/api ./cmd/api

package/templates/create/base/README.md.hbs

@@ -38,10 +38,12 @@ make docker-up                     # local Postgres (postgres:5432)
 make db-create                     # create the {{dbName}} database itself (once — safe to re-run)
 go mod tidy
 make run                           # AUTO_MIGRATE=true creates the schema automatically in dev
-# or override with env (the app reads os.Getenv directly, see .env.example):
-export $(grep -v '^#' .env.example | xargs) && make run
 ```
 
+`make run` loads `.env` if present (copy `.env.example` to `.env` to override
+defaults — the app itself just reads `os.Getenv`, no `.env` parsing at
+runtime).
+
 `make db-create` connects to Postgres at `DB_HOST`/`DB_PORT`/`DB_USER` (default:
 `localhost`/`5432`/`postgres`, matching `.env.example`) using the `psql`
 client — works the same whether Postgres came from `make docker-up` or an

package/templates/create/features/docs/patterns.md.hbs

@@ -86,6 +86,37 @@ if this project has one):
    pre-check existence before insert; let the DB enforce it atomically and
    catch the error — a pre-check has a TOCTOU race.
 
+## Calling Another Domain's Logic
+
+For behavior, not just a data reference (e.g. `order` needs `user`'s email
+to put on a receipt) — the caller's `service.go` declares its own narrow
+interface for exactly what it needs, the same way it already declares a
+`repository` interface:
+
+```go
+// order/service.go
+type userLookup interface {
+    GetByID(ctx context.Context, id uuid.UUID) (user.Response, error)
+}
+```
+
+`cmd/api/main.go` wires the concrete `user` service in — it already
+satisfies the interface, no adapter needed:
+
+```go
+userSvc := user.NewService(userRepo)
+orderSvc := order.NewService(orderRepo, userSvc)
+```
+
+- **One direction only.** If `user` would need to call back into `order`,
+  don't wire it both ways — either the two belong in one domain, or the
+  callback needs an event/queue, not a direct call.
+- **Don't use this to replace a FK check.** Calling `userLookup.GetByID`
+  to verify a user exists before inserting an order is the same TOCTOU race
+  rule 3 above warns about — let the FK constraint catch it instead. Use
+  this pattern only when the caller needs actual data from the other
+  domain, not just its existence.
+
 ## Adding One Endpoint — `generate method`
 
 ```bash