Examples

Runnable examples live in the repository under examples/. CI runs lombok-ts generate and tsc --noEmit on plain-ts and nestjs after every build; commonjs-serverless is typechecked on every PR.

plain-ts

Path: examples/plain-ts

Legacy backend with codegen and runtime decorators:

• @Data, @Builder, @ToString, @NonNull on User
• @Singleton, @Memoize on UserService

git clone https://github.com/A-Dev-Kit/lombok-typescript.git
cd lombok-typescript
pnpm install && pnpm build

cd examples/plain-ts
node ../../dist/cli/index.js generate
pnpm exec tsc --noEmit

commonjs-serverless

Path: examples/commonjs-serverless

Minimal CommonJS consumer (module: commonjs, moduleResolution: nodenext) importing @Data / @Builder from /legacy. Mirrors Serverless Framework projects that have not migrated to ESM.

cd examples/commonjs-serverless
pnpm typecheck

See CommonJS and Serverless for tsconfig requirements and troubleshooting.

nestjs

Path: examples/nestjs

Shows interoperability with @nestjs/common and the built-in lombok-typescript/nestjs entry point:

• LombokModule.forRoot() in AppModule
• @Injectable() + @Singleton + @LogNest on AppService
• @Factory registry with createFromFactory
• @Memoize on service methods
• @Validate + class-validator on CreateUserDto

cd examples/nestjs
node ../../dist/cli/index.js generate
pnpm exec tsc --noEmit
pnpm start

What to try

1. Add a field to a @Data class, run generate, and inspect .lombok/.
2. Toggle backend: 'stage3' in lombok.config.ts (with matching tsconfig) to compare backends.
3. Read Architecture for how applyAllGenerated wires codegen output.

Historical previews

The older docs/example/ markdown files are superseded by this site and the examples/ apps. They may describe future-phase decorators not yet implemented.