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
140 lines
3.7 KiB
TypeScript
140 lines
3.7 KiB
TypeScript
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',
|
|
);
|
|
};
|