create-cloudflare 0.0.0-e739b7fe → 0.0.0-e747ddf6a

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 (231) hide show
  1. package/README.md +1 -1
  2. package/dist/cli.js +51664 -51980
  3. package/dist/tsconfig.tsbuildinfo +1 -0
  4. package/package.json +30 -26
  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.json +5 -0
  11. package/templates/angular/c3.ts +28 -14
  12. package/templates/angular/templates/src/server.ts +15 -0
  13. package/templates/angular/templates/tools/copy-files.mjs +8 -2
  14. package/templates/astro/c3.ts +25 -40
  15. package/templates/astro/templates/js/wrangler.json +8 -0
  16. package/templates/astro/templates/ts/src/env.d.ts +5 -0
  17. package/templates/astro/templates/ts/worker-configuration.d.ts +4 -0
  18. package/templates/astro/templates/ts/wrangler.json +8 -0
  19. package/templates/common/c3.ts +3 -0
  20. package/templates/common/js/package.json +1 -1
  21. package/templates/common/js/wrangler.json +8 -0
  22. package/templates/common/ts/package.json +4 -3
  23. package/templates/common/ts/src/ab-test.ts +2 -2
  24. package/templates/common/ts/src/index.ts +5 -2
  25. package/templates/common/ts/src/proxy.ts +2 -2
  26. package/templates/common/ts/src/redirect.ts +2 -2
  27. package/templates/common/ts/tsconfig.json +37 -95
  28. package/templates/common/ts/worker-configuration.d.ts +2 -14
  29. package/templates/common/ts/wrangler.json +8 -0
  30. package/templates/docusaurus/c3.ts +3 -1
  31. package/templates/gatsby/c3.ts +1 -0
  32. package/templates/hello-world/c3.ts +5 -1
  33. package/templates/hello-world/js/package.json +5 -4
  34. package/templates/hello-world/js/test/index.spec.js +17 -17
  35. package/templates/hello-world/js/vitest.config.js +8 -8
  36. package/templates/hello-world/js/wrangler.json +8 -0
  37. package/templates/hello-world/py/__dot__gitignore +68 -0
  38. package/templates/hello-world/py/package.json +13 -0
  39. package/templates/hello-world/py/src/entry.py +4 -0
  40. package/templates/hello-world/py/wrangler.json +9 -0
  41. package/templates/hello-world/ts/package.json +6 -5
  42. package/templates/hello-world/ts/src/index.ts +5 -19
  43. package/templates/hello-world/ts/test/index.spec.ts +17 -17
  44. package/templates/hello-world/ts/test/tsconfig.json +6 -9
  45. package/templates/hello-world/ts/tsconfig.json +38 -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.json +8 -0
  49. package/templates/hello-world-durable-object/c3.ts +3 -1
  50. package/templates/hello-world-durable-object/js/package.json +1 -1
  51. package/templates/hello-world-durable-object/js/src/index.js +18 -14
  52. package/templates/hello-world-durable-object/js/wrangler.json +24 -0
  53. package/templates/hello-world-durable-object/ts/package.json +4 -4
  54. package/templates/hello-world-durable-object/ts/src/index.ts +24 -37
  55. package/templates/hello-world-durable-object/ts/tsconfig.json +36 -95
  56. package/templates/hello-world-durable-object/ts/worker-configuration.d.ts +5 -0
  57. package/templates/hello-world-durable-object/ts/wrangler.json +24 -0
  58. package/templates/hono/c3.ts +44 -0
  59. package/templates/hono/snippets/appDeclaration.ts +1 -0
  60. package/templates/hono/templates/worker-configuration.d.ts +4 -0
  61. package/templates/hono/templates/wrangler.json +8 -0
  62. package/templates/next/README.md +8 -8
  63. package/templates/next/app/js/app/api/hello/route.js +5 -5
  64. package/templates/next/app/ts/app/api/hello/route.ts +5 -6
  65. package/templates/next/c3.ts +40 -22
  66. package/templates/next/pages/js/pages/api/hello.js +1 -1
  67. package/templates/next/pages/ts/pages/api/hello.ts +1 -1
  68. package/templates/next/wrangler.json +8 -0
  69. package/templates/nuxt/c3.ts +14 -14
  70. package/templates/nuxt/templates/worker-configuration.d.ts +1 -1
  71. package/templates/nuxt/templates/wrangler.json +8 -0
  72. package/templates/openapi/c3.ts +1 -0
  73. package/templates/openapi/ts/README.md +3 -3
  74. package/templates/openapi/ts/package.json +7 -4
  75. package/templates/openapi/ts/src/endpoints/taskCreate.ts +26 -16
  76. package/templates/openapi/ts/src/endpoints/taskDelete.ts +20 -19
  77. package/templates/openapi/ts/src/endpoints/taskFetch.ts +30 -23
  78. package/templates/openapi/ts/src/endpoints/taskList.ts +27 -24
  79. package/templates/openapi/ts/src/index.ts +14 -20
  80. package/templates/openapi/ts/src/types.ts +9 -8
  81. package/templates/openapi/ts/worker-configuration.d.ts +4 -0
  82. package/templates/openapi/ts/wrangler.json +8 -0
  83. package/templates/pre-existing/c3.ts +33 -14
  84. package/templates/pre-existing/js/package.json +1 -1
  85. package/templates/pre-existing/js/wrangler.json +5 -0
  86. package/templates/queues/c3.ts +2 -0
  87. package/templates/queues/js/package.json +1 -1
  88. package/templates/queues/js/wrangler.json +21 -0
  89. package/templates/queues/ts/package.json +4 -3
  90. package/templates/queues/ts/src/index.ts +6 -8
  91. package/templates/queues/ts/tsconfig.json +36 -95
  92. package/templates/queues/ts/worker-configuration.d.ts +5 -0
  93. package/templates/queues/ts/wrangler.json +21 -0
  94. package/templates/qwik/c3.ts +10 -9
  95. package/templates/qwik/templates/worker-configuration.d.ts +1 -1
  96. package/templates/qwik/templates/wrangler.json +8 -0
  97. package/templates/react/c3.ts +33 -3
  98. package/templates/remix/c3.ts +5 -4
  99. package/templates/remix/templates/worker-configuration.d.ts +1 -1
  100. package/templates/remix/templates/wrangler.json +5 -0
  101. package/templates/scheduled/c3.ts +2 -0
  102. package/templates/scheduled/js/package.json +3 -3
  103. package/templates/scheduled/js/src/index.js +8 -1
  104. package/templates/scheduled/js/wrangler.json +13 -0
  105. package/templates/scheduled/ts/package.json +5 -4
  106. package/templates/scheduled/ts/src/index.ts +6 -23
  107. package/templates/scheduled/ts/tsconfig.json +36 -95
  108. package/templates/scheduled/ts/worker-configuration.d.ts +4 -0
  109. package/templates/scheduled/ts/wrangler.json +13 -0
  110. package/templates/solid/c3.ts +18 -13
  111. package/templates/solid/templates/wrangler.json +8 -0
  112. package/templates/svelte/c3.ts +43 -15
  113. package/templates/svelte/templates/wrangler.json +5 -0
  114. package/templates/vue/c3.ts +1 -0
  115. package/templates-experimental/angular/c3.ts +112 -0
  116. package/templates-experimental/angular/templates/src/server.ts +15 -0
  117. package/templates-experimental/angular/templates/wrangler.json +12 -0
  118. package/templates-experimental/astro/c3.ts +98 -0
  119. package/templates-experimental/astro/templates/js/public/.assetsignore +4 -0
  120. package/templates-experimental/astro/templates/js/wrangler.json +15 -0
  121. package/templates-experimental/astro/templates/ts/public/.assetsignore +4 -0
  122. package/templates-experimental/astro/templates/ts/src/env.d.ts +5 -0
  123. package/templates-experimental/astro/templates/ts/worker-configuration.d.ts +4 -0
  124. package/templates-experimental/astro/templates/ts/wrangler.json +15 -0
  125. package/templates-experimental/docusaurus/c3.ts +32 -0
  126. package/templates-experimental/docusaurus/templates/wrangler.json +10 -0
  127. package/templates-experimental/gatsby/c3.ts +53 -0
  128. package/templates-experimental/gatsby/templates/wrangler.json +10 -0
  129. package/templates-experimental/hello-world-assets-only/c3.ts +15 -0
  130. package/templates-experimental/hello-world-assets-only/templates/package.json +13 -0
  131. package/templates-experimental/hello-world-assets-only/templates/public/index.html +11 -0
  132. package/templates-experimental/hello-world-assets-only/templates/wrangler.json +10 -0
  133. package/templates-experimental/hello-world-durable-object-with-assets/c3.ts +23 -0
  134. package/templates-experimental/hello-world-durable-object-with-assets/js/.editorconfig +12 -0
  135. package/templates-experimental/hello-world-durable-object-with-assets/js/.prettierrc +6 -0
  136. package/templates-experimental/hello-world-durable-object-with-assets/js/__dot__gitignore +172 -0
  137. package/templates-experimental/hello-world-durable-object-with-assets/js/package.json +13 -0
  138. package/templates-experimental/hello-world-durable-object-with-assets/js/public/index.html +19 -0
  139. package/templates-experimental/hello-world-durable-object-with-assets/js/src/index.js +69 -0
  140. package/templates-experimental/hello-world-durable-object-with-assets/js/wrangler.json +28 -0
  141. package/templates-experimental/hello-world-durable-object-with-assets/ts/.editorconfig +12 -0
  142. package/templates-experimental/hello-world-durable-object-with-assets/ts/.prettierrc +6 -0
  143. package/templates-experimental/hello-world-durable-object-with-assets/ts/__dot__gitignore +172 -0
  144. package/templates-experimental/hello-world-durable-object-with-assets/ts/package.json +15 -0
  145. package/templates-experimental/hello-world-durable-object-with-assets/ts/public/index.html +19 -0
  146. package/templates-experimental/hello-world-durable-object-with-assets/ts/src/index.ts +66 -0
  147. package/templates-experimental/hello-world-durable-object-with-assets/ts/tsconfig.json +42 -0
  148. package/templates-experimental/hello-world-durable-object-with-assets/ts/worker-configuration.d.ts +5 -0
  149. package/templates-experimental/hello-world-durable-object-with-assets/ts/wrangler.json +28 -0
  150. package/templates-experimental/hello-world-with-assets/c3.ts +22 -0
  151. package/templates-experimental/hello-world-with-assets/js/.editorconfig +12 -0
  152. package/templates-experimental/hello-world-with-assets/js/.prettierrc +6 -0
  153. package/templates-experimental/hello-world-with-assets/js/__dot__gitignore +172 -0
  154. package/templates-experimental/hello-world-with-assets/js/package.json +16 -0
  155. package/templates-experimental/hello-world-with-assets/js/public/index.html +31 -0
  156. package/templates-experimental/hello-world-with-assets/js/src/index.js +23 -0
  157. package/templates-experimental/hello-world-with-assets/js/test/index.spec.js +41 -0
  158. package/templates-experimental/hello-world-with-assets/js/vitest.config.js +11 -0
  159. package/templates-experimental/hello-world-with-assets/js/wrangler.json +15 -0
  160. package/templates-experimental/hello-world-with-assets/py/__dot__gitignore +68 -0
  161. package/templates-experimental/hello-world-with-assets/py/package.json +13 -0
  162. package/templates-experimental/hello-world-with-assets/py/public/index.html +31 -0
  163. package/templates-experimental/hello-world-with-assets/py/src/entry.py +9 -0
  164. package/templates-experimental/hello-world-with-assets/py/wrangler.json +15 -0
  165. package/templates-experimental/hello-world-with-assets/ts/.editorconfig +12 -0
  166. package/templates-experimental/hello-world-with-assets/ts/.prettierrc +6 -0
  167. package/templates-experimental/hello-world-with-assets/ts/__dot__gitignore +172 -0
  168. package/templates-experimental/hello-world-with-assets/ts/package.json +18 -0
  169. package/templates-experimental/hello-world-with-assets/ts/public/index.html +31 -0
  170. package/templates-experimental/hello-world-with-assets/ts/src/index.ts +26 -0
  171. package/templates-experimental/hello-world-with-assets/ts/test/index.spec.ts +41 -0
  172. package/templates-experimental/hello-world-with-assets/ts/test/tsconfig.json +8 -0
  173. package/templates-experimental/hello-world-with-assets/ts/tsconfig.json +44 -0
  174. package/templates-experimental/hello-world-with-assets/ts/vitest.config.mts +11 -0
  175. package/templates-experimental/hello-world-with-assets/ts/worker-configuration.d.ts +4 -0
  176. package/templates-experimental/hello-world-with-assets/ts/wrangler.json +15 -0
  177. package/templates-experimental/hono/c3.ts +43 -0
  178. package/templates-experimental/hono/templates/public/index.html +19 -0
  179. package/templates-experimental/hono/templates/src/index.ts +9 -0
  180. package/templates-experimental/hono/templates/worker-configuration.d.ts +4 -0
  181. package/templates-experimental/hono/templates/wrangler.json +9 -0
  182. package/templates-experimental/next/c3.ts +59 -0
  183. package/templates-experimental/next/templates/.dev.vars +2 -0
  184. package/templates-experimental/next/templates/__dot__gitignore +39 -0
  185. package/templates-experimental/next/templates/env.d.ts +5 -0
  186. package/templates-experimental/next/templates/open-next.config.ts +28 -0
  187. package/templates-experimental/next/templates/wrangler.json +13 -0
  188. package/templates-experimental/nuxt/c3.ts +135 -0
  189. package/templates-experimental/nuxt/templates/env.d.ts +14 -0
  190. package/templates-experimental/nuxt/templates/worker-configuration.d.ts +4 -0
  191. package/templates-experimental/nuxt/templates/wrangler.json +12 -0
  192. package/templates-experimental/qwik/c3.ts +153 -0
  193. package/templates-experimental/qwik/snippets/getPlatformProxy.ts +6 -0
  194. package/templates-experimental/qwik/templates/public/.assetsignore +4 -0
  195. package/templates-experimental/qwik/templates/worker-configuration.d.ts +4 -0
  196. package/templates-experimental/qwik/templates/wrangler.json +15 -0
  197. package/templates-experimental/remix/c3.ts +52 -0
  198. package/templates-experimental/remix/templates/public/.assetsignore +0 -0
  199. package/templates-experimental/remix/templates/worker-configuration.d.ts +4 -0
  200. package/templates-experimental/remix/templates/wrangler.toml +11 -0
  201. package/templates-experimental/solid/c3.ts +94 -0
  202. package/templates-experimental/solid/templates/wrangler.json +15 -0
  203. package/templates-experimental/svelte/c3.ts +129 -0
  204. package/templates-experimental/svelte/templates/static/.assetsignore +4 -0
  205. package/templates-experimental/svelte/templates/wrangler.json +12 -0
  206. package/templates-experimental/vue/c3.ts +33 -0
  207. package/templates-experimental/vue/templates/wrangler.json +10 -0
  208. package/templates/angular/templates/server.ts +0 -34
  209. package/templates/angular/templates/tools/alter-polyfills.mjs +0 -27
  210. package/templates/angular/templates/tools/paths.mjs +0 -9
  211. package/templates/astro/snippets/runtimeDeclaration.ts +0 -4
  212. package/templates/astro/templates/wrangler.toml +0 -52
  213. package/templates/common/js/wrangler.toml +0 -97
  214. package/templates/common/ts/wrangler.toml +0 -97
  215. package/templates/hello-world/js/wrangler.toml +0 -98
  216. package/templates/hello-world/ts/vitest.config.ts +0 -11
  217. package/templates/hello-world/ts/wrangler.toml +0 -98
  218. package/templates/hello-world-durable-object/js/wrangler.toml +0 -97
  219. package/templates/hello-world-durable-object/ts/wrangler.toml +0 -98
  220. package/templates/next/wrangler.toml +0 -58
  221. package/templates/nuxt/templates/wrangler.toml +0 -52
  222. package/templates/openapi/ts/wrangler.toml +0 -3
  223. package/templates/pre-existing/js/wrangler.toml +0 -3
  224. package/templates/queues/js/wrangler.toml +0 -102
  225. package/templates/queues/ts/wrangler.toml +0 -102
  226. package/templates/qwik/templates/wrangler.toml +0 -52
  227. package/templates/remix/templates/wrangler.toml +0 -52
  228. package/templates/scheduled/js/wrangler.toml +0 -103
  229. package/templates/scheduled/ts/wrangler.toml +0 -103
  230. package/templates/svelte/js/wrangler.toml +0 -52
  231. package/templates/svelte/ts/wrangler.toml +0 -52
