create-cloudflare 0.0.0-ed4bf220 → 0.0.0-ee305dd67

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 (219) hide show
  1. package/README.md +1 -1
  2. package/dist/cli.js +59201 -57885
  3. package/dist/tsconfig.tsbuildinfo +1 -0
  4. package/package.json +30 -25
  5. package/templates/analog/c3.ts +135 -0
  6. package/templates/analog/snippets/devBindingsModule.ts +7 -0
  7. package/templates/analog/templates/env.d.ts +13 -0
  8. package/templates/analog/templates/src/dev-bindings.ts +18 -0
  9. package/templates/analog/templates/worker-configuration.d.ts +4 -0
  10. package/templates/analog/templates/wrangler.toml +85 -0
  11. package/templates/angular/c3.ts +14 -11
  12. package/templates/astro/c3.ts +83 -20
  13. package/templates/astro/snippets/runtimeDeclaration.ts +5 -0
  14. package/templates/astro/templates/wrangler.toml +86 -0
  15. package/templates/common/c3.ts +3 -0
  16. package/templates/common/js/.editorconfig +0 -1
  17. package/templates/common/js/package.json +1 -1
  18. package/templates/common/js/wrangler.toml +84 -22
  19. package/templates/common/ts/.editorconfig +0 -1
  20. package/templates/common/ts/package.json +4 -3
  21. package/templates/common/ts/src/ab-test.ts +2 -2
  22. package/templates/common/ts/src/index.ts +5 -2
  23. package/templates/common/ts/src/proxy.ts +2 -2
  24. package/templates/common/ts/src/redirect.ts +2 -2
  25. package/templates/common/ts/tsconfig.json +37 -95
  26. package/templates/common/ts/worker-configuration.d.ts +2 -14
  27. package/templates/common/ts/wrangler.toml +84 -22
  28. package/templates/docusaurus/c3.ts +7 -6
  29. package/templates/gatsby/c3.ts +8 -5
  30. package/templates/hello-world/c3.ts +5 -1
  31. package/templates/hello-world/js/.editorconfig +0 -1
  32. package/templates/hello-world/js/package.json +5 -2
  33. package/templates/hello-world/js/test/index.spec.js +20 -0
  34. package/templates/hello-world/js/vitest.config.js +11 -0
  35. package/templates/hello-world/js/wrangler.toml +85 -22
  36. package/templates/hello-world/py/__dot__gitignore +68 -0
  37. package/templates/hello-world/py/package.json +13 -0
  38. package/templates/hello-world/py/src/entry.py +4 -0
  39. package/templates/hello-world/py/wrangler.toml +114 -0
  40. package/templates/hello-world/ts/.editorconfig +0 -1
  41. package/templates/hello-world/ts/package.json +7 -3
  42. package/templates/hello-world/ts/src/index.ts +5 -19
  43. package/templates/hello-world/ts/test/index.spec.ts +25 -0
  44. package/templates/hello-world/ts/test/tsconfig.json +8 -0
  45. package/templates/hello-world/ts/tsconfig.json +39 -96
  46. package/templates/hello-world/ts/vitest.config.mts +11 -0
  47. package/templates/hello-world/ts/worker-configuration.d.ts +4 -0
  48. package/templates/hello-world/ts/wrangler.toml +85 -22
  49. package/templates/hello-world-durable-object/c3.ts +3 -1
  50. package/templates/hello-world-durable-object/js/.editorconfig +0 -1
  51. package/templates/hello-world-durable-object/js/package.json +1 -1
  52. package/templates/hello-world-durable-object/js/src/index.js +18 -14
  53. package/templates/hello-world-durable-object/js/wrangler.toml +84 -22
  54. package/templates/hello-world-durable-object/ts/.editorconfig +0 -1
  55. package/templates/hello-world-durable-object/ts/package.json +4 -4
  56. package/templates/hello-world-durable-object/ts/src/index.ts +24 -37
  57. package/templates/hello-world-durable-object/ts/tsconfig.json +36 -95
  58. package/templates/hello-world-durable-object/ts/worker-configuration.d.ts +5 -0
  59. package/templates/hello-world-durable-object/ts/wrangler.toml +84 -22
  60. package/templates/hono/c3.ts +45 -1
  61. package/templates/hono/snippets/appDeclaration.ts +1 -0
  62. package/templates/hono/templates/worker-configuration.d.ts +4 -0
  63. package/templates/hono/templates/wrangler.toml +113 -0
  64. package/templates/next/README.md +12 -2
  65. package/templates/next/app/js/app/api/hello/route.js +1 -1
  66. package/templates/next/app/ts/app/api/hello/route.ts +1 -1
  67. package/templates/next/c3.ts +45 -33
  68. package/templates/next/env.d.ts +3 -5
  69. package/templates/next/pages/js/pages/api/hello.js +1 -1
  70. package/templates/next/pages/ts/pages/api/hello.ts +1 -1
  71. package/templates/next/wrangler.toml +59 -30
  72. package/templates/nuxt/c3.ts +55 -20
  73. package/templates/nuxt/templates/env.d.ts +14 -0
  74. package/templates/nuxt/templates/worker-configuration.d.ts +4 -0
  75. package/templates/nuxt/templates/wrangler.toml +61 -25
  76. package/templates/openapi/c3.ts +1 -0
  77. package/templates/openapi/ts/README.md +3 -3
  78. package/templates/openapi/ts/package.json +7 -4
  79. package/templates/openapi/ts/src/endpoints/taskCreate.ts +26 -16
  80. package/templates/openapi/ts/src/endpoints/taskDelete.ts +20 -19
  81. package/templates/openapi/ts/src/endpoints/taskFetch.ts +30 -23
  82. package/templates/openapi/ts/src/endpoints/taskList.ts +27 -24
  83. package/templates/openapi/ts/src/index.ts +14 -20
  84. package/templates/openapi/ts/src/types.ts +9 -8
  85. package/templates/openapi/ts/worker-configuration.d.ts +4 -0
  86. package/templates/openapi/ts/wrangler.toml +110 -0
  87. package/templates/pre-existing/c3.ts +34 -15
  88. package/templates/pre-existing/js/.editorconfig +0 -1
  89. package/templates/pre-existing/js/package.json +1 -1
  90. package/templates/pre-existing/js/wrangler.toml +1 -0
  91. package/templates/queues/c3.ts +2 -0
  92. package/templates/queues/js/.editorconfig +0 -1
  93. package/templates/queues/js/package.json +1 -1
  94. package/templates/queues/js/wrangler.toml +101 -2
  95. package/templates/queues/ts/.editorconfig +0 -1
  96. package/templates/queues/ts/package.json +4 -3
  97. package/templates/queues/ts/src/index.ts +6 -8
  98. package/templates/queues/ts/tsconfig.json +36 -95
  99. package/templates/queues/ts/worker-configuration.d.ts +5 -0
  100. package/templates/queues/ts/wrangler.toml +101 -2
  101. package/templates/qwik/c3.ts +82 -30
  102. package/templates/qwik/snippets/getPlatformProxy.ts +6 -0
  103. package/templates/qwik/templates/worker-configuration.d.ts +4 -0
  104. package/templates/qwik/templates/wrangler.toml +61 -25
  105. package/templates/react/c3.ts +38 -6
  106. package/templates/remix/c3.ts +40 -6
  107. package/templates/remix/templates/worker-configuration.d.ts +4 -0
  108. package/templates/remix/templates/wrangler.toml +85 -0
  109. package/templates/scheduled/c3.ts +2 -0
  110. package/templates/scheduled/js/.editorconfig +0 -1
  111. package/templates/scheduled/js/package.json +3 -3
  112. package/templates/scheduled/js/src/index.js +8 -1
  113. package/templates/scheduled/js/wrangler.toml +110 -0
  114. package/templates/scheduled/ts/.editorconfig +0 -1
  115. package/templates/scheduled/ts/package.json +5 -4
  116. package/templates/scheduled/ts/src/index.ts +6 -23
  117. package/templates/scheduled/ts/tsconfig.json +36 -95
  118. package/templates/scheduled/ts/worker-configuration.d.ts +4 -0
  119. package/templates/scheduled/ts/wrangler.toml +110 -0
  120. package/templates/solid/c3.ts +61 -13
  121. package/templates/solid/templates/wrangler.toml +84 -0
  122. package/templates/svelte/c3.ts +15 -13
  123. package/templates/svelte/js/wrangler.toml +60 -25
  124. package/templates/svelte/ts/wrangler.toml +60 -25
  125. package/templates/vue/c3.ts +8 -6
  126. package/templates-experimental/angular/c3.ts +98 -0
  127. package/templates-experimental/angular/templates/server.ts +34 -0
  128. package/templates-experimental/angular/templates/tools/alter-polyfills.mjs +32 -0
  129. package/templates-experimental/angular/templates/wrangler.toml +11 -0
  130. package/templates-experimental/astro/c3.ts +114 -0
  131. package/templates-experimental/astro/snippets/runtimeDeclaration.ts +5 -0
  132. package/templates-experimental/astro/templates/public/.assetsignore +4 -0
  133. package/templates-experimental/astro/templates/wrangler.toml +12 -0
  134. package/templates-experimental/docusaurus/c3.ts +32 -0
  135. package/templates-experimental/docusaurus/templates/wrangler.toml +10 -0
  136. package/templates-experimental/gatsby/c3.ts +53 -0
  137. package/templates-experimental/gatsby/templates/wrangler.toml +10 -0
  138. package/templates-experimental/hello-world-assets-only/c3.ts +15 -0
  139. package/templates-experimental/hello-world-assets-only/templates/package.json +13 -0
  140. package/templates-experimental/hello-world-assets-only/templates/public/index.html +11 -0
  141. package/templates-experimental/hello-world-assets-only/templates/wrangler.toml +10 -0
  142. package/templates-experimental/hello-world-durable-object-with-assets/c3.ts +23 -0
  143. package/templates-experimental/hello-world-durable-object-with-assets/js/.editorconfig +12 -0
  144. package/templates-experimental/hello-world-durable-object-with-assets/js/.prettierrc +6 -0
  145. package/templates-experimental/hello-world-durable-object-with-assets/js/__dot__gitignore +172 -0
  146. package/templates-experimental/hello-world-durable-object-with-assets/js/package.json +13 -0
  147. package/templates-experimental/hello-world-durable-object-with-assets/js/public/index.html +19 -0
  148. package/templates-experimental/hello-world-durable-object-with-assets/js/src/index.js +69 -0
  149. package/templates-experimental/hello-world-durable-object-with-assets/js/wrangler.toml +24 -0
  150. package/templates-experimental/hello-world-durable-object-with-assets/ts/.editorconfig +12 -0
  151. package/templates-experimental/hello-world-durable-object-with-assets/ts/.prettierrc +6 -0
  152. package/templates-experimental/hello-world-durable-object-with-assets/ts/__dot__gitignore +172 -0
  153. package/templates-experimental/hello-world-durable-object-with-assets/ts/package.json +15 -0
  154. package/templates-experimental/hello-world-durable-object-with-assets/ts/public/index.html +19 -0
  155. package/templates-experimental/hello-world-durable-object-with-assets/ts/src/index.ts +66 -0
  156. package/templates-experimental/hello-world-durable-object-with-assets/ts/tsconfig.json +42 -0
  157. package/templates-experimental/hello-world-durable-object-with-assets/ts/worker-configuration.d.ts +5 -0
  158. package/templates-experimental/hello-world-durable-object-with-assets/ts/wrangler.toml +24 -0
  159. package/templates-experimental/hello-world-with-assets/c3.ts +22 -0
  160. package/templates-experimental/hello-world-with-assets/js/.editorconfig +12 -0
  161. package/templates-experimental/hello-world-with-assets/js/.prettierrc +6 -0
  162. package/templates-experimental/hello-world-with-assets/js/__dot__gitignore +172 -0
  163. package/templates-experimental/hello-world-with-assets/js/package.json +16 -0
  164. package/templates-experimental/hello-world-with-assets/js/public/index.html +31 -0
  165. package/templates-experimental/hello-world-with-assets/js/src/index.js +23 -0
  166. package/templates-experimental/hello-world-with-assets/js/test/index.spec.js +41 -0
  167. package/templates-experimental/hello-world-with-assets/js/vitest.config.js +11 -0
  168. package/templates-experimental/hello-world-with-assets/js/wrangler.toml +12 -0
  169. package/templates-experimental/hello-world-with-assets/py/__dot__gitignore +68 -0
  170. package/templates-experimental/hello-world-with-assets/py/package.json +13 -0
  171. package/templates-experimental/hello-world-with-assets/py/public/index.html +31 -0
  172. package/templates-experimental/hello-world-with-assets/py/src/entry.py +9 -0
  173. package/templates-experimental/hello-world-with-assets/py/wrangler.toml +12 -0
  174. package/templates-experimental/hello-world-with-assets/ts/.editorconfig +12 -0
  175. package/templates-experimental/hello-world-with-assets/ts/.prettierrc +6 -0
  176. package/templates-experimental/hello-world-with-assets/ts/__dot__gitignore +172 -0
  177. package/templates-experimental/hello-world-with-assets/ts/package.json +18 -0
  178. package/templates-experimental/hello-world-with-assets/ts/public/index.html +31 -0
  179. package/templates-experimental/hello-world-with-assets/ts/src/index.ts +26 -0
  180. package/templates-experimental/hello-world-with-assets/ts/test/index.spec.ts +41 -0
  181. package/templates-experimental/hello-world-with-assets/ts/test/tsconfig.json +8 -0
  182. package/templates-experimental/hello-world-with-assets/ts/tsconfig.json +44 -0
  183. package/templates-experimental/hello-world-with-assets/ts/vitest.config.mts +11 -0
  184. package/templates-experimental/hello-world-with-assets/ts/worker-configuration.d.ts +4 -0
  185. package/templates-experimental/hello-world-with-assets/ts/wrangler.toml +12 -0
  186. package/templates-experimental/hono/c3.ts +43 -0
  187. package/templates-experimental/hono/templates/public/index.html +19 -0
  188. package/templates-experimental/hono/templates/src/index.ts +9 -0
  189. package/templates-experimental/hono/templates/worker-configuration.d.ts +4 -0
  190. package/templates-experimental/hono/templates/wrangler.toml +5 -0
  191. package/templates-experimental/next/c3.ts +52 -0
  192. package/templates-experimental/next/templates/__dot__gitignore +42 -0
  193. package/templates-experimental/next/templates/env.d.ts +5 -0
  194. package/templates-experimental/next/templates/wrangler.toml +12 -0
  195. package/templates-experimental/nuxt/c3.ts +135 -0
  196. package/templates-experimental/nuxt/templates/cloudflare-preset/nitro.config.ts +27 -0
  197. package/templates-experimental/nuxt/templates/env.d.ts +14 -0
  198. package/templates-experimental/nuxt/templates/worker-configuration.d.ts +4 -0
  199. package/templates-experimental/nuxt/templates/wrangler.toml +11 -0
  200. package/templates-experimental/qwik/c3.ts +153 -0
  201. package/templates-experimental/qwik/snippets/getPlatformProxy.ts +6 -0
  202. package/templates-experimental/qwik/templates/public/.assetsignore +4 -0
  203. package/templates-experimental/qwik/templates/worker-configuration.d.ts +4 -0
  204. package/templates-experimental/qwik/templates/wrangler.toml +12 -0
  205. package/templates-experimental/remix/c3.ts +52 -0
  206. package/templates-experimental/remix/templates/public/.assetsignore +0 -0
  207. package/templates-experimental/remix/templates/worker-configuration.d.ts +4 -0
  208. package/templates-experimental/remix/templates/wrangler.toml +11 -0
  209. package/templates-experimental/solid/c3.ts +137 -0
  210. package/templates-experimental/solid/templates/wrangler.toml +12 -0
  211. package/templates-experimental/svelte/c3.ts +132 -0
  212. package/templates-experimental/svelte/js/static/.assetsignore +4 -0
  213. package/templates-experimental/svelte/js/wrangler.toml +11 -0
  214. package/templates-experimental/svelte/ts/static/.assetsignore +4 -0
  215. package/templates-experimental/svelte/ts/wrangler.toml +11 -0
  216. package/templates/solid/js/vite.config.js +0 -12
  217. package/templates/solid/ts/vite.config.ts +0 -12
  218. package/templates/svelte/js/src/hooks.server.js +0 -25
  219. package/templates/svelte/ts/src/hooks.server.ts +0 -24
