Skip to content

The open alternative to Salesforce, designed for AI.

Scaffold a locales folder with an empty source catalog (#25539)

Weiko28f9e7fef117
diff --git a/packages/create-twenty-app/src/constants/template/locales/en.json b/packages/create-twenty-app/src/constants/template/locales/en.json
new file mode 100644
index 00000000000..0967ef424bc
--- /dev/null
+++ b/packages/create-twenty-app/src/constants/template/locales/en.json
@@ -0,0 +1 @@
+{}
diff --git a/packages/create-twenty-app/src/utils/__tests__/app-template.spec.ts b/packages/create-twenty-app/src/utils/__tests__/app-template.spec.ts
index 9917f2cfc8b..a3cf95fafb1 100644
--- a/packages/create-twenty-app/src/utils/__tests__/app-template.spec.ts
+++ b/packages/create-twenty-app/src/utils/__tests__/app-template.spec.ts
@@ -212,7 +212,7 @@ describe('copyBaseApplicationProject', () => {
expect(content).toContain("APP_DESCRIPTION = ''");
});
- it.each(['CHANGELOG.md', 'SETUP.md'])(
+ it.each(['CHANGELOG.md', 'SETUP.md', 'locales/en.json'])(
'should seed %s in the base template',
async (seedFileName) => {
const templateDirectory = join(
diff --git a/packages/twenty-docs/developers/extend/apps/getting-started/project-structure.mdx b/packages/twenty-docs/developers/extend/apps/getting-started/project-structure.mdx
index 00b6ef53182..2baa77e4405 100644
--- a/packages/twenty-docs/developers/extend/apps/getting-started/project-structure.mdx
+++ b/packages/twenty-docs/developers/extend/apps/getting-started/project-structure.mdx
@@ -30,6 +30,8 @@ my-twenty-app/
publish.yml # Publish to npm on version tags (with provenance)
public/
logo.svg # Static assets
+ locales/
+ en.json # Source catalog; add <locale>.json files next to it
vitest.config.ts # Integration test runner config
vitest.unit.config.ts # Unit test runner config
tsconfig.json, tsconfig.spec.json
@@ -47,6 +49,7 @@ my-twenty-app/
| `src/front-components/`, `src/navigation-menu-items/`, `src/page-layouts/` | A starter welcome page: a front component rendered by a standalone page layout, reachable from the sidebar. |
| `src/__tests__/` | A unit test plus an integration test (with its global setup) that syncs the app against a real server. |
| `public/` | Static assets (images, fonts) served with your app. |
+| `locales/` | Translation catalogs. `en.json` is the source catalog `dev:translations-extract` fills in; the set of files here is what a sync publishes, so an empty folder declares no translations. |
| `AGENTS.md` / `CLAUDE.md` | Guidance for AI coding agents working on the app. |
| `CHANGELOG.md` / `SETUP.md` | Changelog of notable changes and setup instructions for local development. |
diff --git a/packages/twenty-docs/developers/extend/apps/operations/sync-and-recovery.mdx b/packages/twenty-docs/developers/extend/apps/operations/sync-and-recovery.mdx
index 3706d534262..e58de53d7da 100644
--- a/packages/twenty-docs/developers/extend/apps/operations/sync-and-recovery.mdx
+++ b/packages/twenty-docs/developers/extend/apps/operations/sync-and-recovery.mdx
@@ -98,7 +98,7 @@ A plan only previews **metadata** changes. It also works for an app that was nev
## Pulling an installed app back to source
<Warning>
-`yarn twenty pull` is **experimental**. It covers only part of an application today, its output shape may change between releases, and it overwrites the files that define the entities it pulls. Commit your work before running it, and review the diff.
+`yarn twenty pull` is **experimental**. It covers only part of an application today, its output shape may change between releases, and it overwrites the files that define the entities it pulls. It does not restore translations yet, so pushing a pulled tree replaces the app's published translations with whatever your `locales/` folder holds. Commit your work before running it, and review the diff.
</Warning>
`yarn twenty pull` is the inverse of `apply`: it reads an application out of the workspace and writes it back as define files.