Some checks failed
App Prod-Parity E2E Dispatch / dispatch (push) Failing after 10s
CD Storybook UI / build (push) Failing after 3m25s
CD Storybook UI / dispatch (push) Has been skipped
CD deploy main / website-changed-files (push) Successful in 18m8s
CI Agent Skills / changed-files-check (push) Successful in 18m9s
CI Create App E2E minimal / changed-files-check (push) Successful in 24s
CI Create App / changed-files-check (push) Successful in 26s
CI Docs / changed-files-check (push) Successful in 26s
CI Emails / changed-files-check (push) Successful in 28s
CI Example App Hello World / changed-files-check (push) Successful in 23s
CI Front / changed-files-check (push) Has been skipped
CI Example App Postcard / changed-files-check (push) Successful in 27s
CI UI / changed-files-check (push) Has been skipped
CI Utils Test / changed-files-check (push) Successful in 45s
CI Twenty Apps / discover (push) Successful in 1m3s
CD deploy main / deploy-main (push) Failing after 3s
CI Agent Skills / agent-skills-validate (push) Has been skipped
CI Create App / create-app-test (lint) (push) Has been skipped
CI Emails / emails-test (push) Has been skipped
CI Front / front-task (lingui:compile) (push) Has been skipped
CI Front / front-task (lint) (push) Has been skipped
CI Example App Postcard / example-app-postcard (push) Has been skipped
CI UI / ui-task (lint) (push) Has been skipped
CI UI / ui-task (pack-size) (push) Has been skipped
CI UI / ui-task (size) (push) Has been skipped
CI UI / ui-task (test) (push) Has been skipped
CI UI / ui-task (typecheck) (push) Has been skipped
CI Utils Test / utils-test (push) Has been skipped
CI Twenty Apps / ${{ matrix.app.name }} (push) Has been skipped
CI Emails / ci-emails-status-check (push) Successful in 2s
CI Example App Hello World / ci-example-app-hello-world-status-check (push) Successful in 2s
CI Example App Postcard / ci-example-app-postcard-status-check (push) Successful in 3s
CI UI / ui-sb-test (push) Has been skipped
CI Utils Test / ci-utils-test-status-check (push) Successful in 2s
CI Twenty Apps / ci-twenty-apps-status-check (push) Successful in 2s
CI UI / ci-ui-status-check (push) Successful in 2s
CI Desktop / desktop (push) Failing after 1m8s
Push docs to Crowdin / Push documentation to Crowdin (push) Failing after 55s
Push translations to Crowdin / Extract and upload translations (push) Failing after 5s
Push website translations to Crowdin / Extract and upload website translations (push) Failing after 5s
CI Create App / create-app-test (test) (push) Has been skipped
CI Create App / create-app-test (typecheck) (push) Has been skipped
CI Docs / docs-lint (push) Has been skipped
CI Example App Hello World / example-app-hello-world (push) Has been skipped
CI Front / front-task (lingui:extract) (push) Has been skipped
CI Front / front-task (test) (push) Has been skipped
CI Front / front-task (typecheck) (push) Has been skipped
CI UI / ui-sb-build (push) Failing after 1m32s
CI Twenty Apps / ${{ matrix.app.name }} (${{ matrix.server-source }}) (push) Has been skipped
CI Agent Skills / agent-skills-publish (push) Has been skipped
CI Create App / ci-create-app-status-check (push) Successful in 2s
CI Agent Skills / agent-skills-remote-source (push) Has been skipped
CI Create App E2E minimal / create-app-e2e-minimal (push) Has been cancelled
CI E2E Main / e2e-test (push) Has been cancelled
CI Front / front-sb-build (push) Has been cancelled
CI Front / front-build (push) Has been cancelled
CI Create App E2E minimal / ci-create-app-e2e-minimal-status-check (push) Has been cancelled
CI E2E Main / ci-e2e-main-status-check (push) Has been cancelled
CI E2E Main / notify-main-ci-failure (push) Has been cancelled
CI E2E Main / qa-scout-comment (push) Has been cancelled
CI Front / front-sb-test (push) Has been cancelled
CI Front / front-sb-screenshots (push) Has been cancelled
CI Front / ci-front-status-check (push) Has been cancelled
DPA Sub-Processor Sync / sync-subprocessors (push) Failing after 3s
AI Catalog Sync / sync-catalog (push) Failing after 2s
64 lines
4.4 KiB
Plaintext
64 lines
4.4 KiB
Plaintext
---
|
||
title: スキャフォルディング
|
||
description: yarn twenty dev:add を使用して対話的にエンティティファイルを生成します — オブジェクト、フィールド、ビュー、ロジック関数などを作成できます。
|
||
icon: wand-magic-sparkles
|
||
---
|
||
|
||
エンティティファイルを手作業で作成する代わりに、対話型スキャフォルダーを使用します:
|
||
|
||
```bash filename="Terminal"
|
||
yarn twenty dev:add
|
||
```
|
||
|
||
これによりエンティティタイプの選択を促され、必要なフィールドの設定を順を追って案内されたあと、安定した `universalIdentifier` と正しい `defineEntity()` 呼び出しを含む、すぐに利用できるファイルが作成されます。
|
||
|
||
最初のプロンプトをスキップするために、エンティティタイプを直接渡すこともできます:
|
||
|
||
```bash filename="Terminal"
|
||
yarn twenty dev:add object
|
||
yarn twenty dev:add logicFunction
|
||
yarn twenty dev:add frontComponent
|
||
```
|
||
|
||
## 利用可能なエンティティタイプ
|
||
|
||
| エンティティタイプ | コマンド | 生成されたファイル |
|
||
| ------------- | ------------------------------------------ | --------------------------------------------------------- |
|
||
| オブジェクト | `yarn twenty dev:add object` | `src/objects/\<name>.ts` |
|
||
| フィールド | `yarn twenty dev:add field` | `src/fields/\<name>.ts` |
|
||
| ロジック関数 | `yarn twenty dev:add logicFunction` | `src/logic-functions/\<name>.ts` |
|
||
| フロントコンポーネント | `yarn twenty dev:add frontComponent` | `src/front-components/\<name>.tsx` |
|
||
| ロール | `yarn twenty dev:add role` | `src/roles/\<name>.ts` |
|
||
| スキル | `yarn twenty dev:add skill` | `src/skills/\<name>.ts` |
|
||
| エージェント | `yarn twenty dev:add agent` | `src/agents/\<name>.ts` |
|
||
| ビュー | `yarn twenty dev:add view` | `src/views/\<name>.ts` |
|
||
| ナビゲーションメニュー項目 | `yarn twenty dev:add navigationMenuItem` | `src/navigation-menu-items/\<name>.ts` |
|
||
| ページレイアウト | `yarn twenty dev:add pageLayout` | `src/page-layouts/\<name>.ts` |
|
||
| ページレイアウトタブ | `yarn twenty dev:add pageLayoutTab` | `src/page-layout-tabs/\<name>.ts` |
|
||
| コマンドメニュー項目 | `yarn twenty dev:add commandMenuItem` | `src/command-menu-items/\<name>.ts` |
|
||
| ビューフィールド | `yarn twenty dev:add viewField` | `src/view-fields/\<name>.ts` |
|
||
| 接続プロバイダー | `yarn twenty dev:add connectionProvider` | `src/connection-providers/\<name>.ts` |
|
||
| タイムライン活動タイプ | `yarn twenty dev:add timelineActivityType` | `src/timeline-activity-types/\<name>.ts` |
|
||
|
||
## スキャフォルダーが生成するもの
|
||
|
||
各エンティティタイプには固有のテンプレートがあります。 例えば、`yarn twenty dev:add object` は次の項目の入力を求めます:
|
||
|
||
1. **名前(単数)** — 例:`invoice`
|
||
2. **名前(複数)** — 例:`invoices`
|
||
3. **ラベル(単数)** — 名前から自動入力(例:`Invoice`)
|
||
4. **ラベル(複数)** — 自動入力(例:`Invoices`)
|
||
5. **ビューとナビゲーション項目を作成しますか?** — はいと回答すると、スキャフォルダーは新しいオブジェクトに対応するビューとサイドバーリンクも生成します。
|
||
|
||
他のエンティティタイプはより簡単なプロンプトで、ほとんどは名前のみを尋ねます。
|
||
|
||
`field` エンティティタイプはより詳細で、フィールド名、ラベル、タイプ(`TEXT`、`NUMBER`、`SELECT`、`RELATION` など、利用可能なすべてのフィールドタイプのリストから選択)、および対象オブジェクトの `universalIdentifier` を尋ねます。
|
||
|
||
## 出力パスのカスタマイズ
|
||
|
||
`--path` フラグを使用して、生成ファイルをカスタムの場所に配置します:
|
||
|
||
```bash filename="Terminal"
|
||
yarn twenty dev:add logicFunction --path src/custom-folder
|
||
```
|