feat(turbo): turbo gen feature generator (Phase 1, single-entity)
Adds `pnpm turbo gen feature` to scaffold a Lazar-conformant feature package matching the navigation reference shape: entity + Zod schema, single use case (`get<Entity>`), controller, mock + Payload-stub real repository (with span + capture), DI module/container/symbols, and tRPC router with full BAD_REQUEST/NOT_FOUND error mapping. The generated `bind-production.ts` and `bind-dev-seed.ts` compose the post-R44 `withSpan(tracer, opts, withCapture(logger, tags, factory(deps)))` sandwich at bind time. Verified by generating a sample `packages/example/` feature and running `pnpm --filter @repo/example lint typecheck test` — all three pass (9 test files, 25 tests). Cleaned up after verification so no example package is committed. Phase-1 limitations (documented in `docs/guides/scaffolding-a-feature.md` and printed by the generator on success): no Payload CMS templates, no React Query helpers, faker-driven factories left as stubs, single entity / single use case, and aggregator wiring (core-api/root, apps/web-next bindAll) is left as a manual checklist. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
@@ -0,0 +1,56 @@
|
||||
import "reflect-metadata";
|
||||
import { afterEach, beforeEach, describe, expect, it } from "vitest";
|
||||
import { NoopTracer, NoopLogger } from "@repo/core-shared/instrumentation";
|
||||
import { bindDevSeed{{pascalCase name}} } from "@/di/bind-dev-seed";
|
||||
import { {{camelCase name}}Container } from "@/di/container";
|
||||
import { {{constantCase name}}_SYMBOLS } from "@/di/symbols";
|
||||
import { Mock{{pascalCase entity}}Repository } from "@/infrastructure/repositories/{{kebabCase entity}}.repository.mock";
|
||||
import type { I{{pascalCase entity}}Repository } from "@/application/repositories/{{kebabCase entity}}.repository.interface";
|
||||
|
||||
const noop = { tracer: new NoopTracer(), logger: new NoopLogger() };
|
||||
|
||||
describe("bindDevSeed{{pascalCase name}}", () => {
|
||||
beforeEach(() => {
|
||||
if ({{camelCase name}}Container.isBound({{constantCase name}}_SYMBOLS.I{{pascalCase entity}}Repository)) {
|
||||
{{camelCase name}}Container.unbind({{constantCase name}}_SYMBOLS.I{{pascalCase entity}}Repository);
|
||||
}
|
||||
{{camelCase name}}Container
|
||||
.bind<I{{pascalCase entity}}Repository>({{constantCase name}}_SYMBOLS.I{{pascalCase entity}}Repository)
|
||||
.to(Mock{{pascalCase entity}}Repository);
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
if ({{camelCase name}}Container.isBound({{constantCase name}}_SYMBOLS.I{{pascalCase entity}}Repository)) {
|
||||
{{camelCase name}}Container.unbind({{constantCase name}}_SYMBOLS.I{{pascalCase entity}}Repository);
|
||||
}
|
||||
{{camelCase name}}Container
|
||||
.bind<I{{pascalCase entity}}Repository>({{constantCase name}}_SYMBOLS.I{{pascalCase entity}}Repository)
|
||||
.to(Mock{{pascalCase entity}}Repository);
|
||||
});
|
||||
|
||||
it("populates the repository with the dev seed", async () => {
|
||||
await bindDevSeed{{pascalCase name}}(noop.tracer, noop.logger);
|
||||
|
||||
const repo = {{camelCase name}}Container.get<I{{pascalCase entity}}Repository>(
|
||||
{{constantCase name}}_SYMBOLS.I{{pascalCase entity}}Repository,
|
||||
);
|
||||
const found = await repo.get{{pascalCase entity}}("dev-1");
|
||||
|
||||
expect(found).not.toBeNull();
|
||||
expect(found?.id).toBe("dev-1");
|
||||
});
|
||||
|
||||
it("is idempotent — calling twice rebuilds a fresh populated repo", async () => {
|
||||
await bindDevSeed{{pascalCase name}}(noop.tracer, noop.logger);
|
||||
const before = {{camelCase name}}Container.get<I{{pascalCase entity}}Repository>(
|
||||
{{constantCase name}}_SYMBOLS.I{{pascalCase entity}}Repository,
|
||||
);
|
||||
|
||||
await bindDevSeed{{pascalCase name}}(noop.tracer, noop.logger);
|
||||
const after = {{camelCase name}}Container.get<I{{pascalCase entity}}Repository>(
|
||||
{{constantCase name}}_SYMBOLS.I{{pascalCase entity}}Repository,
|
||||
);
|
||||
|
||||
expect(after).not.toBe(before);
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,82 @@
|
||||
import {
|
||||
withSpan,
|
||||
withCapture,
|
||||
INSTRUMENTATION_SYMBOLS,
|
||||
type ITracer,
|
||||
type ILogger,
|
||||
} from "@repo/core-shared/instrumentation";
|
||||
import { {{camelCase name}}Container } from "./container.js";
|
||||
import { {{constantCase name}}_SYMBOLS } from "./symbols.js";
|
||||
import { Mock{{pascalCase entity}}Repository } from "../infrastructure/repositories/{{kebabCase entity}}.repository.mock.js";
|
||||
import { buildDev{{pascalCase entity}}Map } from "../__seeds__/dev.js";
|
||||
import { get{{pascalCase entity}}UseCase } from "../application/use-cases/get-{{kebabCase entity}}.use-case.js";
|
||||
import { get{{pascalCase entity}}Controller } from "../interface-adapters/controllers/get-{{kebabCase entity}}.controller.js";
|
||||
import type { I{{pascalCase entity}}Repository } from "../application/repositories/{{kebabCase entity}}.repository.interface.js";
|
||||
|
||||
/**
|
||||
* Replace the default mock with a populated one for dev mode + storybook.
|
||||
*
|
||||
* Mutually exclusive with `bindProduction{{pascalCase name}}(config, tracer, logger)`.
|
||||
* Tests must NOT call this — they construct `new Mock{{pascalCase entity}}Repository()`
|
||||
* directly and seed via factories per-test.
|
||||
*
|
||||
* Idempotent: safe to call multiple times; each call rebuilds a fresh
|
||||
* populated repo and rebinds the symbol.
|
||||
*/
|
||||
export async function bindDevSeed{{pascalCase name}}(
|
||||
tracer: ITracer,
|
||||
logger: ILogger,
|
||||
): Promise<void> {
|
||||
// Bind shared instrumentation into feature container
|
||||
if ({{camelCase name}}Container.isBound(INSTRUMENTATION_SYMBOLS.TRACER)) {
|
||||
{{camelCase name}}Container.unbind(INSTRUMENTATION_SYMBOLS.TRACER);
|
||||
}
|
||||
if ({{camelCase name}}Container.isBound(INSTRUMENTATION_SYMBOLS.LOGGER)) {
|
||||
{{camelCase name}}Container.unbind(INSTRUMENTATION_SYMBOLS.LOGGER);
|
||||
}
|
||||
{{camelCase name}}Container.bind<ITracer>(INSTRUMENTATION_SYMBOLS.TRACER).toConstantValue(tracer);
|
||||
{{camelCase name}}Container.bind<ILogger>(INSTRUMENTATION_SYMBOLS.LOGGER).toConstantValue(logger);
|
||||
|
||||
if ({{camelCase name}}Container.isBound({{constantCase name}}_SYMBOLS.I{{pascalCase entity}}Repository)) {
|
||||
{{camelCase name}}Container.unbind({{constantCase name}}_SYMBOLS.I{{pascalCase entity}}Repository);
|
||||
}
|
||||
const repo = new Mock{{pascalCase entity}}Repository(buildDev{{pascalCase entity}}Map(), tracer, logger);
|
||||
{{camelCase name}}Container
|
||||
.bind<I{{pascalCase entity}}Repository>({{constantCase name}}_SYMBOLS.I{{pascalCase entity}}Repository)
|
||||
.toConstantValue(repo);
|
||||
|
||||
// Wrap use case + controller identically to bind-production
|
||||
const wrappedGet{{pascalCase entity}} = withSpan(
|
||||
tracer,
|
||||
{ name: "{{camelCase name}}.get{{pascalCase entity}}", op: "use-case" },
|
||||
withCapture(
|
||||
logger,
|
||||
{ feature: "{{kebabCase name}}", layer: "use-case", name: "{{camelCase name}}.get{{pascalCase entity}}" },
|
||||
get{{pascalCase entity}}UseCase(repo),
|
||||
),
|
||||
);
|
||||
|
||||
for (const sym of [
|
||||
{{constantCase name}}_SYMBOLS.IGet{{pascalCase entity}}UseCase,
|
||||
{{constantCase name}}_SYMBOLS.IGet{{pascalCase entity}}Controller,
|
||||
]) {
|
||||
if ({{camelCase name}}Container.isBound(sym)) {{camelCase name}}Container.unbind(sym);
|
||||
}
|
||||
{{camelCase name}}Container
|
||||
.bind({{constantCase name}}_SYMBOLS.IGet{{pascalCase entity}}UseCase)
|
||||
.toConstantValue(wrappedGet{{pascalCase entity}});
|
||||
|
||||
{{camelCase name}}Container
|
||||
.bind({{constantCase name}}_SYMBOLS.IGet{{pascalCase entity}}Controller)
|
||||
.toConstantValue(
|
||||
withSpan(
|
||||
tracer,
|
||||
{ name: "{{camelCase name}}.get{{pascalCase entity}}", op: "controller" },
|
||||
withCapture(
|
||||
logger,
|
||||
{ feature: "{{kebabCase name}}", layer: "controller", name: "{{camelCase name}}.get{{pascalCase entity}}" },
|
||||
get{{pascalCase entity}}Controller(wrappedGet{{pascalCase entity}}),
|
||||
),
|
||||
),
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,74 @@
|
||||
import type { SanitizedConfig } from "payload";
|
||||
import {
|
||||
withSpan,
|
||||
withCapture,
|
||||
INSTRUMENTATION_SYMBOLS,
|
||||
type ITracer,
|
||||
type ILogger,
|
||||
} from "@repo/core-shared/instrumentation";
|
||||
import { {{camelCase name}}Container } from "./container";
|
||||
import { {{constantCase name}}_SYMBOLS } from "./symbols";
|
||||
import { {{pascalCase entity}}Repository } from "../infrastructure/repositories/{{kebabCase entity}}.repository";
|
||||
import { get{{pascalCase entity}}UseCase } from "../application/use-cases/get-{{kebabCase entity}}.use-case";
|
||||
import { get{{pascalCase entity}}Controller } from "../interface-adapters/controllers/get-{{kebabCase entity}}.controller";
|
||||
|
||||
export function bindProduction{{pascalCase name}}(
|
||||
config: SanitizedConfig,
|
||||
tracer: ITracer,
|
||||
logger: ILogger,
|
||||
): void {
|
||||
// Bind shared instrumentation into feature container
|
||||
if ({{camelCase name}}Container.isBound(INSTRUMENTATION_SYMBOLS.TRACER)) {
|
||||
{{camelCase name}}Container.unbind(INSTRUMENTATION_SYMBOLS.TRACER);
|
||||
}
|
||||
if ({{camelCase name}}Container.isBound(INSTRUMENTATION_SYMBOLS.LOGGER)) {
|
||||
{{camelCase name}}Container.unbind(INSTRUMENTATION_SYMBOLS.LOGGER);
|
||||
}
|
||||
{{camelCase name}}Container.bind<ITracer>(INSTRUMENTATION_SYMBOLS.TRACER).toConstantValue(tracer);
|
||||
{{camelCase name}}Container.bind<ILogger>(INSTRUMENTATION_SYMBOLS.LOGGER).toConstantValue(logger);
|
||||
|
||||
// Real repository
|
||||
if ({{camelCase name}}Container.isBound({{constantCase name}}_SYMBOLS.I{{pascalCase entity}}Repository)) {
|
||||
{{camelCase name}}Container.unbind({{constantCase name}}_SYMBOLS.I{{pascalCase entity}}Repository);
|
||||
}
|
||||
const repo = new {{pascalCase entity}}Repository(config, tracer, logger);
|
||||
{{camelCase name}}Container
|
||||
.bind({{constantCase name}}_SYMBOLS.I{{pascalCase entity}}Repository)
|
||||
.toConstantValue(repo);
|
||||
|
||||
// Use case — wrapped with span + capture at bind time
|
||||
const wrappedGet{{pascalCase entity}} = withSpan(
|
||||
tracer,
|
||||
{ name: "{{camelCase name}}.get{{pascalCase entity}}", op: "use-case" },
|
||||
withCapture(
|
||||
logger,
|
||||
{ feature: "{{kebabCase name}}", layer: "use-case", name: "{{camelCase name}}.get{{pascalCase entity}}" },
|
||||
get{{pascalCase entity}}UseCase(repo),
|
||||
),
|
||||
);
|
||||
|
||||
if ({{camelCase name}}Container.isBound({{constantCase name}}_SYMBOLS.IGet{{pascalCase entity}}UseCase)) {
|
||||
{{camelCase name}}Container.unbind({{constantCase name}}_SYMBOLS.IGet{{pascalCase entity}}UseCase);
|
||||
}
|
||||
{{camelCase name}}Container
|
||||
.bind({{constantCase name}}_SYMBOLS.IGet{{pascalCase entity}}UseCase)
|
||||
.toConstantValue(wrappedGet{{pascalCase entity}});
|
||||
|
||||
// Controller — wrapped with span at bind time
|
||||
if ({{camelCase name}}Container.isBound({{constantCase name}}_SYMBOLS.IGet{{pascalCase entity}}Controller)) {
|
||||
{{camelCase name}}Container.unbind({{constantCase name}}_SYMBOLS.IGet{{pascalCase entity}}Controller);
|
||||
}
|
||||
{{camelCase name}}Container
|
||||
.bind({{constantCase name}}_SYMBOLS.IGet{{pascalCase entity}}Controller)
|
||||
.toConstantValue(
|
||||
withSpan(
|
||||
tracer,
|
||||
{ name: "{{camelCase name}}.get{{pascalCase entity}}", op: "controller" },
|
||||
withCapture(
|
||||
logger,
|
||||
{ feature: "{{kebabCase name}}", layer: "controller", name: "{{camelCase name}}.get{{pascalCase entity}}" },
|
||||
get{{pascalCase entity}}Controller(wrappedGet{{pascalCase entity}}),
|
||||
),
|
||||
),
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,40 @@
|
||||
import { afterEach, beforeEach, describe, expect, it } from "vitest";
|
||||
import { {{camelCase name}}Container } from "./container";
|
||||
import { {{constantCase name}}_SYMBOLS } from "./symbols";
|
||||
import { {{pascalCase name}}Module } from "./module";
|
||||
import { Mock{{pascalCase entity}}Repository } from "@/infrastructure/repositories/{{kebabCase entity}}.repository.mock";
|
||||
import type { I{{pascalCase entity}}Repository } from "@/application/repositories/{{kebabCase entity}}.repository.interface";
|
||||
import type { IGet{{pascalCase entity}}UseCase } from "@/application/use-cases/get-{{kebabCase entity}}.use-case";
|
||||
import type { IGet{{pascalCase entity}}Controller } from "@/interface-adapters/controllers/get-{{kebabCase entity}}.controller";
|
||||
|
||||
describe("{{camelCase name}}Container", () => {
|
||||
beforeEach(() => {
|
||||
{{camelCase name}}Container.unbindAll();
|
||||
{{camelCase name}}Container.load({{pascalCase name}}Module);
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
{{camelCase name}}Container.unbindAll();
|
||||
});
|
||||
|
||||
it("resolves I{{pascalCase entity}}Repository to Mock{{pascalCase entity}}Repository", () => {
|
||||
const repo = {{camelCase name}}Container.get<I{{pascalCase entity}}Repository>(
|
||||
{{constantCase name}}_SYMBOLS.I{{pascalCase entity}}Repository,
|
||||
);
|
||||
expect(repo).toBeInstanceOf(Mock{{pascalCase entity}}Repository);
|
||||
});
|
||||
|
||||
it("resolves IGet{{pascalCase entity}}UseCase as a function", () => {
|
||||
const useCase = {{camelCase name}}Container.get<IGet{{pascalCase entity}}UseCase>(
|
||||
{{constantCase name}}_SYMBOLS.IGet{{pascalCase entity}}UseCase,
|
||||
);
|
||||
expect(typeof useCase).toBe("function");
|
||||
});
|
||||
|
||||
it("resolves IGet{{pascalCase entity}}Controller as a function", () => {
|
||||
const controller = {{camelCase name}}Container.get<IGet{{pascalCase entity}}Controller>(
|
||||
{{constantCase name}}_SYMBOLS.IGet{{pascalCase entity}}Controller,
|
||||
);
|
||||
expect(typeof controller).toBe("function");
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,6 @@
|
||||
import "reflect-metadata";
|
||||
import { Container } from "inversify";
|
||||
import { {{pascalCase name}}Module } from "./module";
|
||||
|
||||
export const {{camelCase name}}Container = new Container({ defaultScope: "Singleton" });
|
||||
{{camelCase name}}Container.load({{pascalCase name}}Module);
|
||||
39
turbo/generators/templates/feature/src/di/module.ts.hbs
Normal file
39
turbo/generators/templates/feature/src/di/module.ts.hbs
Normal file
@@ -0,0 +1,39 @@
|
||||
import { ContainerModule, type interfaces } from "inversify";
|
||||
|
||||
import type { I{{pascalCase entity}}Repository } from "../application/repositories/{{kebabCase entity}}.repository.interface";
|
||||
import { Mock{{pascalCase entity}}Repository } from "../infrastructure/repositories/{{kebabCase entity}}.repository.mock";
|
||||
import {
|
||||
get{{pascalCase entity}}UseCase,
|
||||
type IGet{{pascalCase entity}}UseCase,
|
||||
} from "../application/use-cases/get-{{kebabCase entity}}.use-case";
|
||||
import {
|
||||
get{{pascalCase entity}}Controller,
|
||||
type IGet{{pascalCase entity}}Controller,
|
||||
} from "../interface-adapters/controllers/get-{{kebabCase entity}}.controller";
|
||||
import { {{constantCase name}}_SYMBOLS } from "./symbols";
|
||||
|
||||
export const {{pascalCase name}}Module = new ContainerModule((bind: interfaces.Bind) => {
|
||||
bind<I{{pascalCase entity}}Repository>({{constantCase name}}_SYMBOLS.I{{pascalCase entity}}Repository).to(
|
||||
Mock{{pascalCase entity}}Repository,
|
||||
);
|
||||
|
||||
bind<IGet{{pascalCase entity}}UseCase>(
|
||||
{{constantCase name}}_SYMBOLS.IGet{{pascalCase entity}}UseCase,
|
||||
).toDynamicValue((ctx) =>
|
||||
get{{pascalCase entity}}UseCase(
|
||||
ctx.container.get<I{{pascalCase entity}}Repository>(
|
||||
{{constantCase name}}_SYMBOLS.I{{pascalCase entity}}Repository,
|
||||
),
|
||||
),
|
||||
);
|
||||
|
||||
bind<IGet{{pascalCase entity}}Controller>(
|
||||
{{constantCase name}}_SYMBOLS.IGet{{pascalCase entity}}Controller,
|
||||
).toDynamicValue((ctx) =>
|
||||
get{{pascalCase entity}}Controller(
|
||||
ctx.container.get<IGet{{pascalCase entity}}UseCase>(
|
||||
{{constantCase name}}_SYMBOLS.IGet{{pascalCase entity}}UseCase,
|
||||
),
|
||||
),
|
||||
);
|
||||
});
|
||||
7
turbo/generators/templates/feature/src/di/symbols.ts.hbs
Normal file
7
turbo/generators/templates/feature/src/di/symbols.ts.hbs
Normal file
@@ -0,0 +1,7 @@
|
||||
export const {{constantCase name}}_SYMBOLS = {
|
||||
I{{pascalCase entity}}Repository: Symbol.for("{{kebabCase name}}:I{{pascalCase entity}}Repository"),
|
||||
// Use cases
|
||||
IGet{{pascalCase entity}}UseCase: Symbol.for("{{kebabCase name}}:IGet{{pascalCase entity}}UseCase"),
|
||||
// Controllers
|
||||
IGet{{pascalCase entity}}Controller: Symbol.for("{{kebabCase name}}:IGet{{pascalCase entity}}Controller"),
|
||||
} as const;
|
||||
Reference in New Issue
Block a user