Skip to content

C3: replace Svelte's pages:dev with pages:preview and add optional previewScript to the c3 summary #4850

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dario-piotrowicz merged 2 commits into from
Jan 29, 2024
Merged

C3: replace Svelte's pages:dev with pages:preview and add optional previewScript to the c3 summary #4850

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c0a6a56
C3: replace svelteKit `pages:dev` script with `pages:preview`
dario-piotrowicz Jan 28, 2024
307ad11
C3: add new optional `previewScript`
dario-piotrowicz Jan 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .changeset/forty-needles-turn.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
"create-cloudflare": minor
---

introduce a new optional `previewScript` to the C3 summary

such script is to be used to locally preview the application (using wrangler)
8 changes: 8 additions & 0 deletions .changeset/four-teachers-push.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
"create-cloudflare": patch
---

update the svelteKit c3 scripts

replace the incorrect `pages:dev` with a new `pages:preview` script
(and use the standard `dev` script as the `devScript`)
22 changes: 15 additions & 7 deletions packages/create-cloudflare/src/common.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -286,36 +286,44 @@ export const printSummary = async (ctx: C3Context) => {
const dirRelativePath = relative(ctx.originalCWD, ctx.project.path);
const nextSteps = [
dirRelativePath
? [`Navigate to the new directory`, `cd ${dirRelativePath}`]
? ["Navigate to the new directory", `cd ${dirRelativePath}`]
: [],
[
`Run the development server`,
"Run the development server",
quoteShellArgs([npm, "run", ctx.template.devScript ?? "start"]),
],
...(ctx.template.previewScript
? [
[
"Preview your application",
quoteShellArgs([npm, "run", ctx.template.previewScript]),
],
]
: []),
[
`Deploy your application`,
"Deploy your application",
quoteShellArgs([npm, "run", ctx.template.deployScript ?? "deploy"]),
],
[
`Read the documentation`,
"Read the documentation",
`https://developers.cloudflare.com/${ctx.template.platform}`,
],
[`Stuck? Join us at`, `https://discord.gg/cloudflaredev`],
["Stuck? Join us at", "https://discord.gg/cloudflaredev"],
];

if (ctx.deployment.url) {
const msg = [
`${gray(shapes.leftT)}`,
`${bgGreen(" SUCCESS ")}`,
`${dim(`View your deployed application at`)}`,
`${dim("View your deployed application at")}`,
`${blue(ctx.deployment.url)}`,
].join(" ");
logRaw(msg);
} else {
const msg = [
`${gray(shapes.leftT)}`,
`${bgGreen(" APPLICATION CREATED ")}`,
`${dim(`Deploy your application with`)}`,
`${dim("Deploy your application with")}`,
`${blue(
quoteShellArgs([npm, "run", ctx.template.deployScript ?? "deploy"])
)}`,
Expand Down
2 changes: 2 additions & 0 deletions packages/create-cloudflare/src/templates.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,8 @@ export type TemplateConfig = {
deployScript?: string;
/** The key of the package.json "scripts" entry for developing the project. Defaults to `pages:dev` */
devScript?: string;
/** The key of the package.json "scripts" entry for previewing the project. Defaults to undefined (there might not be such script) */
previewScript?: string;

/** The file path of the template. This is used internally and isn't a user facing config value.*/
path?: string;
Expand Down
1 change: 1 addition & 0 deletions packages/create-cloudflare/templates/next/c3.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,6 +178,7 @@ export default {
platform: "pages",
displayName: "Next",
devScript: "dev",
previewScript: "pages:preview",
generate,
configure,
transformPackageJson: async () => {
Expand Down
1 change: 1 addition & 0 deletions packages/create-cloudflare/templates/solid/c3.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ const config: TemplateConfig = {
},
}),
devScript: "dev",
previewScript: "pages:preview",
compatibilityFlags: ["nodejs_compat"],
};
export default config;
4 changes: 3 additions & 1 deletion packages/create-cloudflare/templates/svelte/c3.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,9 +67,11 @@ const config: TemplateConfig = {
configure,
transformPackageJson: async () => ({
scripts: {
"pages:dev": `wrangler pages dev ${await compatDateFlag()} --proxy 5173 -- ${npm} run dev`,
"pages:preview": `${npm} run build && wrangler pages dev .svelte-kit/cloudflare`,
"pages:deploy": `${npm} run build && wrangler pages deploy .svelte-kit/cloudflare`,
},
}),
devScript: "dev",
previewScript: "pages:preview",
};
export default config;