@@ -1,3 +1,5 @@
1
+ import { DurableObject } from "cloudflare:workers";
2
+
1
3
  /**
2
4
  * Welcome to Cloudflare Workers! This is your first Durable Objects application.
3
5
  *
@@ -5,49 +7,34 @@
5
7
  * - Open a browser tab at http://localhost:8787/ to see your Durable Object in action
6
8
  * - Run `npm run deploy` to publish your application
7
9
  *
10
+ * Bind resources to your worker in `wrangler.toml`. After adding bindings, a type definition for the
11
+ * `Env` object can be regenerated with `npm run cf-typegen`.
12
+ *
8
13
  * Learn more at https://developers.cloudflare.com/durable-objects
9
14
  */
10
15
 
11
- /**
12
- * Associate bindings declared in wrangler.toml with the TypeScript type system
13
- */
14
- export interface Env {
15
- // Example binding to KV. Learn more at https://developers.cloudflare.com/workers/runtime-apis/kv/
16
- // MY_KV_NAMESPACE: KVNamespace;
17
- //
18
- // Example binding to Durable Object. Learn more at https://developers.cloudflare.com/workers/runtime-apis/durable-objects/
19
- MY_DURABLE_OBJECT: DurableObjectNamespace;
20
- //
21
- // Example binding to R2. Learn more at https://developers.cloudflare.com/workers/runtime-apis/r2/
22
- // MY_BUCKET: R2Bucket;
23
- //
24
- // Example binding to a Service. Learn more at https://developers.cloudflare.com/workers/runtime-apis/service-bindings/
25
- // MY_SERVICE: Fetcher;
26
- //
27
- // Example binding to a Queue. Learn more at https://developers.cloudflare.com/queues/javascript-apis/
28
- // MY_QUEUE: Queue;
29
- }
30
-
31
16
  /** A Durable Object's behavior is defined in an exported Javascript class */
