Getting started

Install

Published on npm (latest dist-tag) and as @a-dev-kit/lombok-typescript on GitHub Packages:

npm install lombok-typescript@latest

For local development:

git clone https://github.com/A-Dev-Kit/lombok-typescript.git
cd lombok-typescript
pnpm install
pnpm build
pnpm link --global   # optional: use lombok-ts from anywhere

Pick a backend

Legacy (NestJS, TypeORM, most existing codebases)

// tsconfig.json
{
  "compilerOptions": {
    "experimentalDecorators": true,
    "emitDecoratorMetadata": true,
  },
}

import { Data, Builder, Singleton } from 'lombok-typescript/legacy';

Stage 3 (TS 5.0+ native decorators)

{
  "compilerOptions": {
    "experimentalDecorators": false,
  },
}

import { Data, Builder, Singleton } from 'lombok-typescript/stage3';

Do not mix backends in one project.

Configure codegen

npx lombok-ts init

Or create lombok.config.ts manually — see Configuration.

Minimal workflow

1. Decorate a class (src/user.ts):

import 'reflect-metadata';
import { Data, Builder, ToString } from 'lombok-typescript/legacy';

@Data
@Builder
@ToString
export class User {
  name!: string;
  age!: number;
}

2. Generate companions:

npx lombok-ts generate

3. TypeScript config — include generated files (no rootDir: src if .lombok is a sibling):

{
  "compilerOptions": {
    "module": "NodeNext",
    "moduleResolution": "NodeNext",
    "strict": true,
  },
  "include": ["src/**/*.ts", ".lombok/**/*.ts", ".lombok/**/*.d.ts"],
}

4. Apply generated mixins (e.g. in src/main.ts):

import { User } from './user.js';
import { applyAllGenerated } from '../.lombok/src/user.lombok.js';

applyAllGenerated({ User });

5. Use the API:

const user = User.builder().name('Ada').age(30).build();
console.info(user.toString());

Runtime-only decorators

@Singleton, @Prototype, @Memoize, and @NonNull work without codegen. Still run generate if the same file also uses @Data / @Builder / @ToString.

Next steps

• CommonJS and Serverless — module: commonjs without full ESM migration
• CLI — all commands and flags
• Examples — plain-ts, commonjs-serverless, and nestjs sample apps
• Decorator overview — per-decorator reference