create-cloudflare 0.0.0-fa42550d → 0.0.0-fa42d7ca

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (121) hide show
  1. package/dist/cli.js +35977 -36045
  2. package/dist/tsconfig.tsbuildinfo +1 -0
  3. package/package.json +24 -23
  4. package/templates/analog/c3.ts +134 -0
  5. package/templates/analog/snippets/devBindingsModule.ts +7 -0
  6. package/templates/analog/templates/env.d.ts +13 -0
  7. package/templates/analog/templates/src/dev-bindings.ts +18 -0
  8. package/templates/analog/templates/worker-configuration.d.ts +4 -0
  9. package/templates/analog/templates/wrangler.toml +85 -0
  10. package/templates/angular/c3.ts +8 -5
  11. package/templates/astro/c3.ts +11 -10
  12. package/templates/astro/snippets/runtimeDeclaration.ts +2 -1
  13. package/templates/astro/templates/wrangler.toml +60 -25
  14. package/templates/common/js/.editorconfig +0 -1
  15. package/templates/common/js/package.json +1 -1
  16. package/templates/common/js/wrangler.toml +78 -22
  17. package/templates/common/ts/.editorconfig +0 -1
  18. package/templates/common/ts/package.json +4 -3
  19. package/templates/common/ts/src/ab-test.ts +2 -2
  20. package/templates/common/ts/src/index.ts +5 -2
  21. package/templates/common/ts/src/proxy.ts +2 -2
  22. package/templates/common/ts/src/redirect.ts +2 -2
  23. package/templates/common/ts/tsconfig.json +1 -1
  24. package/templates/common/ts/worker-configuration.d.ts +2 -14
  25. package/templates/common/ts/wrangler.toml +78 -22
  26. package/templates/docusaurus/c3.ts +2 -2
  27. package/templates/gatsby/c3.ts +2 -2
  28. package/templates/hello-world/js/.editorconfig +0 -1
  29. package/templates/hello-world/js/package.json +5 -2
  30. package/templates/hello-world/js/test/index.spec.js +20 -0
  31. package/templates/hello-world/js/vitest.config.js +11 -0
  32. package/templates/hello-world/js/wrangler.toml +79 -22
  33. package/templates/hello-world/ts/.editorconfig +0 -1
  34. package/templates/hello-world/ts/package.json +7 -3
  35. package/templates/hello-world/ts/src/index.ts +5 -19
  36. package/templates/hello-world/ts/test/index.spec.ts +25 -0
  37. package/templates/hello-world/ts/test/tsconfig.json +8 -0
  38. package/templates/hello-world/ts/tsconfig.json +4 -3
  39. package/templates/hello-world/ts/vitest.config.mts +11 -0
  40. package/templates/hello-world/ts/worker-configuration.d.ts +4 -0
  41. package/templates/hello-world/ts/wrangler.toml +79 -22
  42. package/templates/hello-world-durable-object/c3.ts +1 -1
  43. package/templates/hello-world-durable-object/js/.editorconfig +0 -1
  44. package/templates/hello-world-durable-object/js/package.json +1 -1
  45. package/templates/hello-world-durable-object/js/src/index.js +18 -14
  46. package/templates/hello-world-durable-object/js/wrangler.toml +78 -22
  47. package/templates/hello-world-durable-object/ts/.editorconfig +0 -1
  48. package/templates/hello-world-durable-object/ts/package.json +4 -4
  49. package/templates/hello-world-durable-object/ts/src/index.ts +26 -18
  50. package/templates/hello-world-durable-object/ts/tsconfig.json +1 -1
  51. package/templates/hello-world-durable-object/ts/worker-configuration.d.ts +6 -0
  52. package/templates/hello-world-durable-object/ts/wrangler.toml +78 -22
  53. package/templates/hello-world-python/c3.ts +9 -0
  54. package/templates/hello-world-python/py/__dot__gitignore +68 -0
  55. package/templates/hello-world-python/py/package.json +13 -0
  56. package/templates/hello-world-python/py/src/entry.py +4 -0
  57. package/templates/hello-world-python/py/wrangler.toml +108 -0
  58. package/templates/hono/c3.ts +54 -1
  59. package/templates/hono/snippets/appDeclaration.ts +1 -0
  60. package/templates/hono/snippets/bindingsType.ts +3 -0
  61. package/templates/hono/templates/worker-configuration.d.ts +4 -0
  62. package/templates/hono/templates/wrangler.toml +107 -0
  63. package/templates/next/README.md +12 -2
  64. package/templates/next/app/js/app/api/hello/route.js +1 -1
  65. package/templates/next/app/ts/app/api/hello/route.ts +1 -1
  66. package/templates/next/c3.ts +36 -14
  67. package/templates/next/env.d.ts +3 -5
  68. package/templates/next/pages/js/pages/api/hello.js +1 -1
  69. package/templates/next/pages/ts/pages/api/hello.ts +1 -1
  70. package/templates/next/wrangler.toml +59 -30
  71. package/templates/nuxt/c3.ts +16 -16
  72. package/templates/nuxt/templates/worker-configuration.d.ts +4 -3
  73. package/templates/nuxt/templates/wrangler.toml +60 -25
  74. package/templates/openapi/ts/README.md +3 -3
  75. package/templates/openapi/ts/package.json +7 -4
  76. package/templates/openapi/ts/src/endpoints/taskCreate.ts +26 -16
  77. package/templates/openapi/ts/src/endpoints/taskDelete.ts +20 -19
  78. package/templates/openapi/ts/src/endpoints/taskFetch.ts +30 -23
  79. package/templates/openapi/ts/src/endpoints/taskList.ts +27 -24
  80. package/templates/openapi/ts/src/index.ts +14 -20
  81. package/templates/openapi/ts/src/types.ts +9 -8
  82. package/templates/openapi/ts/worker-configuration.d.ts +4 -0
  83. package/templates/openapi/ts/wrangler.toml +104 -0
  84. package/templates/pre-existing/c3.ts +7 -7
  85. package/templates/pre-existing/js/.editorconfig +0 -1
  86. package/templates/pre-existing/js/package.json +1 -1
  87. package/templates/pre-existing/js/wrangler.toml +1 -0
  88. package/templates/queues/js/.editorconfig +0 -1
  89. package/templates/queues/js/package.json +1 -1
  90. package/templates/queues/js/wrangler.toml +95 -2
  91. package/templates/queues/ts/.editorconfig +0 -1
  92. package/templates/queues/ts/package.json +4 -3
  93. package/templates/queues/ts/src/index.ts +6 -8
  94. package/templates/queues/ts/tsconfig.json +1 -1
  95. package/templates/queues/ts/worker-configuration.d.ts +5 -0
  96. package/templates/queues/ts/wrangler.toml +95 -2
  97. package/templates/qwik/c3.ts +9 -9
  98. package/templates/qwik/templates/worker-configuration.d.ts +4 -3
  99. package/templates/qwik/templates/wrangler.toml +60 -25
  100. package/templates/react/c3.ts +2 -2
  101. package/templates/remix/c3.ts +6 -6
  102. package/templates/remix/templates/worker-configuration.d.ts +4 -3
  103. package/templates/remix/templates/wrangler.toml +60 -25
  104. package/templates/scheduled/js/.editorconfig +0 -1
  105. package/templates/scheduled/js/package.json +3 -3
  106. package/templates/scheduled/js/src/index.js +8 -1
  107. package/templates/scheduled/js/wrangler.toml +104 -0
  108. package/templates/scheduled/ts/.editorconfig +0 -1
  109. package/templates/scheduled/ts/package.json +5 -4
  110. package/templates/scheduled/ts/src/index.ts +6 -23
  111. package/templates/scheduled/ts/tsconfig.json +1 -1
  112. package/templates/scheduled/ts/worker-configuration.d.ts +4 -0
  113. package/templates/scheduled/ts/wrangler.toml +104 -0
  114. package/templates/solid/c3.ts +19 -14
  115. package/templates/solid/templates/wrangler.toml +84 -0
  116. package/templates/svelte/c3.ts +12 -11
  117. package/templates/svelte/js/wrangler.toml +60 -25
  118. package/templates/svelte/ts/wrangler.toml +60 -25
  119. package/templates/vue/c3.ts +2 -2
  120. package/templates/svelte/js/src/hooks.server.js +0 -25
  121. package/templates/svelte/ts/src/hooks.server.ts +0 -24