@@ -1,24 +1,68 @@
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
+ visitVariableDeclarator(n) {
36
+ if (n.node.id.type === "Identifier" && n.node.id.name === "app") {
37
+ n.node.init = snippets
38
+ .appDeclarationTs[0] as recast.types.namedTypes.NewExpression;
39
+
40
+ return false;
41
+ }
42
+ },
43
+ });
44
+
45
+ s.stop(`${brandColor("updated")} \`${dim(indexFile)}\``);
46
+ };
47
+
16
48
  const config: TemplateConfig = {
17
49
  configVersion: 1,
18
50
  id: "hono",
51
+ frameworkCli: "create-hono",
19
52
  displayName: "Hono",
53
+ copyFiles: {
54
+ path: "./templates",
55
+ },
20
56
  platform: "workers",
21
57
  generate,
58
+ configure,
59
+ transformPackageJson: async () => ({
60
+ scripts: {
61
+ dev: "wrangler dev",
62
+ deploy: "wrangler deploy --minify",
63
+ "cf-typegen": "wrangler types --env-interface CloudflareBindings",
64
+ },
65
+ }),
22
66
  devScript: "dev",
23
67
  deployScript: "deploy",
24
68
  };
@@ -0,0 +1 @@
1
+ new Hono<{ Bindings: CloudflareBindings }>()
@@ -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,113 @@
1
+ #:schema node_modules/wrangler/config-schema.json
2
+ name = "<TBD>"
3
+ main = "src/index.ts"
4
+ compatibility_date = "<TBD>"
5
+
6
+ # Workers Logs
7
+ # Docs: https://developers.cloudflare.com/workers/observability/logs/workers-logs/
8
+ # Configuration: https://developers.cloudflare.com/workers/observability/logs/workers-logs/#enable-workers-logs
9
+ [observability]
10
+ enabled = true
11
+
12
+ # Automatically place your workloads in an optimal location to minimize latency.
13
+ # If you are running back-end logic in a Worker, running it closer to your back-end infrastructure
14
+ # rather than the end user may result in better performance.
15
+ # Docs: https://developers.cloudflare.com/workers/configuration/smart-placement/#smart-placement
16
+ # [placement]
17
+ # mode = "smart"
18
+
19
+ # Variable bindings. These are arbitrary, plaintext strings (similar to environment variables)
20
+ # Docs:
21
+ # - https://developers.cloudflare.com/workers/wrangler/configuration/#environment-variables
22
+ # Note: Use secrets to store sensitive data.
23
+ # - https://developers.cloudflare.com/workers/configuration/secrets/
24
+ # [vars]
25
+ # MY_VARIABLE = "production_value"
26
+
27
+ # Bind the Workers AI model catalog. Run machine learning models, powered by serverless GPUs, on Cloudflare’s global network
28
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#workers-ai
29
+ # [ai]
30
+ # binding = "AI"
31
+
32
+ # Bind an Analytics Engine dataset. Use Analytics Engine to write analytics within your Pages Function.
33
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#analytics-engine-datasets
34
+ # [[analytics_engine_datasets]]
35
+ # binding = "MY_DATASET"
36
+
37
+ # Bind a headless browser instance running on Cloudflare's global network.
38
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#browser-rendering
39
+ # [browser]
40
+ # binding = "MY_BROWSER"
41
+
42
+ # Bind a D1 database. D1 is Cloudflare’s native serverless SQL database.
43
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#d1-databases
44
+ # [[d1_databases]]
45
+ # binding = "MY_DB"
46
+ # database_name = "my-database"
47
+ # database_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
48
+
49
+ # Bind a dispatch namespace. Use Workers for Platforms to deploy serverless functions programmatically on behalf of your customers.
50
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#dispatch-namespace-bindings-workers-for-platforms
51
+ # [[dispatch_namespaces]]
52
+ # binding = "MY_DISPATCHER"
53
+ # namespace = "my-namespace"
54
+
55
+ # Bind a Durable Object. Durable objects are a scale-to-zero compute primitive based on the actor model.
56
+ # Durable Objects can live for as long as needed. Use these when you need a long-running "server", such as in realtime apps.
57
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#durable-objects
58
+ # [[durable_objects.bindings]]
59
+ # name = "MY_DURABLE_OBJECT"
60
+ # class_name = "MyDurableObject"
61
+
62
+ # Durable Object migrations.
63
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#migrations
64
+ # [[migrations]]
65
+ # tag = "v1"
66
+ # new_classes = ["MyDurableObject"]
67
+
68
+ # Bind a Hyperdrive configuration. Use to accelerate access to your existing databases from Cloudflare Workers.
69
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#hyperdrive
70
+ # [[hyperdrive]]
71
+ # binding = "MY_HYPERDRIVE"
72
+ # id = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
73
+
74
+ # Bind a KV Namespace. Use KV as persistent storage for small key-value pairs.
75
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#kv-namespaces
76
+ # [[kv_namespaces]]
77
+ # binding = "MY_KV_NAMESPACE"
78
+ # id = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
79
+
80
+ # Bind an mTLS certificate. Use to present a client certificate when communicating with another service.
81
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#mtls-certificates
82
+ # [[mtls_certificates]]
83
+ # binding = "MY_CERTIFICATE"
84
+ # certificate_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
85
+
86
+ # Bind a Queue producer. Use this binding to schedule an arbitrary task that may be processed later by a Queue consumer.
87
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#queues
88
+ # [[queues.producers]]
89
+ # binding = "MY_QUEUE"
90
+ # queue = "my-queue"
91
+
92
+ # Bind a Queue consumer. Queue Consumers can retrieve tasks scheduled by Producers to act on them.
93
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#queues
94
+ # [[queues.consumers]]
95
+ # queue = "my-queue"
96
+
97
+ # Bind an R2 Bucket. Use R2 to store arbitrarily large blobs of data, such as files.
98
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#r2-buckets
99
+ # [[r2_buckets]]
100
+ # binding = "MY_BUCKET"
101
+ # bucket_name = "my-bucket"
102
+
103
+ # Bind another Worker service. Use this binding to call another Worker without network overhead.
104
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#service-bindings
105
+ # [[services]]
106
+ # binding = "MY_SERVICE"
107
+ # service = "my-service"
108
+
109
+ # Bind a Vectorize index. Use to store and query vector embeddings for semantic search, classification and other vector search use-cases.
110
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#vectorize-indexes
111
+ # [[vectorize]]
112
+ # binding = "MY_INDEX"
113
+ # 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
@@ -1,9 +1,8 @@
1
1
  import { join } from "path";
