snapshot of https://github.com/twentyhq/twenty.git (main, 2026-09-17; blobs > 131072B omitted)

packages/create-twenty-app/src/utils/app-template.ts

@@ -0,0 +1,139 @@
+import * as fs from 'fs-extra';
+import { join } from 'path';
+import { v4 } from 'uuid';
+
+import { TEMPLATE_FIRST_PARTY_PACKAGES } from '@/constants/template-packages';
+import createTwentyAppPackageJson from 'package.json';
+
+const SRC_FOLDER = 'src';
+
+export const copyBaseApplicationProject = async ({
+  appName,
+  appDisplayName,
+  appDescription,
+  appDirectory,
+  onProgress,
+}: {
+  appName: string;
+  appDisplayName: string;
+  appDescription: string;
+  appDirectory: string;
+  onProgress?: (message: string) => void;
+}) => {
+  onProgress?.('Copying base template');
+  await fs.copy(join(__dirname, './constants/template'), appDirectory);
+
+  onProgress?.('Configuring dotfiles (.gitignore, .github, .yarnrc.yml)');
+  await renameDotfiles({ appDirectory });
+
+  onProgress?.('Mirroring AGENTS.md to CLAUDE.md');
+  await mirrorAgentsToClaude({ appDirectory });
+
+  await addEmptyPublicDirectory({ appDirectory });
+
+  onProgress?.('Generating unique application identifiers');
+  await generateUniversalIdentifiers({
+    appDisplayName,
+    appDescription,
+    appDirectory,
+  });
+
+  onProgress?.('Updating package.json');
+  await updatePackageJson({ appName, appDirectory });
+};
+
+// npm strips dotfiles/dotdirs (.gitignore, .github/) from published packages,
+// so we store them without the leading dot and rename after copying.
+const renameDotfiles = async ({ appDirectory }: { appDirectory: string }) => {
+  const renames = [
+    { from: 'gitignore', to: '.gitignore' },
+    { from: 'github', to: '.github' },
+    { from: 'yarnrc.yml', to: '.yarnrc.yml' },
+  ];
+
+  for (const { from, to } of renames) {
+    const sourcePath = join(appDirectory, from);
+
+    if (await fs.pathExists(sourcePath)) {
+      await fs.rename(sourcePath, join(appDirectory, to));
+    }
+  }
+};
+
+// AGENTS.md is the cross-tool standard; Claude Code prefers CLAUDE.md and only
+// falls back to AGENTS.md, so we mirror the file to keep a single source of truth.
+const mirrorAgentsToClaude = async ({
+  appDirectory,
+}: {
+  appDirectory: string;
+}) => {
+  await fs.copy(
+    join(appDirectory, 'AGENTS.md'),
+    join(appDirectory, 'CLAUDE.md'),
+  );
+};
+
+const addEmptyPublicDirectory = async ({
+  appDirectory,
+}: {
+  appDirectory: string;
+}) => {
+  await fs.ensureDir(join(appDirectory, 'public'));
+};
+
+const generateUniversalIdentifiers = async ({
+  appDisplayName,
+  appDescription,
+  appDirectory,
+}: {
+  appDisplayName: string;
+  appDescription: string;
+  appDirectory: string;
+}) => {
+  const universalIdentifiersPath = join(
+    appDirectory,
+    SRC_FOLDER,
+    'constants',
+    'universal-identifiers.ts',
+  );
+
+  const universalIdentifiersFileContent = await fs.readFile(
+    universalIdentifiersPath,
+    'utf-8',
+  );
+
+  await fs.writeFile(
+    universalIdentifiersPath,
+    universalIdentifiersFileContent
+      .replace('DISPLAY-NAME-TO-BE-GENERATED', appDisplayName)
+      .replace('DESCRIPTION-TO-BE-GENERATED', appDescription)
+      .replace(/UUID-TO-BE-GENERATED/g, () => v4()),
+  );
+};
+
+const updatePackageJson = async ({
+  appName,
+  appDirectory,
+}: {
+  appName: string;
+  appDirectory: string;
+}) => {
+  const packageJson = await fs.readJson(join(appDirectory, 'package.json'));
+
+  // The template yarn.lock keeps its placeholder workspace name: the only entry
+  // naming the project is the workspace root, which the scaffolder's `yarn install`
+  // rewrites from package.json without re-resolving a single dependency. Renaming
+  // it here would move the entry out of sort order and break `--immutable`.
+  packageJson.name = appName;
+
+  for (const packageName of TEMPLATE_FIRST_PARTY_PACKAGES) {
+    packageJson.devDependencies[packageName] =
+      createTwentyAppPackageJson.version;
+  }
+
+  await fs.writeFile(
+    join(appDirectory, 'package.json'),
+    JSON.stringify(packageJson, null, 2),
+    'utf8',
+  );
+};