@@ -1,24 +1,77 @@
1
1
  import { logRaw } from "@cloudflare/cli";
2
- import { runFrameworkGenerator } from "helpers/command";
2
+ import { brandColor, dim } from "@cloudflare/cli/colors";
3
+ import { spinner } from "@cloudflare/cli/interactive";
4
+ import { runFrameworkGenerator } from "frameworks/index";
5
+ import { loadTemplateSnippets, transformFile } from "helpers/codemod";
6
+ import { detectPackageManager } from "helpers/packageManagers";
3
7
  import type { TemplateConfig } from "../../src/templates";
8
+ import type * as recast from "recast";
4
9
  import type { C3Context } from "types";
5
10
 
6
11
  const generate = async (ctx: C3Context) => {
12
+ const { name: pm } = detectPackageManager();
13
+
7
14
  await runFrameworkGenerator(ctx, [
8
15
  ctx.project.name,
9
16
  "--template",
10
17
  "cloudflare-workers",
18
+ "--install",
19
+ "--pm",
20
+ pm,
11
21
  ]);
12
22
 
13
23
  logRaw(""); // newline
14
24
  };
15
25
 
26
+ const configure = async (ctx: C3Context) => {
27
+ const indexFile = "src/index.ts";
28
+
29
+ const s = spinner();
30
+ s.start(`Updating \`${indexFile}\``);
31
+
32
+ const snippets = loadTemplateSnippets(ctx);
33
+
34
+ transformFile(indexFile, {
35
+ // Insert the env declaration after the last import (but before the rest of the body)
36
+ visitProgram: function (n) {
37
+ const lastImportIndex = n.node.body.findLastIndex(
38
+ (t) => t.type === "ImportDeclaration",
39
+ );
40
+ const lastImport = n.get("body", lastImportIndex);
41
+ lastImport.insertAfter(...snippets.bindingsTypeTs);
42
+
43
+ return this.traverse(n);
44
+ },
45
+ visitVariableDeclarator(n) {
46
+ if (n.node.id.type === "Identifier" && n.node.id.name === "app") {
47
+ n.node.init = snippets
48
+ .appDeclarationTs[0] as recast.types.namedTypes.NewExpression;
49
+
50
+ return false;
51
+ }
52
+ },
53
+ });
54
+
55
+ s.stop(`${brandColor("updated")} \`${dim(indexFile)}\``);
56
+ };
57
+
16
58
  const config: TemplateConfig = {
17
59
  configVersion: 1,
18
60
  id: "hono",
19
61
  displayName: "Hono",
62
+ copyFiles: {
63
+ path: "./templates",
64
+ },
20
65
  platform: "workers",
21
66
  generate,
67
+ configure,
68
+ transformPackageJson: async () => ({
69
+ scripts: {
70
+ dev: "wrangler dev",
71
+ deploy: "wrangler deploy --minify",
72
+ "cf-typegen": "wrangler types --env-interface CloudflareBindings",
73
+ },
74
+ }),
22
75
  devScript: "dev",
23
76
  deployScript: "deploy",
24
77
  };
