Quick Start

5-Minute Goal Generate your first type-safe builder and use it in your

code. :::

Installation

npm install -D fluent-gen-ts

1. Create a TypeScript Interface

// src/types/user.ts
export interface User {
  id: string;
  name: string;
  email: string;
  age: number;
  isActive: boolean;
}

2. Generate the Builder

Option A: Single Command

npx fluent-gen-ts generate ./src/types/user.ts User --output ./src/builders/

Option B: Config File (Recommended)

Create fluentgen.config.js:

export default {
  targets: [{ file: './src/types/user.ts', types: ['User'] }],
  output: {
    dir: './src/builders',
  },
};

Then run:

npx fluent-gen-ts batch

3. Use the Builder

import { user } from './src/builders/user.builder.js';

// Create a user with fluent API
const newUser = user()
  .withId('user-123')
  .withName('Alice Smith')
  .withEmail('alice@example.com')
  .withAge(30)
  .withIsActive(true)
  .build();

console.log(newUser);
// {
//   id: 'user-123',
//   name: 'Alice Smith',
//   email: 'alice@example.com',
//   age: 30,
//   isActive: true
// }

That's It! 🎉

You now have a type-safe, fluent builder for your User interface.

Common Next Steps

Add More Types

// fluentgen.config.js
export default {
  targets: [
    { file: './src/types/user.ts', types: ['User', 'Profile'] },
    { file: './src/types/product.ts', types: ['Product'] },
  ],
  output: {
    dir: './src/builders',
  },
};

Use in Tests

// __tests__/user.test.ts
import { user } from '../builders/user.builder.js';

test('should create user', () => {
  const testUser = user()
    .withId('test-id')
    .withName('Test User')
    .withEmail('test@example.com')
    .withAge(25)
    .withIsActive(true)
    .build();

  expect(testUser.name).toBe('Test User');
});

Add Validation Plugin

// plugins/validation.ts
import { createPlugin } from 'fluent-gen-ts';

export default createPlugin('validation', '1.0.0')
  .transformPropertyMethods(builder =>
    builder
      .when(ctx => ctx.property.name === 'email')
      .setValidator(
        `
      if (value && !value.includes('@')) {
        throw new Error('Invalid email');
      }
    `,
      )
      .done(),
  )
  .build();

// fluentgen.config.js
export default {
  plugins: ['./plugins/validation.ts'],
  targets: [
    /* ... */
  ],
};

What's Next?

📚 Learn Core Concepts

Understand the system: Core Concepts →

🔌 Add Plugins

Extend functionality: Plugin Overview →

📖 Browse Examples

See real patterns: Examples →

⚙️ CLI Commands

Learn all commands: CLI Reference →

Need Help?

• FAQ - Common questions
• Troubleshooting - Common issues
• GitHub Issues - Report bugs