2
- import { crash, updateStatus, warn } from "@cloudflare/cli";
3
- import { processArgument } from "@cloudflare/cli/args";
2
+ import { updateStatus, warn } from "@cloudflare/cli";
4
3
  import { brandColor, dim } from "@cloudflare/cli/colors";
5
- import { spinner } from "@cloudflare/cli/interactive";
6
- import { installPackages, runFrameworkGenerator } from "helpers/command";
4
+ import { inputPrompt, spinner } from "@cloudflare/cli/interactive";
5
+ import { runFrameworkGenerator } from "frameworks/index";
7
6
  import {
8
7
  copyFile,
9
8
  probePaths,
@@ -14,10 +13,11 @@ import {
14
13
  writeFile,
15
14
  writeJSON,
16
15
  } from "helpers/files";
17
- import { detectPackageManager } from "helpers/packages";
16
+ import { detectPackageManager } from "helpers/packageManagers";
17
+ import { installPackages } from "helpers/packages";
18
18
  import { getTemplatePath } from "../../src/templates";
19
19
  import type { TemplateConfig } from "../../src/templates";
20
- import type { C3Args, C3Context } from "types";
20
+ import type { C3Context } from "types";
21
21
 
22
22
  const { npm, npx } = detectPackageManager();
23
23
 
@@ -26,10 +26,26 @@ const generate = async (ctx: C3Context) => {
26
26
 
27
27
  await runFrameworkGenerator(ctx, [projectName]);
28
28
 
29
- copyFile(
30
- join(getTemplatePath(ctx), "wrangler.toml"),
31
- join(ctx.project.path, "wrangler.toml")
29
+ const wranglerToml = readFile(join(getTemplatePath(ctx), "wrangler.toml"));
30
+
31
+ // Note: here we add `# KV Example:` to the toml file for the KV example, we don't actually
32
+ // include the comment in the template wrangler.toml file just so to keep it identical
33
+ // and consistent with that of all the other frameworks
34
+ // (instead of making it a special case which needs extra care)
35
+ const newTomlContent = wranglerToml.replace(
36
+ /#\s+\[\[kv_namespaces\]\]\n#\s+binding\s+=\s+"MY_KV_NAMESPACE"\n#\s+id\s+=\s+"[a-zA-Z0-9]+?"/,
37
+ ($1) => `# KV Example:\n${$1}`,
32
38
  );
39
+
40
+ if (!/# KV Example/.test(newTomlContent)) {
41
+ // This should never happen to users, it is a check mostly so that
42
+ // if the toml file is changed in a way that breaks the "KV Example" addition
43
+ // the C3 Next.js e2e runs will fail with this
44
+ throw new Error("Failed to properly generate the wrangler.toml file");
45
+ }
46
+
47
+ writeFile(join(ctx.project.path, "wrangler.toml"), newTomlContent);
48
+
33
49
  updateStatus("Created wrangler.toml file");
34
50
  };
35
51
 
@@ -46,7 +62,7 @@ const updateNextConfig = () => {
46
62
 
47
63
  // Here we use the @cloudflare/next-on-pages next-dev module to allow us to use bindings during local development
48
64
  // (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
65
+ // https://github.com/cloudflare/next-on-pages/blob/main/internal-packages/next-dev/README.md
50
66
  if (process.env.NODE_ENV === 'development') {
51
67
  await setupDevPlatform();
52
68
  }
@@ -72,7 +88,7 @@ const configure = async (ctx: C3Context) => {
72
88
  ]);
73
89
 
74
90
  if (!path) {
75
- crash("Could not find the `/api` or `/app` directory");
91
+ throw new Error("Could not find the `/api` or `/app` directory");
76
92
  }
77
93
 
78
94
  const usesTs = usesTypescript(ctx);
@@ -80,7 +96,7 @@ const configure = async (ctx: C3Context) => {
80
96
  if (usesTs) {
81
97
  copyFile(
82
98
  join(getTemplatePath(ctx), "env.d.ts"),
83
- join(projectPath, "env.d.ts")
99
+ join(projectPath, "env.d.ts"),
84
100
  );
85
101
  updateStatus("Created an env.d.ts file");
86
102
  }
@@ -95,7 +111,7 @@ const configure = async (ctx: C3Context) => {
95
111
 
96
112
  copyFile(
97
113
  join(getTemplatePath(ctx), "README.md"),
98
- join(projectPath, "README.md")
114
+ join(projectPath, "README.md"),
99
115
  );
100
116
  updateStatus("Updated the README file");
101
117
 
@@ -103,20 +119,22 @@ const configure = async (ctx: C3Context) => {
103
119
  };
104
120
 
105
121
  export const shouldInstallNextOnPagesEslintPlugin = async (
106
- ctx: C3Context
122
+ ctx: C3Context,
107
123
  ): Promise<boolean> => {
108
124
  const eslintUsage = usesEslint(ctx);
109
125
 
110
- if (!eslintUsage.used) return false;
126
+ if (!eslintUsage.used) {
127
+ return false;
128
+ }
111
129
 
112
130
  if (eslintUsage.configType !== ".eslintrc.json") {
113
131
  warn(
114
- `Expected .eslintrc.json from Next.js scaffolding but found ${eslintUsage.configType} instead`
132
+ `Expected .eslintrc.json from Next.js scaffolding but found ${eslintUsage.configType} instead`,
115
133
  );
116
134
  return false;
117
135
  }
118
136
 
119
- return await processArgument(ctx.args, "eslint-plugin" as keyof C3Args, {
137
+ return await inputPrompt({
120
138
  type: "confirm",
121
139
  question: "Do you want to use the next-on-pages eslint-plugin?",
122
140
  label: "eslint-plugin",
@@ -156,11 +174,9 @@ const addDevDependencies = async (installEslintPlugin: boolean) => {
156
174
  export default {
157
175
  configVersion: 1,
158
176
  id: "next",
177
+ frameworkCli: "create-next-app",
159
178
  platform: "pages",
160
179
  displayName: "Next",
161
- devScript: "dev",
162
- previewScript: "preview",
163
- deployScript: "deploy",
164
180
  generate,
165
181
  configure,
166
182
  copyFiles: {
@@ -194,7 +210,7 @@ export default {
194
210
  },
195
211
  },
196
212
  },
197
- transformPackageJson: async () => {
213
+ transformPackageJson: async (_, ctx) => {
198
214
  const isNpm = npm === "npm";
199
215
  const isBun = npm === "bun";
200
216
  const isNpmOrBun = isNpm || isBun;
@@ -207,20 +223,16 @@ export default {
207
223
  return {
208
224
  scripts: {
209
225
  "pages:build": `${pmCommand} ${nextOnPagesCommand}`,
210
- preview: `${pagesBuildRunCommand} && wrangler pages dev .vercel/output/static`,
211
- 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
+ }),
212
231
  },
213
232
  };
214
233
  },
215
- testFlags: [
216
- "--typescript",
217
- "--no-install",
218
- "--eslint",
219
- "--tailwind",
220
- "--src-dir",
221
- "--app",
222
- "--import-alias",
223
- "@/*",
224
- ],
234
+ devScript: "dev",
235
+ previewScript: "preview",
236
+ deployScript: "deploy",
225
237
  compatibilityFlags: ["nodejs_compat"],
226
238
  } as TemplateConfig;
@@ -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>"