Skip to content

Commit b3fa0e2

Browse files
mathieusouflismathieusouflis
committed
feat(generators): update version numbers and improve documentation for various generators
1 parent 9dc520f commit b3fa0e2

8 files changed

Lines changed: 139 additions & 139 deletions

‎docs/contributor/generators/auth_better_auth.md‎

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,18 @@ BetterAuth session-based authentication. Creates `src/lib/auth.ts` (auth instanc
66

77
## Identity
88

9-
| Field | Value |
10-
|-------|-------|
11-
| Name | `auth_better_auth` |
12-
| Version | `0.2.0` |
9+
| Field | Value |
10+
| ------- | ----------------------------- |
11+
| Name | `auth_better_auth` |
12+
| Version | `0.2.2` |
1313
| Package | `generators/auth_better_auth` |
1414

1515
---
1616

1717
## Dependencies
1818

19-
| Generator | Why |
20-
|-----------|-----|
19+
| Generator | Why |
20+
| -------------------------- | ------------------------------------------------------------------------ |
2121
| `drizzle_postgres_adapter` | BetterAuth uses the Drizzle adapter which requires an active `db` export |
2222

2323
---
@@ -30,26 +30,26 @@ None — selection is driven by `flows/init.go` (`ts-backend-auth-method = bette
3030

3131
## Files written
3232

33-
| Path | Description |
34-
|------|-------------|
33+
| Path | Description |
34+
| ----------------- | ---------------------------------------------------------------------- |
3535
| `src/lib/auth.ts` | BetterAuth instance with Drizzle PG adapter and email/password enabled |
36-
| `.env.example` | Appends `BETTER_AUTH_SECRET` and `BETTER_AUTH_URL` |
36+
| `.env.example` | Appends `BETTER_AUTH_SECRET` and `BETTER_AUTH_URL` |
3737

3838
Also merges into:
3939

40-
| Path | Keys added / updated |
41-
|------|---------------------|
42-
| `package.json` | `dependencies.better-auth`, `dependencies.cookie-parser`, `devDependencies.@types/cookie-parser` |
43-
| `src/app.ts` | Imports `cookieParser`, `toNodeHandler`, `auth`; adds `app.use(cookieParser())` and `app.all('/api/auth/*', toNodeHandler(auth))` directly (no intermediate route file) |
40+
| Path | Keys added / updated |
41+
| -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
42+
| `package.json` | `dependencies.better-auth`, `dependencies.cookie-parser`, `devDependencies.@types/cookie-parser` |
43+
| `src/app.ts` | Imports `cookieParser`, `toNodeHandler`, `auth`; adds `app.use(cookieParser())` and `app.all('/api/auth/*', toNodeHandler(auth))` directly (no intermediate route file) |
4444

4545
---
4646

4747
## Validators
4848

49-
| Check | Type | Passes when |
50-
|-------|------|-------------|
51-
| `src/lib/auth.ts` | `file_exists` | — |
52-
| `dependencies.better-auth` in `package.json` | `json_key_exists` | — |
49+
| Check | Type | Passes when |
50+
| -------------------------------------------- | ----------------- | ----------- |
51+
| `src/lib/auth.ts` | `file_exists` | — |
52+
| `dependencies.better-auth` in `package.json` | `json_key_exists` | — |
5353

5454
---
5555

‎docs/contributor/generators/auth_jwt_vanilla.md‎

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,18 @@ Vanilla JWT authentication. Creates `src/shared/services/jwt.ts` (sign/verify he
66

77
## Identity
88

9-
| Field | Value |
10-
|-------|-------|
11-
| Name | `auth_jwt_vanilla` |
12-
| Version | `0.1.0` |
9+
| Field | Value |
10+
| ------- | ----------------------------- |
11+
| Name | `auth_jwt_vanilla` |
12+
| Version | `0.1.3` |
1313
| Package | `generators/auth_jwt_vanilla` |
1414

1515
---
1616

1717
## Dependencies
1818

19-
| Generator | Why |
20-
|-----------|-----|
19+
| Generator | Why |
20+
| --------------------------- | ---------------------------------------------- |
2121
| `express_server_entrypoint` | `.env.example` and `src/` directory must exist |
2222

2323
---
@@ -30,34 +30,34 @@ None.
3030

3131
## Files written
3232

33-
| Path | Description |
34-
|------|-------------|
35-
| `src/shared/services/jwt.ts` | `signToken`, `signRefreshToken`, and `verifyToken<T>` helpers backed by `process.env.JWT_SECRET` |
36-
| `src/shared/middlewares/auth.middleware.ts` | Express middleware that validates `Authorization: Bearer <token>` headers |
37-
| `.env.example` | Appends `JWT_SECRET` and `JWT_EXPIRES_IN` |
33+
| Path | Description |
34+
| ------------------------------------------- | ------------------------------------------------------------------------------------------------ |
35+
| `src/shared/services/jwt.ts` | `signToken`, `signRefreshToken`, and `verifyToken<T>` helpers backed by `process.env.JWT_SECRET` |
36+
| `src/shared/middlewares/auth.middleware.ts` | Express middleware that validates `Authorization: Bearer <token>` headers |
37+
| `.env.example` | Appends `JWT_SECRET` and `JWT_EXPIRES_IN` |
3838

3939
Also merges into:
4040

41-
| Path | Keys added / updated |
42-
|------|---------------------|
41+
| Path | Keys added / updated |
42+
| -------------- | ------------------------------------------------------------------ |
4343
| `package.json` | `dependencies.jsonwebtoken`, `devDependencies.@types/jsonwebtoken` |
4444

4545
---
4646

4747
## Validators
4848

49-
| Check | Type | Passes when |
50-
|-------|------|-------------|
51-
| `src/shared/services/jwt.ts` | `file_exists` | — |
52-
| `src/shared/middlewares/auth.middleware.ts` | `file_exists` | — |
53-
| `dependencies.jsonwebtoken` in `package.json` | `json_key_exists` | — |
49+
| Check | Type | Passes when |
50+
| --------------------------------------------- | ----------------- | ----------- |
51+
| `src/shared/services/jwt.ts` | `file_exists` | — |
52+
| `src/shared/middlewares/auth.middleware.ts` | `file_exists` | — |
53+
| `dependencies.jsonwebtoken` in `package.json` | `json_key_exists` | — |
5454

5555
---
5656

5757
## Post-generation commands
5858

59-
| Command | WorkDir | Notes |
60-
|---------|---------|-------|
59+
| Command | WorkDir | Notes |
60+
| -------------- | ------------ | ------- |
6161
| `pnpm install` | project root | Deduped |
6262

6363
## Test commands
@@ -71,9 +71,9 @@ No TestCommands.
7171
When `express_decorators_core` ran earlier in the pipeline, this generator additionally patches `src/app.ts` to wire the JWT middleware into `ExpressRouterAdapter`:
7272

7373
```ts
74-
import { authMiddleware } from './shared/middlewares/auth.middleware';
74+
import { authMiddleware } from "./shared/middlewares/auth.middleware";
7575
// ...
76-
new ExpressRouterAdapter({ authMiddleware })
76+
new ExpressRouterAdapter({ authMiddleware });
7777
```
7878

7979
That makes every `@Auth()`-decorated route gated by JWT verification automatically. Detection is done via `slices.Contains(ctx.PreviousGens, "express_decorators_core")` — there is no extra answer to set.

‎docs/contributor/generators/drizzle_postgres_adapter.md‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,18 @@ Adds the `postgres` npm driver to `package.json` and creates `src/db/index.ts`
66

77
## Identity
88

9-
| Field | Value |
10-
|-------|-------|
11-
| Name | `drizzle_postgres_adapter` |
12-
| Version | `0.1.0` |
9+
| Field | Value |
10+
| ------- | ------------------------------------- |
11+
| Name | `drizzle_postgres_adapter` |
12+
| Version | `0.1.1` |
1313
| Package | `generators/drizzle_postgres_adapter` |
1414

1515
---
1616

1717
## Dependencies
1818

19-
| Generator | Why |
20-
|-----------|-----|
19+
| Generator | Why |
20+
| ------------------------- | ------------------------------------------------------- |
2121
| `drizzle_typescript_deps` | `drizzle-orm` must be declared before adding the driver |
2222

2323
---
@@ -30,31 +30,31 @@ None.
3030

3131
## Files written
3232

33-
| Path | Description |
34-
|------|-------------|
33+
| Path | Description |
34+
| ----------------- | ----------------------------------------------------------- |
3535
| `src/db/index.ts` | Drizzle singleton: connects via `postgres-js`, exports `db` |
3636

3737
Also merges into:
3838

39-
| Path | Keys added / updated |
40-
|------|---------------------|
39+
| Path | Keys added / updated |
40+
| -------------- | ----------------------- |
4141
| `package.json` | `dependencies.postgres` |
4242

4343
---
4444

4545
## Validators
4646

47-
| Check | Type | Passes when |
48-
|-------|------|-------------|
49-
| `src/db/index.ts` | `file_exists` | — |
50-
| `dependencies.postgres` in `package.json` | `json_key_exists` | — |
47+
| Check | Type | Passes when |
48+
| ----------------------------------------- | ----------------- | ----------- |
49+
| `src/db/index.ts` | `file_exists` | — |
50+
| `dependencies.postgres` in `package.json` | `json_key_exists` | — |
5151

5252
---
5353

5454
## Post-generation commands
5555

56-
| Command | WorkDir | Notes |
57-
|---------|---------|-------|
56+
| Command | WorkDir | Notes |
57+
| -------------- | ------------ | ------- |
5858
| `pnpm install` | project root | Deduped |
5959

6060
## Test commands

‎docs/contributor/generators/drizzle_typescript_deps.md‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,18 @@ Adds `drizzle-orm` (runtime) and `drizzle-kit` (devDep) to `package.json` and re
66

77
## Identity
88

9-
| Field | Value |
10-
|-------|-------|
11-
| Name | `drizzle_typescript_deps` |
12-
| Version | `0.1.0` |
9+
| Field | Value |
10+
| ------- | ------------------------------------ |
11+
| Name | `drizzle_typescript_deps` |
12+
| Version | `0.1.2` |
1313
| Package | `generators/drizzle_typescript_deps` |
1414

1515
---
1616

1717
## Dependencies
1818

19-
| Generator | Why |
20-
|-----------|-----|
19+
| Generator | Why |
20+
| --------------------- | ----------------------------------------------------- |
2121
| `drizzle_config_base` | Config file must exist before adding the tooling deps |
2222

2323
---
@@ -32,26 +32,26 @@ None.
3232

3333
Also merges into:
3434

35-
| Path | Keys added / updated |
36-
|------|---------------------|
35+
| Path | Keys added / updated |
36+
| -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
3737
| `package.json` | `dependencies.drizzle-orm`, `devDependencies.drizzle-kit`, `scripts.db:generate`, `scripts.db:migrate`, `scripts.db:push`, `scripts.db:studio` |
3838

3939
---
4040

4141
## Validators
4242

43-
| Check | Type | Passes when |
44-
|-------|------|-------------|
45-
| `dependencies.drizzle-orm` in `package.json` | `json_key_exists` | — |
46-
| `devDependencies.drizzle-kit` in `package.json` | `json_key_exists` | — |
47-
| `scripts.db:push` in `package.json` | `json_key_exists` | — |
43+
| Check | Type | Passes when |
44+
| ----------------------------------------------- | ----------------- | ----------- |
45+
| `dependencies.drizzle-orm` in `package.json` | `json_key_exists` | — |
46+
| `devDependencies.drizzle-kit` in `package.json` | `json_key_exists` | — |
47+
| `scripts.db:push` in `package.json` | `json_key_exists` | — |
4848

4949
---
5050

5151
## Post-generation commands
5252

53-
| Command | WorkDir | Notes |
54-
|---------|---------|-------|
53+
| Command | WorkDir | Notes |
54+
| -------------- | ------------ | ------- |
5555
| `pnpm install` | project root | Deduped |
5656

5757
## Test commands

‎docs/contributor/generators/express_server_typescript_deps.md‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,18 @@ Merges Express, CORS, dotenv runtime dependencies plus types, tsx, nodemon devDe
66

77
## Identity
88

9-
| Field | Value |
10-
|-------|-------|
11-
| Name | `express_server_typescript_deps` |
12-
| Version | `0.1.0` |
9+
| Field | Value |
10+
| ------- | ------------------------------------------- |
11+
| Name | `express_server_typescript_deps` |
12+
| Version | `0.1.5` |
1313
| Package | `generators/express_server_typescript_deps` |
1414

1515
---
1616

1717
## Dependencies
1818

19-
| Generator | Why |
20-
|-----------|-----|
19+
| Generator | Why |
20+
| --------------------------- | ---------------------------------------------------------------- |
2121
| `express_server_entrypoint` | Source files that reference express/cors/dotenv must exist first |
2222

2323
---
@@ -32,27 +32,27 @@ None.
3232

3333
Also merges into:
3434

35-
| Path | Keys added / updated |
36-
|------|---------------------|
35+
| Path | Keys added / updated |
36+
| -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
3737
| `package.json` | `scripts.dev`, `scripts.build`, `scripts.start`, `dependencies.express`, `dependencies.cors`, `dependencies.dotenv`, `devDependencies.@types/express`, `devDependencies.@types/cors`, `devDependencies.@types/node`, `devDependencies.tsx`, `devDependencies.nodemon` |
3838

3939
---
4040

4141
## Validators
4242

43-
| Check | Type | Passes when |
44-
|-------|------|-------------|
45-
| `dependencies.express` in `package.json` | `json_key_exists` | — |
46-
| `scripts.dev` in `package.json` | `json_key_exists` | — |
47-
| `scripts.build` in `package.json` | `json_key_exists` | — |
48-
| `scripts.start` in `package.json` | `json_key_exists` | — |
43+
| Check | Type | Passes when |
44+
| ---------------------------------------- | ----------------- | ----------- |
45+
| `dependencies.express` in `package.json` | `json_key_exists` | — |
46+
| `scripts.dev` in `package.json` | `json_key_exists` | — |
47+
| `scripts.build` in `package.json` | `json_key_exists` | — |
48+
| `scripts.start` in `package.json` | `json_key_exists` | — |
4949

5050
---
5151

5252
## Post-generation commands
5353

54-
| Command | WorkDir | Notes |
55-
|---------|---------|-------|
54+
| Command | WorkDir | Notes |
55+
| -------------- | ------------ | ----------------------------- |
5656
| `pnpm install` | project root | Deduped with other generators |
5757

5858
## Test commands

0 commit comments

Comments
 (0)