32
- export class MyDurableObject {
17
+ export class MyDurableObject extends DurableObject {
33
18
  /**
34
19
  * The constructor is invoked once upon creation of the Durable Object, i.e. the first call to
35
- * `DurableObjectStub::get` for a given identifier
20
+ * `DurableObjectStub::get` for a given identifier (no-op constructors can be omitted)
36
21
  *
37
- * @param state - The interface for interacting with Durable Object state
22
+ * @param ctx - The interface for interacting with Durable Object state
38
23
  * @param env - The interface to reference bindings declared in wrangler.toml
39
24
  */
40
- constructor(state: DurableObjectState, env: Env) {}
25
+ constructor(ctx: DurableObjectState, env: Env) {
26
+ super(ctx, env);
27
+ }
41
28
 
42
29
  /**
43
- * The Durable Object fetch handler will be invoked when a Durable Object instance receives a
44
- * request from a Worker via an associated stub
30
+ * The Durable Object exposes an RPC method sayHello which will be invoked when when a Durable
31
+ * Object instance receives a request from a Worker via the same method invocation on the stub
45
32
  *
46
- * @param request - The request submitted to a Durable Object instance from a Worker
47
- * @returns The response to be sent back to the Worker
33
+ * @param name - The name provided to a Durable Object instance from a Worker
34
+ * @returns The greeting to be sent back to the Worker
48
35
  */
49
- async fetch(request: Request): Promise<Response> {
50
- return new Response('Hello World');
36
+ async sayHello(name: string): Promise<string> {
37
+ return `Hello, ${name}!`;
51
38
  }
52
39
  }
53
40
 
@@ -60,19 +47,19 @@ export default {
60
47
  * @param ctx - The execution context of the Worker
61
48
  * @returns The response to be sent back to the client
62
49
  */
63
- async fetch(request: Request, env: Env, ctx: ExecutionContext): Promise<Response> {
50
+ async fetch(request, env, ctx): Promise<Response> {
64
51
  // We will create a `DurableObjectId` using the pathname from the Worker request
65
52
  // This id refers to a unique instance of our 'MyDurableObject' class above
66
53
  let id: DurableObjectId = env.MY_DURABLE_OBJECT.idFromName(new URL(request.url).pathname);
67
54
 
68
55
  // This stub creates a communication channel with the Durable Object instance
69
56
  // The Durable Object constructor will be invoked upon the first call for a given id
70
- let stub: DurableObjectStub = env.MY_DURABLE_OBJECT.get(id);
57
+ let stub = env.MY_DURABLE_OBJECT.get(id);
71
58
 
72
- // We call `fetch()` on the stub to send a request to the Durable Object instance
73
- // The Durable Object instance will invoke its fetch handler to handle the request
74
- let response = await stub.fetch(request);
59
+ // We call the `sayHello()` RPC method on the stub to invoke the method on the remote
60
+ // Durable Object instance
61
+ let greeting = await stub.sayHello("world");
75
62
 
76
- return response;
63
+ return new Response(greeting);
77
64
  },
78
- };
65
+ } satisfies ExportedHandler<Env>;
@@ -2,100 +2,41 @@
2
2
  "compilerOptions": {
3
3
  /* Visit https://aka.ms/tsconfig.json to read more about this file */
4
4
 
5
- /* Projects */
6
- // "incremental": true, /* Enable incremental compilation */
7
- // "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */
8
- // "tsBuildInfoFile": "./", /* Specify the folder for .tsbuildinfo incremental compilation files. */
9
- // "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects */
10
- // "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */
11
- // "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */
12
-
13
- /* Language and Environment */
14
- "target": "es2021" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
15
- "lib": ["es2021"] /* Specify a set of bundled library declaration files that describe the target runtime environment. */,
16
- "jsx": "react" /* Specify what JSX code is generated. */,
17
- // "experimentalDecorators": true, /* Enable experimental support for TC39 stage 2 draft decorators. */
18
- // "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */
19
- // "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h' */
20
- // "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
21
- // "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using `jsx: react-jsx*`.` */
22
- // "reactNamespace": "", /* Specify the object invoked for `createElement`. This only applies when targeting `react` JSX emit. */
23
- // "noLib": true, /* Disable including any library files, including the default lib.d.ts. */
24
- // "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */
25
-
26
- /* Modules */
27
- "module": "es2022" /* Specify what module code is generated. */,
28
- // "rootDir": "./", /* Specify the root folder within your source files. */
29
- "moduleResolution": "node" /* Specify how TypeScript looks up a file from a given module specifier. */,
30
- // "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */
31
- // "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */
32
- // "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */
33
- // "typeRoots": [], /* Specify multiple folders that act like `./node_modules/@types`. */
34
- "types": ["@cloudflare/workers-types"] /* Specify type package names to be included without being referenced in a source file. */,
35
- // "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
36
- "resolveJsonModule": true /* Enable importing .json files */,
37
- // "noResolve": true, /* Disallow `import`s, `require`s or `<reference>`s from expanding the number of files TypeScript should add to a project. */
38
-
39
- /* JavaScript Support */
40
- "allowJs": true /* Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files. */,
41
- "checkJs": false /* Enable error reporting in type-checked JavaScript files. */,
42
- // "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from `node_modules`. Only applicable with `allowJs`. */
43
-
44
- /* Emit */
45
- // "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
46
- // "declarationMap": true, /* Create sourcemaps for d.ts files. */
47
- // "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */
48
- // "sourceMap": true, /* Create source map files for emitted JavaScript files. */
49
- // "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If `declaration` is true, also designates a file that bundles all .d.ts output. */
50
- // "outDir": "./", /* Specify an output folder for all emitted files. */
51
- // "removeComments": true, /* Disable emitting comments. */
52
- "noEmit": true /* Disable emitting files from a compilation. */,
53
- // "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
54
- // "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types */
55
- // "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
56
- // "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */
57
- // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
58
- // "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */
59
- // "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */
60
- // "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
61
- // "newLine": "crlf", /* Set the newline character for emitting files. */
62
- // "stripInternal": true, /* Disable emitting declarations that have `@internal` in their JSDoc comments. */
63
- // "noEmitHelpers": true, /* Disable generating custom helper functions like `__extends` in compiled output. */
64
- // "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */
65
- // "preserveConstEnums": true, /* Disable erasing `const enum` declarations in generated code. */
66
- // "declarationDir": "./", /* Specify the output directory for generated declaration files. */
67
- // "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
68
-
69
- /* Interop Constraints */
70
- "isolatedModules": true /* Ensure that each file can be safely transpiled without relying on other imports. */,
71
- "allowSyntheticDefaultImports": true /* Allow 'import x from y' when a module doesn't have a default export. */,
72
- // "esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility. */,
73
- // "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
74
- "forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,
75
-
76
- /* Type Checking */
77
- "strict": true /* Enable all strict type-checking options. */,
78
- // "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied `any` type.. */
79
- // "strictNullChecks": true, /* When type checking, take into account `null` and `undefined`. */
80
- // "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
81
- // "strictBindCallApply": true, /* Check that the arguments for `bind`, `call`, and `apply` methods match the original function. */
82
- // "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */
83
- // "noImplicitThis": true, /* Enable error reporting when `this` is given the type `any`. */
84
- // "useUnknownInCatchVariables": true, /* Type catch clause variables as 'unknown' instead of 'any'. */
85
- // "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */
86
- // "noUnusedLocals": true, /* Enable error reporting when a local variables aren't read. */
87
- // "noUnusedParameters": true, /* Raise an error when a function parameter isn't read */
88
- // "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */
89
- // "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */
90
- // "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */
91
- // "noUncheckedIndexedAccess": true, /* Include 'undefined' in index signature results */
92
- // "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */
93
- // "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type */
94
- // "allowUnusedLabels": true, /* Disable error reporting for unused labels. */
95
- // "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */
96
-
97
- /* Completeness */
98
- // "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */
99
- "skipLibCheck": true /* Skip type checking all .d.ts files. */
5
+ /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
6
+ "target": "es2021",
7
+ /* Specify a set of bundled library declaration files that describe the target runtime environment. */
8
+ "lib": ["es2021"],
9
+ /* Specify what JSX code is generated. */
10
+ "jsx": "react-jsx",
11
+
12
+ /* Specify what module code is generated. */
13
+ "module": "es2022",
14
+ /* Specify how TypeScript looks up a file from a given module specifier. */
15
+ "moduleResolution": "node",
16
+ /* Specify type package names to be included without being referenced in a source file. */
17
+ "types": ["@cloudflare/workers-types"],
18
+ /* Enable importing .json files */
19
+ "resolveJsonModule": true,
20
+
21
+ /* Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files. */
22
+ "allowJs": true,
23
+ /* Enable error reporting in type-checked JavaScript files. */
24
+ "checkJs": false,
25
+
26
+ /* Disable emitting files from a compilation. */
27
+ "noEmit": true,
28
+
29
+ /* Ensure that each file can be safely transpiled without relying on other imports. */
30
+ "isolatedModules": true,
31
+ /* Allow 'import x from y' when a module doesn't have a default export. */
32
+ "allowSyntheticDefaultImports": true,
33
+ /* Ensure that casing is correct in imports. */
34
+ "forceConsistentCasingInFileNames": true,
35
+
36
+ /* Enable all strict type-checking options. */
37
+ "strict": true,
38
+
39
+ /* Skip type checking all .d.ts files. */
40
+ "skipLibCheck": true
100
41
  }
101
42
  }
@@ -0,0 +1,5 @@
1
+ // Generated by Wrangler by running `wrangler types`
2
+
3
+ interface Env {
4
+ MY_DURABLE_OBJECT: DurableObjectNamespace<import("./src/index").MyDurableObject>;
5
+ }
@@ -0,0 +1,24 @@
1
+ {
2
+ "name": "<TBD>",
3
+ "main": "src/index.ts",
4
+ "compatibility_date": "<TBD>",
5
+ "migrations": [
6
+ {
7
+ "new_classes": [
8
+ "MyDurableObject"
9
+ ],
10
+ "tag": "v1"
11
+ }
12
+ ],
13
+ "durable_objects": {
14
+ "bindings": [
15
+ {
16
+ "class_name": "MyDurableObject",
17
+ "name": "MY_DURABLE_OBJECT"
18
+ }
19
+ ]
20
+ },
21
+ "observability": {
22
+ "enabled": true
23
+ }
24
+ }
@@ -1,24 +1,68 @@
1
1
  import { logRaw } from "@cloudflare/cli";
2
+ import { brandColor, dim } from "@cloudflare/cli/colors";
3
+ import { spinner } from "@cloudflare/cli/interactive";
2
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,8 @@
1
+ {
2
+ "name": "<TBD>",
3
+ "main": "src/index.ts",
4
+ "compatibility_date": "<TBD>",
5
+ "observability": {
6
+ "enabled": true
7
+ }
8
+ }
@@ -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
 
@@ -46,23 +46,23 @@ In order to enable the example:
46
46
  ```ts
47
47
  // KV Example:
48
48
  ```
49
- and uncomment the commented lines below it.
49
+ and uncomment the commented lines below it (also uncomment the relevant imports).
50
50
  - Do the same in the `wrangler.toml` file, where
51
51
  the comment is:
52
52
  ```
53
53
  # KV Example:
54
54
  ```
55
- - If you're using TypeScript run the `build-cf-types` script to update the `env.d.ts` file:
55
+ - If you're using TypeScript run the `cf-typegen` script to update the `env.d.ts` file:
56
56
  ```bash
57
- npm run build-cf-types
57
+ npm run cf-typegen
58
58
  # or
59
- yarn build-cf-types
59
+ yarn cf-typegen
60
60
  # or
61
- pnpm build-cf-types
61
+ pnpm cf-typegen
62
62
  # or
63
- bun build-cf-types
63
+ bun cf-typegen
64
64
  ```
65
65
 
66
66
  After doing this you can run the `dev` or `preview` script and visit the `/api/hello` route to see the example in action.
67
67
 
68
- 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.
@@ -1,9 +1,9 @@
1
- import { getRequestContext } from '@cloudflare/next-on-pages'
1
+ // import { getRequestContext } from '@cloudflare/next-on-pages'
2
2
 
3
3
  export const runtime = 'edge'
4
4
 
5
- export async function GET(request) {
6
- let responseText = 'Hello World'
5
+ export async function GET() {
6
+ const responseText = 'Hello World'
7
7
 
8
8
  // In the edge runtime you can use Bindings that are available in your application
9
9
  // (for more details see:
@@ -12,10 +12,10 @@ 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
- // responseText += suffix
18
+ // return new Response(responseText + suffix)
19
19
 
20
20
  return new Response(responseText)
21
21
  }
@@ -1,10 +1,9 @@
1
- import type { NextRequest } from 'next/server'
2
- import { getRequestContext } from '@cloudflare/next-on-pages'
1
+ // import { getRequestContext } from '@cloudflare/next-on-pages'
3
2
 
4
3
  export const runtime = 'edge'
5
4
 
6
- export async function GET(request: NextRequest) {
7
- let responseText = 'Hello World'
5
+ export async function GET() {
6
+ const responseText = 'Hello World'
8
7
 
9
8
  // In the edge runtime you can use Bindings that are available in your application
10
9
  // (for more details see:
@@ -13,10 +12,10 @@ export async function GET(request: NextRequest) {
13
12
  // )
14
13
  //
15
14
  // KV Example:
16
- // const myKv = getRequestContext().env.MY_KV
15
+ // const myKv = getRequestContext().env.MY_KV_NAMESPACE
17
16
  // await myKv.put('suffix', ' from a KV store!')
18
17
  // const suffix = await myKv.get('suffix')
19
- // responseText += suffix
18
+ // return new Response(responseText + suffix)
20
19
 
21
20
  return new Response(responseText)
22
21
  }
@@ -1,8 +1,7 @@
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";
4
+ import { inputPrompt, spinner } from "@cloudflare/cli/interactive";
6
5
  import { runFrameworkGenerator } from "frameworks/index";
7
6
  import {
8
7
  copyFile,
@@ -18,7 +17,7 @@ import { detectPackageManager } from "helpers/packageManagers";
18
17
  import { installPackages } from "helpers/packages";
19
18
  import { getTemplatePath } from "../../src/templates";
20
19
  import type { TemplateConfig } from "../../src/templates";
21
- import type { C3Args, C3Context } from "types";
20
+ import type { C3Context } from "types";
22
21
 
23
22
  const { npm, npx } = detectPackageManager();
24
23
 
@@ -27,17 +26,33 @@ const generate = async (ctx: C3Context) => {
27
26
 
28
27
  await runFrameworkGenerator(ctx, [projectName]);
29
28
 
30
- copyFile(
31
- join(getTemplatePath(ctx), "wrangler.toml"),
32
- 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}`,
33
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
+
34
49
  updateStatus("Created wrangler.toml file");
35
50
  };
36
51
 
37
- const updateNextConfig = () => {
52
+ const updateNextConfig = (usesTs: boolean) => {
38
53
  const s = spinner();
39
54
 
40
- const configFile = "next.config.mjs";
55
+ const configFile = `next.config.${usesTs ? "ts" : "mjs"}`;
41
56
  s.start(`Updating \`${configFile}\``);
42
57
 
43
58
  const configContent = readFile(configFile);
@@ -47,7 +62,7 @@ const updateNextConfig = () => {
47
62
 
48
63
  // Here we use the @cloudflare/next-on-pages next-dev module to allow us to use bindings during local development
49
64
  // (when running the application with \`next dev\`), for more information see:
50
- // 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
51
66
  if (process.env.NODE_ENV === 'development') {
52
67
  await setupDevPlatform();
53
68
  }
@@ -73,7 +88,7 @@ const configure = async (ctx: C3Context) => {
73
88
  ]);
74
89
 
75
90
  if (!path) {
76
- crash("Could not find the `/api` or `/app` directory");
91
+ throw new Error("Could not find the `/api` or `/app` directory");
77
92
  }
78
93
 
79
94
  const usesTs = usesTypescript(ctx);
@@ -81,7 +96,7 @@ const configure = async (ctx: C3Context) => {
81
96
  if (usesTs) {
82
97
  copyFile(
83
98
  join(getTemplatePath(ctx), "env.d.ts"),
84
- join(projectPath, "env.d.ts")
99
+ join(projectPath, "env.d.ts"),
85
100
  );
86
101
  updateStatus("Created an env.d.ts file");
87
102
  }
@@ -92,11 +107,11 @@ const configure = async (ctx: C3Context) => {
92
107
  await writeEslintrc(ctx);
93
108
  }
94
109
 
95
- updateNextConfig();
110
+ updateNextConfig(usesTs);
96
111
 
97
112
  copyFile(
98
113
  join(getTemplatePath(ctx), "README.md"),
99
- join(projectPath, "README.md")
114
+ join(projectPath, "README.md"),
100
115
  );
101
116
  updateStatus("Updated the README file");
102
117
 
@@ -104,20 +119,22 @@ const configure = async (ctx: C3Context) => {
104
119
  };
105
120
 
106
121
  export const shouldInstallNextOnPagesEslintPlugin = async (
107
- ctx: C3Context
122
+ ctx: C3Context,
108
123
  ): Promise<boolean> => {
109
124
  const eslintUsage = usesEslint(ctx);
110
125
 
111
- if (!eslintUsage.used) return false;
126
+ if (!eslintUsage.used) {
127
+ return false;
128
+ }
112
129
 
113
130
  if (eslintUsage.configType !== ".eslintrc.json") {
114
131
  warn(
115
- `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`,
116
133
  );
117
134
  return false;
118
135
  }
119
136
 
120
- return await processArgument(ctx.args, "eslint-plugin" as keyof C3Args, {
137
+ return await inputPrompt({
121
138
  type: "confirm",
122
139
  question: "Do you want to use the next-on-pages eslint-plugin?",
123
140
  label: "eslint-plugin",
@@ -157,8 +174,9 @@ const addDevDependencies = async (installEslintPlugin: boolean) => {
157
174
  export default {
158
175
  configVersion: 1,
159
176
  id: "next",
177
+ frameworkCli: "create-next-app",
160
178
  platform: "pages",
161
- displayName: "Next",
179
+ displayName: "Next.js",
162
180
  generate,
163
181
  configure,
164
182
  copyFiles: {
@@ -205,10 +223,10 @@ export default {
205
223
  return {
206
224
  scripts: {
207
225
  "pages:build": `${pmCommand} ${nextOnPagesCommand}`,
208
- preview: `${pagesBuildRunCommand} && wrangler pages dev .vercel/output/static`,
209
- deploy: `${pagesBuildRunCommand} && wrangler pages deploy .vercel/output/static`,
226
+ preview: `${pagesBuildRunCommand} && wrangler pages dev`,
227
+ deploy: `${pagesBuildRunCommand} && wrangler pages deploy`,
210
228
  ...(usesTypescript(ctx) && {
211
- "build-cf-types": `wrangler types --env-interface CloudflareEnv env.d.ts`,
229
+ "cf-typegen": `wrangler types --env-interface CloudflareEnv env.d.ts`,
212
230
  }),
213
231
  },
214
232
  };
@@ -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
@@ -0,0 +1,8 @@
1
+ {
2
+ "name": "<TBD>",
3
+ "compatibility_date": "<TBD>",
4
+ "compatibility_flags": [
5
+ "nodejs_compat"
6
+ ],
7
+ "pages_build_output_dir": ".vercel/output/static"
8
+ }