@@ -0,0 +1 @@
1
+ new Hono<{ Bindings: Bindings }>()
@@ -0,0 +1,3 @@
1
+ type Bindings = {
2
+ [key in keyof CloudflareBindings]: CloudflareBindings[key]
3
+ }
@@ -0,0 +1,4 @@
1
+ // Generated by Wrangler
2
+ // After adding bindings to `wrangler.toml`, regenerate this interface via `npm run cf-typegen`
3
+ interface CloudflareBindings {
4
+ }
@@ -0,0 +1,107 @@
1
+ #:schema node_modules/wrangler/config-schema.json
2
+ name = "<TBD>"
3
+ main = "src/index.ts"
4
+ compatibility_date = "<TBD>"
5
+
6
+ # Automatically place your workloads in an optimal location to minimize latency.
7
+ # If you are running back-end logic in a Worker, running it closer to your back-end infrastructure
8
+ # rather than the end user may result in better performance.
9
+ # Docs: https://developers.cloudflare.com/workers/configuration/smart-placement/#smart-placement
10
+ # [placement]
11
+ # mode = "smart"
12
+
13
+ # Variable bindings. These are arbitrary, plaintext strings (similar to environment variables)
14
+ # Docs:
15
+ # - https://developers.cloudflare.com/workers/wrangler/configuration/#environment-variables
16
+ # Note: Use secrets to store sensitive data.
17
+ # - https://developers.cloudflare.com/workers/configuration/secrets/
18
+ # [vars]
19
+ # MY_VARIABLE = "production_value"
20
+
21
+ # Bind the Workers AI model catalog. Run machine learning models, powered by serverless GPUs, on Cloudflare’s global network
22
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#workers-ai
23
+ # [ai]
24
+ # binding = "AI"
25
+
26
+ # Bind an Analytics Engine dataset. Use Analytics Engine to write analytics within your Pages Function.
27
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#analytics-engine-datasets
28
+ # [[analytics_engine_datasets]]
29
+ # binding = "MY_DATASET"
30
+
31
+ # Bind a headless browser instance running on Cloudflare's global network.
32
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#browser-rendering
33
+ # [browser]
34
+ # binding = "MY_BROWSER"
35
+
36
+ # Bind a D1 database. D1 is Cloudflare’s native serverless SQL database.
37
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#d1-databases
38
+ # [[d1_databases]]
39
+ # binding = "MY_DB"
40
+ # database_name = "my-database"
41
+ # database_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
42
+
43
+ # Bind a dispatch namespace. Use Workers for Platforms to deploy serverless functions programmatically on behalf of your customers.
44
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#dispatch-namespace-bindings-workers-for-platforms
45
+ # [[dispatch_namespaces]]
46
+ # binding = "MY_DISPATCHER"
47
+ # namespace = "my-namespace"
48
+
49
+ # Bind a Durable Object. Durable objects are a scale-to-zero compute primitive based on the actor model.
50
+ # Durable Objects can live for as long as needed. Use these when you need a long-running "server", such as in realtime apps.
51
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#durable-objects
52
+ # [[durable_objects.bindings]]
53
+ # name = "MY_DURABLE_OBJECT"
54
+ # class_name = "MyDurableObject"
55
+
56
+ # Durable Object migrations.
57
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#migrations
58
+ # [[migrations]]
59
+ # tag = "v1"
60
+ # new_classes = ["MyDurableObject"]
61
+
62
+ # Bind a Hyperdrive configuration. Use to accelerate access to your existing databases from Cloudflare Workers.
63
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#hyperdrive
64
+ # [[hyperdrive]]
65
+ # binding = "MY_HYPERDRIVE"
66
+ # id = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
67
+
68
+ # Bind a KV Namespace. Use KV as persistent storage for small key-value pairs.
69
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#kv-namespaces
70
+ # [[kv_namespaces]]
71
+ # binding = "MY_KV_NAMESPACE"
72
+ # id = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
73
+
74
+ # Bind an mTLS certificate. Use to present a client certificate when communicating with another service.
75
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#mtls-certificates
76
+ # [[mtls_certificates]]
77
+ # binding = "MY_CERTIFICATE"
78
+ # certificate_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
79
+
80
+ # Bind a Queue producer. Use this binding to schedule an arbitrary task that may be processed later by a Queue consumer.
81
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#queues
82
+ # [[queues.producers]]
83
+ # binding = "MY_QUEUE"
84
+ # queue = "my-queue"
85
+
86
+ # Bind a Queue consumer. Queue Consumers can retrieve tasks scheduled by Producers to act on them.
87
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#queues
88
+ # [[queues.consumers]]
89
+ # queue = "my-queue"
90
+
91
+ # Bind an R2 Bucket. Use R2 to store arbitrarily large blobs of data, such as files.
92
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#r2-buckets
93
+ # [[r2_buckets]]
94
+ # binding = "MY_BUCKET"
95
+ # bucket_name = "my-bucket"
96
+
97
+ # Bind another Worker service. Use this binding to call another Worker without network overhead.
98
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#service-bindings
99
+ # [[services]]
100
+ # binding = "MY_SERVICE"
101
+ # service = "my-service"
102
+
103
+ # Bind a Vectorize index. Use to store and query vector embeddings for semantic search, classification and other vector search use-cases.
104
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#vectorize-indexes
105
+ # [[vectorize]]
106
+ # binding = "MY_INDEX"
107
+ # index_name = "my-index"
@@ -23,7 +23,7 @@ Besides the `dev` script mentioned above `c3` has added a few extra scripts that
23
23
  - `preview` to locally preview your Pages application using the [Wrangler](https://developers.cloudflare.com/workers/wrangler/) CLI
24
24
  - `deploy` to deploy your Pages application using the [Wrangler](https://developers.cloudflare.com/workers/wrangler/) CLI
25
25
 
26
- > __Note:__ while the `dev` script is optimal for local development you should preview your Pages application as well (periodically or before deployments) in order to make sure that it can properly work in the Pages environment (for more details see the [`@cloudflare/next-on-pages` recommended workflow](https://github.com/cloudflare/next-on-pages/blob/05b6256/internal-packages/next-dev/README.md#recommended-workflow))
26
+ > __Note:__ while the `dev` script is optimal for local development you should preview your Pages application as well (periodically or before deployments) in order to make sure that it can properly work in the Pages environment (for more details see the [`@cloudflare/next-on-pages` recommended workflow](https://github.com/cloudflare/next-on-pages/blob/main/internal-packages/next-dev/README.md#recommended-development-workflow))
27
27
 
28
28
  ### Bindings
29
29
 
@@ -52,7 +52,17 @@ In order to enable the example:
52
52
  ```
53
53
  # KV Example:
54
54
  ```
55
+ - If you're using TypeScript run the `cf-typegen` script to update the `env.d.ts` file:
56
+ ```bash
57
+ npm run cf-typegen
58
+ # or
59
+ yarn cf-typegen
60
+ # or
61
+ pnpm cf-typegen
62
+ # or
63
+ bun cf-typegen
64
+ ```
55
65
 
56
66
  After doing this you can run the `dev` or `preview` script and visit the `/api/hello` route to see the example in action.
57
67
 
58
- Finally, if you also want to see the example work in the deployed application make sure to add a `MY_KV` binding to your Pages application in its [dashboard kv bindings settings section](https://dash.cloudflare.com/?to=/:account/pages/view/:pages-project/settings/functions#kv_namespace_bindings_section). After having configured it make sure to re-deploy your application.
68
+ Finally, if you also want to see the example work in the deployed application make sure to add a `MY_KV_NAMESPACE` binding to your Pages application in its [dashboard kv bindings settings section](https://dash.cloudflare.com/?to=/:account/pages/view/:pages-project/settings/functions#kv_namespace_bindings_section). After having configured it make sure to re-deploy your application.
@@ -12,7 +12,7 @@ export async function GET(request) {
12
12
  // )
13
13
  //
14
14
  // KV Example:
15
- // const myKv = getRequestContext().env.MY_KV
15
+ // const myKv = getRequestContext().env.MY_KV_NAMESPACE
16
16
  // await myKv.put('suffix', ' from a KV store!')
17
17
  // const suffix = await myKv.get('suffix')
18
18
  // responseText += suffix
@@ -13,7 +13,7 @@ export async function GET(request: NextRequest) {
13
13
  // )
14
14
  //
15
15
  // KV Example:
16
- // const myKv = getRequestContext().env.MY_KV
16
+ // const myKv = getRequestContext().env.MY_KV_NAMESPACE
17
17
  // await myKv.put('suffix', ' from a KV store!')
18
18
  // const suffix = await myKv.get('suffix')
19
19
  // responseText += suffix
@@ -3,7 +3,7 @@ import { crash, updateStatus, warn } from "@cloudflare/cli";
3
3
  import { processArgument } from "@cloudflare/cli/args";
4
4
  import { brandColor, dim } from "@cloudflare/cli/colors";
5
5
  import { spinner } from "@cloudflare/cli/interactive";
6
- import { installPackages, runFrameworkGenerator } from "helpers/command";
6
+ import { runFrameworkGenerator } from "frameworks/index";
7
7
  import {
8
8
  copyFile,
9
9
  probePaths,
@@ -14,7 +14,8 @@ import {
14
14
  writeFile,
15
15
  writeJSON,
16
16
  } from "helpers/files";
17
- import { detectPackageManager } from "helpers/packages";
17
+ import { detectPackageManager } from "helpers/packageManagers";
18
+ import { installPackages } from "helpers/packages";
18
19
  import { getTemplatePath } from "../../src/templates";
19
20
  import type { TemplateConfig } from "../../src/templates";
20
21
  import type { C3Args, C3Context } from "types";
@@ -26,10 +27,26 @@ const generate = async (ctx: C3Context) => {
26
27
 
27
28
  await runFrameworkGenerator(ctx, [projectName]);
28
29
 
29
- copyFile(
30
- join(getTemplatePath(ctx), "wrangler.toml"),
31
- join(ctx.project.path, "wrangler.toml")
30
+ const wranglerToml = readFile(join(getTemplatePath(ctx), "wrangler.toml"));
31
+
32
+ // Note: here we add `# KV Example:` to the toml file for the KV example, we don't actually
33
+ // include the comment in the template wrangler.toml file just so to keep it identical
34
+ // and consistent with that of all the other frameworks
35
+ // (instead of making it a special case which needs extra care)
36
+ const newTomlContent = wranglerToml.replace(
37
+ /#\s+\[\[kv_namespaces\]\]\n#\s+binding\s+=\s+"MY_KV_NAMESPACE"\n#\s+id\s+=\s+"[a-zA-Z0-9]+?"/,
38
+ ($1) => `# KV Example:\n${$1}`,
32
39
  );
40
+
41
+ if (!/# KV Example/.test(newTomlContent)) {
42
+ // This should never happen to users, it is a check mostly so that
43
+ // if the toml file is changed in a way that breaks the "KV Example" addition
44
+ // the C3 Next.js e2e runs will fail with this
45
+ crash("Failed to properly generate the wrangler.toml file");
46
+ }
47
+
48
+ writeFile(join(ctx.project.path, "wrangler.toml"), newTomlContent);
49
+
33
50
  updateStatus("Created wrangler.toml file");
34
51
  };
35
52
 
@@ -46,7 +63,7 @@ const updateNextConfig = () => {
46
63
 
47
64
  // Here we use the @cloudflare/next-on-pages next-dev module to allow us to use bindings during local development
48
65
  // (when running the application with \`next dev\`), for more information see:
49
- // https://github.com/cloudflare/next-on-pages/blob/5712c57ea7/internal-packages/next-dev/README.md
66
+ // https://github.com/cloudflare/next-on-pages/blob/main/internal-packages/next-dev/README.md
50
67
  if (process.env.NODE_ENV === 'development') {
51
68
  await setupDevPlatform();
52
69
  }
@@ -80,7 +97,7 @@ const configure = async (ctx: C3Context) => {
80
97
  if (usesTs) {
81
98
  copyFile(
82
99
  join(getTemplatePath(ctx), "env.d.ts"),
83
- join(projectPath, "env.d.ts")
100
+ join(projectPath, "env.d.ts"),
84
101
  );
85
102
  updateStatus("Created an env.d.ts file");
86
103
  }
@@ -95,7 +112,7 @@ const configure = async (ctx: C3Context) => {
95
112
 
96
113
  copyFile(
97
114
  join(getTemplatePath(ctx), "README.md"),
98
- join(projectPath, "README.md")
115
+ join(projectPath, "README.md"),
99
116
  );
100
117
  updateStatus("Updated the README file");
101
118
 
@@ -103,15 +120,17 @@ const configure = async (ctx: C3Context) => {
103
120
  };
104
121
 
105
122
  export const shouldInstallNextOnPagesEslintPlugin = async (
106
- ctx: C3Context
123
+ ctx: C3Context,
107
124
  ): Promise<boolean> => {
108
125
  const eslintUsage = usesEslint(ctx);
109
126
 
110
- if (!eslintUsage.used) return false;
127
+ if (!eslintUsage.used) {
128
+ return false;
129
+ }
111
130
 
112
131
  if (eslintUsage.configType !== ".eslintrc.json") {
113
132
  warn(
114
- `Expected .eslintrc.json from Next.js scaffolding but found ${eslintUsage.configType} instead`
133
+ `Expected .eslintrc.json from Next.js scaffolding but found ${eslintUsage.configType} instead`,
115
134
  );
116
135
  return false;
117
136
  }
@@ -191,7 +210,7 @@ export default {
191
210
  },
192
211
  },
193
212
  },
194
- transformPackageJson: async () => {
213
+ transformPackageJson: async (_, ctx) => {
195
214
  const isNpm = npm === "npm";
196
215
  const isBun = npm === "bun";
197
216
  const isNpmOrBun = isNpm || isBun;
@@ -204,8 +223,11 @@ export default {
204
223
  return {
205
224
  scripts: {
206
225
  "pages:build": `${pmCommand} ${nextOnPagesCommand}`,
207
- preview: `${pagesBuildRunCommand} && wrangler pages dev .vercel/output/static`,
208
- deploy: `${pagesBuildRunCommand} && wrangler pages deploy .vercel/output/static`,
226
+ preview: `${pagesBuildRunCommand} && wrangler pages dev`,
227
+ deploy: `${pagesBuildRunCommand} && wrangler pages deploy`,
228
+ ...(usesTypescript(ctx) && {
229
+ "cf-typegen": `wrangler types --env-interface CloudflareEnv env.d.ts`,
230
+ }),
209
231
  },
210
232
  };
211
233
  },
@@ -1,7 +1,5 @@
1
+ // Generated by Wrangler
2
+ // by running `wrangler types --env-interface CloudflareEnv env.d.ts`
3
+
1
4
  interface CloudflareEnv {
2
- // Add here the Cloudflare Bindings you want to have available in your application
3
- // (for more details on Bindings see: https://developers.cloudflare.com/pages/functions/bindings/)
4
- //
5
- // KV Example:
6
- // MY_KV: KVNamespace
7
5
  }
@@ -14,7 +14,7 @@ export default async function handler(req) {
14
14
  // )
15
15
  //
16
16
  // KV Example:
17
- // const myKv = getRequestContext().env.MY_KV
17
+ // const myKv = getRequestContext().env.MY_KV_NAMESPACE
18
18
  // await myKv.put('suffix', ' from a KV store!')
19
19
  // const suffix = await myKv.get('suffix')
20
20
  // responseText += suffix
@@ -15,7 +15,7 @@ export default async function handler(req: NextRequest) {
15
15
  // )
16
16
  //
17
17
  // KV Example:
18
- // const myKv = getRequestContext().env.MY_KV;
18
+ // const myKv = getRequestContext().env.MY_KV_NAMESPACE
19
19
  // await myKv.put('suffix', ' from a KV store!')
20
20
  // const suffix = await myKv.get('suffix')
21
21
  // responseText += suffix
@@ -1,57 +1,86 @@
1
+ #:schema node_modules/wrangler/config-schema.json
1
2
  name = "<TBD>"
2
3
  compatibility_date = "<TBD>"
3
-
4
4
  compatibility_flags = ["nodejs_compat"]
5
+ pages_build_output_dir = ".vercel/output/static"
6
+
7
+ # Automatically place your workloads in an optimal location to minimize latency.
8
+ # If you are running back-end logic in a Pages Function, running it closer to your back-end infrastructure
9
+ # rather than the end user may result in better performance.
10
+ # Docs: https://developers.cloudflare.com/pages/functions/smart-placement/#smart-placement
11
+ # [placement]
12
+ # mode = "smart"
5
13
 
6
14
  # Variable bindings. These are arbitrary, plaintext strings (similar to environment variables)
15
+ # Docs:
16
+ # - https://developers.cloudflare.com/pages/functions/bindings/#environment-variables
7
17
  # Note: Use secrets to store sensitive data.
8
- # Docs: https://developers.cloudflare.com/workers/platform/environment-variables
18
+ # - https://developers.cloudflare.com/pages/functions/bindings/#secrets
9
19
  # [vars]
10
20
  # MY_VARIABLE = "production_value"
11
21
 
22
+ # Bind the Workers AI model catalog. Run machine learning models, powered by serverless GPUs, on Cloudflare’s global network
23
+ # Docs: https://developers.cloudflare.com/pages/functions/bindings/#workers-ai
24
+ # [ai]
25
+ # binding = "AI"
26
+
27
+ # Bind a D1 database. D1 is Cloudflare’s native serverless SQL database.
28
+ # Docs: https://developers.cloudflare.com/pages/functions/bindings/#d1-databases
29
+ # [[d1_databases]]
30
+ # binding = "MY_DB"
31
+ # database_name = "my-database"
32
+ # database_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
33
+
34
+ # Bind a Durable Object. Durable objects are a scale-to-zero compute primitive based on the actor model.
35
+ # Durable Objects can live for as long as needed. Use these when you need a long-running "server", such as in realtime apps.
36
+ # Docs: https://developers.cloudflare.com/workers/runtime-apis/durable-objects
37
+ # [[durable_objects.bindings]]
38
+ # name = "MY_DURABLE_OBJECT"
39
+ # class_name = "MyDurableObject"
40
+ # script_name = 'my-durable-object'
41
+
12
42
  # Bind a KV Namespace. Use KV as persistent storage for small key-value pairs.
13
- # Docs: https://developers.cloudflare.com/workers/runtime-apis/kv
43
+ # Docs: https://developers.cloudflare.com/pages/functions/bindings/#kv-namespaces
14
44
  # [[kv_namespaces]]
15
45
  # binding = "MY_KV_NAMESPACE"
16
46
  # id = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
17
47
 
18
- # Bind an R2 Bucket. Use R2 to store arbitrarily large blobs of data, such as files.
19
- # Docs: https://developers.cloudflare.com/r2/api/workers/workers-api-usage/
20
- # [[r2_buckets]]
21
- # binding = "MY_BUCKET"
22
- # bucket_name = "my-bucket"
23
-
24
48
  # Bind a Queue producer. Use this binding to schedule an arbitrary task that may be processed later by a Queue consumer.
25
- # Docs: https://developers.cloudflare.com/queues/get-started
49
+ # Docs: https://developers.cloudflare.com/pages/functions/bindings/#queue-producers
26
50
  # [[queues.producers]]
27
51
  # binding = "MY_QUEUE"
28
52
  # queue = "my-queue"
29
53
 
30
- # Bind a Queue consumer. Queue Consumers can retrieve tasks scheduled by Producers to act on them.
31
- # Docs: https://developers.cloudflare.com/queues/get-started
32
- # [[queues.consumers]]
33
- # queue = "my-queue"
54
+ # Bind an R2 Bucket. Use R2 to store arbitrarily large blobs of data, such as files.
55
+ # Docs: https://developers.cloudflare.com/pages/functions/bindings/#r2-buckets
56
+ # [[r2_buckets]]
57
+ # binding = "MY_BUCKET"
58
+ # bucket_name = "my-bucket"
34
59
 
35
60
  # Bind another Worker service. Use this binding to call another Worker without network overhead.
36
- # Docs: https://developers.cloudflare.com/workers/platform/services
61
+ # Docs: https://developers.cloudflare.com/pages/functions/bindings/#service-bindings
37
62
  # [[services]]
38
63
  # binding = "MY_SERVICE"
39
64
  # service = "my-service"
40
65
 
41
- # Bind a Durable Object. Durable objects are a scale-to-zero compute primitive based on the actor model.
42
- # Durable Objects can live for as long as needed. Use these when you need a long-running "server", such as in realtime apps.
43
- # Docs: https://developers.cloudflare.com/workers/runtime-apis/durable-objects
44
- # [[durable_objects.bindings]]
45
- # name = "MY_DURABLE_OBJECT"
46
- # class_name = "MyDurableObject"
66
+ # To use different bindings for preview and production environments, follow the examples below.
67
+ # When using environment-specific overrides for bindings, ALL bindings must be specified on a per-environment basis.
68
+ # Docs: https://developers.cloudflare.com/pages/functions/wrangler-configuration#environment-specific-overrides
47
69
 
48
- # Durable Object migrations.
49
- # Docs: https://developers.cloudflare.com/workers/learning/using-durable-objects#configure-durable-object-classes-with-migrations
50
- # [[migrations]]
51
- # tag = "v1"
52
- # new_classes = ["MyDurableObject"]
70
+ ######## PREVIEW environment config ########
53
71
 
54
- # KV Example:
55
- # [[kv_namespaces]]
56
- # binding = "MY_KV"
57
- # id = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
72
+ # [env.preview.vars]
73
+ # API_KEY = "xyz789"
74
+
75
+ # [[env.preview.kv_namespaces]]
76
+ # binding = "MY_KV_NAMESPACE"
77
+ # id = "<PREVIEW_NAMESPACE_ID>"
78
+
79
+ ######## PRODUCTION environment config ########
80
+
81
+ # [env.production.vars]
82
+ # API_KEY = "abc123"
83
+
84
+ # [[env.production.kv_namespaces]]
85
+ # binding = "MY_KV_NAMESPACE"
86
+ # id = "<PRODUCTION_NAMESPACE_ID>"
@@ -1,12 +1,13 @@
1
1
  import { logRaw } from "@cloudflare/cli";
2
2
  import { brandColor, dim } from "@cloudflare/cli/colors";
3
3
  import { spinner } from "@cloudflare/cli/interactive";
4
- import { transformFile } from "helpers/codemod";
5
- import { installPackages, runFrameworkGenerator } from "helpers/command";
4
+ import { runFrameworkGenerator } from "frameworks/index";
5
+ import { mergeObjectProperties, transformFile } from "helpers/codemod";
6
+ import { getLatestTypesEntrypoint } from "helpers/compatDate";
6
7
  import { readFile, writeFile } from "helpers/files";
7
- import { detectPackageManager } from "helpers/packages";
8
+ import { detectPackageManager } from "helpers/packageManagers";
9
+ import { installPackages } from "helpers/packages";
8
10
  import * as recast from "recast";
9
- import { getLatestTypesEntrypoint } from "../../src/workers";
10
11
  import type { TemplateConfig } from "../../src/templates";
11
12
  import type { C3Context } from "types";
12
13
 
@@ -55,7 +56,7 @@ const updateEnvTypes = (ctx: C3Context) => {
55
56
 
56
57
  let file = readFile(filepath);
57
58
 
58
- let typesEntrypoint = `@cloudflare/workers-types/`;
59
+ let typesEntrypoint = `@cloudflare/workers-types`;
59
60
  const latestEntrypoint = getLatestTypesEntrypoint(ctx);
60
61
  if (latestEntrypoint) {
61
62
  typesEntrypoint += `/${latestEntrypoint}`;
@@ -81,25 +82,24 @@ const updateNuxtConfig = () => {
81
82
  b.objectExpression([
82
83
  b.objectProperty(
83
84
  b.identifier("preset"),
84
- b.stringLiteral("cloudflare-pages")
85
+ b.stringLiteral("cloudflare-pages"),
85
86
  ),
86
- ])
87
+ ]),
87
88
  );
88
89
 
89
90
  const moduleDef = b.objectProperty(
90
91
  b.identifier("modules"),
91
- b.arrayExpression([b.stringLiteral("nitro-cloudflare-dev")])
92
+ b.arrayExpression([b.stringLiteral("nitro-cloudflare-dev")]),
92
93
  );
93
94
 
94
95
  transformFile(configFile, {
95
96
  visitCallExpression: function (n) {
96
97
  const callee = n.node.callee as recast.types.namedTypes.Identifier;
97
98
  if (callee.name === "defineNuxtConfig") {
98
- const obj = n.node
99
- .arguments[0] as recast.types.namedTypes.ObjectExpression;
100
-
101
- obj.properties.push(presetDef);
102
- obj.properties.push(moduleDef);
99
+ mergeObjectProperties(
100
+ n.node.arguments[0] as recast.types.namedTypes.ObjectExpression,
101
+ [presetDef, moduleDef],
102
+ );
103
103
  }
104
104
 
105
105
  return this.traverse(n);
@@ -121,9 +121,9 @@ const config: TemplateConfig = {
121
121
  configure,
122
122
  transformPackageJson: async () => ({
123
123
  scripts: {
124
- deploy: `${npm} run build && wrangler pages deploy ./dist`,
125
- preview: `${npm} run build && wrangler pages dev ./dist`,
126
- "build-cf-types": `wrangler types`,
124
+ deploy: `${npm} run build && wrangler pages deploy`,
125
+ preview: `${npm} run build && wrangler pages dev`,
126
+ "cf-typegen": `wrangler types`,
127
127
  },
128
128
  }),
129
129
  devScript: "dev",
@@ -1,3 +1,4 @@
1
- // Generated by Wrangler on Fri Feb 16 2024 15:52:18 GMT-0600 (Central Standard Time)
2
- // After adding bindings to `wrangler.toml`, regenerate this interface via `npm build-cf-types`
3
- interface Env {}
1
+ // Generated by Wrangler
2
+ // After adding bindings to `wrangler.toml`, regenerate this interface via `npm run cf-typegen`
3
+ interface Env {
4
+ }