diff options
| author | 2023-04-28 01:36:44 +0800 | |
|---|---|---|
| committer | 2023-04-28 01:36:44 +0800 | |
| commit | dd84b9d64fb98746a230cd24233ff50a562c39c9 (patch) | |
| tree | b583261ef00b3afe72ec4d6dacb31e57779a6faf /packages/create-turbo/src/transforms/official-starter.ts | |
| parent | 0b46fcd72ac34382387b2bcf9095233efbcc52f4 (diff) | |
| download | HydroRoll-dd84b9d64fb98746a230cd24233ff50a562c39c9.tar.gz HydroRoll-dd84b9d64fb98746a230cd24233ff50a562c39c9.zip | |
Diffstat (limited to 'packages/create-turbo/src/transforms/official-starter.ts')
| -rw-r--r-- | packages/create-turbo/src/transforms/official-starter.ts | 73 |
1 files changed, 73 insertions, 0 deletions
diff --git a/packages/create-turbo/src/transforms/official-starter.ts b/packages/create-turbo/src/transforms/official-starter.ts new file mode 100644 index 0000000..1d71909 --- /dev/null +++ b/packages/create-turbo/src/transforms/official-starter.ts @@ -0,0 +1,73 @@ +import path from "path"; +import fs from "fs-extra"; +import semverPrerelease from "semver/functions/prerelease"; +import cliPkgJson from "../../package.json"; +import { isDefaultExample } from "../utils/isDefaultExample"; +import { TransformInput, TransformResult } from "./types"; +import { TransformError } from "./errors"; + +const meta = { + name: "official-starter", +}; + +// applied to "official starter" examples (those hosted within vercel/turbo/examples) +export async function transform(args: TransformInput): TransformResult { + const { prompts, example } = args; + + const defaultExample = isDefaultExample(example.name); + const isOfficialStarter = + !example.repo || + (example.repo?.username === "vercel" && example.repo?.name === "turbo"); + + if (!isOfficialStarter) { + return { result: "not-applicable", ...meta }; + } + + // paths + const rootPackageJsonPath = path.join(prompts.root, "package.json"); + const rootMetaJsonPath = path.join(prompts.root, "meta.json"); + const hasPackageJson = fs.existsSync(rootPackageJsonPath); + + // 1. remove meta file (used for generating the examples page on turbo.build) + try { + fs.rmSync(rootMetaJsonPath, { force: true }); + } catch (_err) {} + + if (hasPackageJson) { + let packageJsonContent; + try { + packageJsonContent = fs.readJsonSync(rootPackageJsonPath); + } catch { + throw new TransformError("Unable to read package.json", { + transform: meta.name, + fatal: false, + }); + } + + // if using the basic example, set the name to the project name (legacy behavior) + if (packageJsonContent) { + if (defaultExample) { + packageJsonContent.name = prompts.projectName; + } + + // if we're using a pre-release version of create-turbo, install turbo canary instead of latest + const shouldUsePreRelease = semverPrerelease(cliPkgJson.version) !== null; + if (shouldUsePreRelease && packageJsonContent?.devDependencies?.turbo) { + packageJsonContent.devDependencies.turbo = "canary"; + } + + try { + fs.writeJsonSync(rootPackageJsonPath, packageJsonContent, { + spaces: 2, + }); + } catch (err) { + throw new TransformError("Unable to write package.json", { + transform: meta.name, + fatal: false, + }); + } + } + } + + return { result: "success", ...meta }; +} |
