github-actions[bot]
2b3b2362db
Created by Github action Co-authored-by: github-actions <github-actions@twenty.com>
59 lines
3.3 KiB
Plaintext
59 lines
3.3 KiB
Plaintext
---
|
||
title: Scaffolding
|
||
description: "Genera i file delle entità in modo interattivo con yarn twenty dev:add: oggetti, campi, viste, funzioni di logica e altro ancora."
|
||
icon: wand-magic-sparkles
|
||
---
|
||
|
||
Invece di creare manualmente i file delle entità, puoi usare lo scaffolder interattivo:
|
||
|
||
```bash filename="Terminal"
|
||
yarn twenty dev:add
|
||
```
|
||
|
||
Ti chiede di scegliere un tipo di entità e ti guida attraverso i campi richiesti, quindi scrive un file pronto all’uso con un `universalIdentifier` stabile e la corretta chiamata a `defineEntity()`.
|
||
|
||
Puoi anche passare direttamente il tipo di entità per saltare il primo prompt:
|
||
|
||
```bash filename="Terminal"
|
||
yarn twenty dev:add object
|
||
yarn twenty dev:add logicFunction
|
||
yarn twenty dev:add frontComponent
|
||
```
|
||
|
||
## Tipi di entità disponibili
|
||
|
||
| Tipo di entità | Comando | File generato |
|
||
| ---------------------------- | ---------------------------------------- | ------------------------------------------------------- |
|
||
| Oggetto | `yarn twenty dev:add object` | `src/objects/\<name>.ts` |
|
||
| Campo | `yarn twenty dev:add field` | `src/fields/\<name>.ts` |
|
||
| Funzione logica | `yarn twenty dev:add logicFunction` | `src/logic-functions/\<name>.ts` |
|
||
| Componente front-end | `yarn twenty dev:add frontComponent` | `src/front-components/\<name>.tsx` |
|
||
| Ruolo | `yarn twenty dev:add role` | `src/roles/\<name>.ts` |
|
||
| Abilità | `yarn twenty dev:add skill` | `src/skills/\<name>.ts` |
|
||
| Agente | `yarn twenty dev:add agent` | `src/agents/\<name>.ts` |
|
||
| Vista | `yarn twenty dev:add view` | `src/views/\<name>.ts` |
|
||
| Voce del menu di navigazione | `yarn twenty dev:add navigationMenuItem` | `src/navigation-menu-items/\<name>.ts` |
|
||
| Layout di pagina | `yarn twenty dev:add pageLayout` | `src/page-layouts/\<name>.ts` |
|
||
|
||
## Cosa genera lo scaffolder
|
||
|
||
Ogni tipo di entità ha il proprio template. Ad esempio, `yarn twenty dev:add object` richiede:
|
||
|
||
1. **Nome (singolare)** — ad es., `invoice`
|
||
2. **Nome (plurale)** — ad es., `invoices`
|
||
3. **Etichetta (singolare)** — compilata automaticamente dal nome (ad es., `Invoice`)
|
||
4. **Etichetta (plurale)** — compilata automaticamente (ad es., `Invoices`)
|
||
5. **Creare una vista e una voce di navigazione?** — se rispondi sì, lo scaffolder genera anche una vista corrispondente e un link nella barra laterale per il nuovo oggetto.
|
||
|
||
Gli altri tipi di entità hanno prompt più semplici — la maggior parte chiede solo un nome.
|
||
|
||
Il tipo di entità `field` è più dettagliato: chiede il nome del campo, l'etichetta, il tipo (da un elenco di tutti i tipi di campo disponibili come `TEXT`, `NUMBER`, `SELECT`, `RELATION`, ecc.) e l'`universalIdentifier` dell'oggetto di destinazione.
|
||
|
||
## Percorso di output personalizzato
|
||
|
||
Usa il flag `--path` per posizionare il file generato in una posizione personalizzata:
|
||
|
||
```bash filename="Terminal"
|
||
yarn twenty dev:add logicFunction --path src/custom-folder
|
||
```
|