Back to Turborepo

README

packages/turbo-gen/README.md

2.9.9953 B
Original Source

https://turborepo.dev/docs/guides/generating-code# @turbo/gen

Types for working with Turborepo Generators.

Usage

Install:

bash
pnpm add @turbo/gen --save-dev

Use types within your generator config.ts:

ts
import type { PlopTypes } from "@turbo/gen";

export default function generator(plop: PlopTypes.NodePlopAPI): void {
  // create a generator
  plop.setGenerator("Generator name", {
    description: "Generator description",
    // gather information from the user
    prompts: [
      ...
    ],
    // perform actions based on the prompts
    actions: [
      ...
    ],
  });
}

Learn more about Turborepo Generators in the docs


For more information about Turborepo, visit turborepo.dev and follow us on X (@turborepo)!