Geradores personalizados

Certifique-se de incluir likec4 nas dependências do projeto:

npm

npm i likec4

pnpm

pnpm add likec4

yarn

yarn add likec4

bun

bun add likec4

É possível definir geradores personalizados na configuração do projeto:

likec4.config.ts

import { defineConfig } from 'likec4/config'

export default defineConfig({
  name: 'my-project',
  title: 'My Project',
  generators: {
    'hello': async ({ likec4model, ctx }) => {
      await ctx.write({
        path: 'hello.txt', // relative to the project root
        content: `Project: ${likec4model.project.id}`,
      })
    },
  },
})

Agora você pode executar o gerador usando a CLI:

likec4 gen hello

Em um workspace com múltiplos projetos, utilize:

likec4 gen hello --project my-project
# Other options
likec4 gen hello --project my-project --use-dot

Geradores reutilizáveis

A função auxiliar defineGenerators também permite definir geradores reutilizáveis:

shared_generators.ts

import { defineGenerators } from 'likec4/config'

export default defineGenerators({
  'hello': async ({ likec4model, ctx }) => {
    await ctx.write({
      path: 'hello.txt', // relative to the project root
      content: `Project: ${likec4model.project.id}`,
    })
  },
})

Depois, você pode utilizá-los nos arquivos de configuração:

likec4.config.ts

import { defineConfig } from 'likec4/config'
import generators from './shared_generators'

export default defineConfig({
  name: 'my-project',
  title: 'My Project',
  generators,
})

Dica

Você também pode utilizar o pacote menor @likec4/config:

import { defineGenerators } from '@likec4/config'

export default defineGenerators({
  'hello': async ({ likec4model, ctx }) => {
    await ctx.write({
      path: 'hello.txt', // relative to the project root
      content: `Project: ${likec4model.project.id}`,
    })
  },
})