create-cloudflare 0.0.0-e60a675d → 0.0.0-e61444cb

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 (79) hide show
  1. package/dist/cli.js +1520 -2324
  2. package/dist/tsconfig.tsbuildinfo +1 -0
  3. package/package.json +23 -24
  4. package/templates/analog/c3.ts +4 -4
  5. package/templates/analog/templates/wrangler.toml +7 -0
  6. package/templates/angular/c3.ts +2 -2
  7. package/templates/astro/c3.ts +3 -3
  8. package/templates/astro/templates/wrangler.toml +7 -0
  9. package/templates/common/js/package.json +1 -1
  10. package/templates/common/js/wrangler.toml +7 -0
  11. package/templates/common/ts/package.json +2 -2
  12. package/templates/common/ts/src/ab-test.ts +2 -2
  13. package/templates/common/ts/src/index.ts +2 -2
  14. package/templates/common/ts/src/proxy.ts +2 -2
  15. package/templates/common/ts/src/redirect.ts +2 -2
  16. package/templates/common/ts/tsconfig.json +1 -1
  17. package/templates/common/ts/wrangler.toml +7 -0
  18. package/templates/hello-world/js/package.json +3 -3
  19. package/templates/hello-world/js/vitest.config.js +8 -8
  20. package/templates/hello-world/js/wrangler.toml +7 -0
  21. package/templates/hello-world/ts/package.json +4 -4
  22. package/templates/hello-world/ts/src/index.ts +2 -2
  23. package/templates/hello-world/ts/test/tsconfig.json +6 -9
  24. package/templates/hello-world/ts/tsconfig.json +1 -1
  25. package/templates/hello-world/ts/vitest.config.mts +11 -0
  26. package/templates/hello-world/ts/wrangler.toml +7 -0
  27. package/templates/hello-world-durable-object/c3.ts +1 -1
  28. package/templates/hello-world-durable-object/js/package.json +1 -1
  29. package/templates/hello-world-durable-object/js/src/index.js +18 -14
  30. package/templates/hello-world-durable-object/js/wrangler.toml +8 -1
  31. package/templates/hello-world-durable-object/ts/package.json +2 -3
  32. package/templates/hello-world-durable-object/ts/src/index.ts +42 -17
  33. package/templates/hello-world-durable-object/ts/tsconfig.json +1 -1
  34. package/templates/hello-world-durable-object/ts/wrangler.toml +9 -2
  35. package/templates/hello-world-python/py/package.json +1 -1
  36. package/templates/hello-world-python/py/wrangler.toml +7 -0
  37. package/templates/hono/c3.ts +53 -0
  38. package/templates/hono/snippets/appDeclaration.ts +1 -0
  39. package/templates/hono/snippets/bindingsType.ts +3 -0
  40. package/templates/hono/templates/worker-configuration.d.ts +4 -0
  41. package/templates/hono/templates/wrangler.toml +107 -0
  42. package/templates/next/README.md +1 -1
  43. package/templates/next/c3.ts +9 -7
  44. package/templates/next/wrangler.toml +7 -0
  45. package/templates/nuxt/c3.ts +8 -9
  46. package/templates/nuxt/templates/wrangler.toml +7 -0
  47. package/templates/openapi/ts/README.md +3 -3
  48. package/templates/openapi/ts/package.json +5 -3
  49. package/templates/openapi/ts/src/endpoints/taskCreate.ts +26 -16
  50. package/templates/openapi/ts/src/endpoints/taskDelete.ts +20 -19
  51. package/templates/openapi/ts/src/endpoints/taskFetch.ts +30 -23
  52. package/templates/openapi/ts/src/endpoints/taskList.ts +27 -24
  53. package/templates/openapi/ts/src/index.ts +14 -20
  54. package/templates/openapi/ts/src/types.ts +9 -8
  55. package/templates/openapi/ts/wrangler.toml +7 -0
  56. package/templates/pre-existing/c3.ts +5 -5
  57. package/templates/pre-existing/js/package.json +1 -1
  58. package/templates/queues/js/package.json +1 -1
  59. package/templates/queues/js/wrangler.toml +7 -0
  60. package/templates/queues/ts/package.json +2 -2
  61. package/templates/queues/ts/src/index.ts +3 -3
  62. package/templates/queues/ts/tsconfig.json +1 -1
  63. package/templates/queues/ts/wrangler.toml +7 -0
  64. package/templates/qwik/c3.ts +3 -3
  65. package/templates/qwik/templates/wrangler.toml +7 -0
  66. package/templates/remix/templates/wrangler.toml +7 -0
  67. package/templates/scheduled/js/package.json +3 -3
  68. package/templates/scheduled/js/src/index.js +8 -1
  69. package/templates/scheduled/js/wrangler.toml +7 -0
  70. package/templates/scheduled/ts/package.json +4 -4
  71. package/templates/scheduled/ts/src/index.ts +3 -3
  72. package/templates/scheduled/ts/tsconfig.json +1 -1
  73. package/templates/scheduled/ts/wrangler.toml +7 -0
  74. package/templates/solid/c3.ts +11 -9
  75. package/templates/solid/templates/wrangler.toml +7 -0
  76. package/templates/svelte/c3.ts +6 -6
  77. package/templates/svelte/js/wrangler.toml +7 -0
  78. package/templates/svelte/ts/wrangler.toml +7 -0
  79. package/templates/hello-world/ts/vitest.config.ts +0 -11
@@ -12,7 +12,7 @@
12
12
  */
13
13
 
14
14
  export default {
15
- async fetch(request: Request, env: Env, ctx: ExecutionContext): Promise<Response> {
15
+ async fetch(request, env, ctx): Promise<Response> {
16
16
  return new Response('Hello World!');
17
17
  },
18
- };
18
+ } satisfies ExportedHandler<Env>;
@@ -1,11 +1,8 @@
1
1
  {
2
- "extends": "../tsconfig.json",
3
- "compilerOptions": {
4
- "types": [
5
- "@cloudflare/workers-types/experimental",
6
- "@cloudflare/vitest-pool-workers"
7
- ]
8
- },
9
- "include": ["./**/*.ts", "../src/env.d.ts"],
10
- "exclude": []
2
+ "extends": "../tsconfig.json",
3
+ "compilerOptions": {
4
+ "types": ["@cloudflare/workers-types/experimental", "@cloudflare/vitest-pool-workers"]
5
+ },
6
+ "include": ["./**/*.ts", "../src/env.d.ts"],
7
+ "exclude": []
11
8
  }
@@ -13,7 +13,7 @@
13
13
  /* Language and Environment */
14
14
  "target": "es2021" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
15
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. */,
16
+ "jsx": "react-jsx" /* Specify what JSX code is generated. */,
17
17
  // "experimentalDecorators": true, /* Enable experimental support for TC39 stage 2 draft decorators. */
18
18
  // "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */
19
19
  // "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h' */
@@ -0,0 +1,11 @@
1
+ import { defineWorkersConfig } from '@cloudflare/vitest-pool-workers/config';
2
+
3
+ export default defineWorkersConfig({
4
+ test: {
5
+ poolOptions: {
6
+ workers: {
7
+ wrangler: { configPath: './wrangler.toml' },
8
+ },
9
+ },
10
+ },
11
+ });
@@ -4,6 +4,13 @@ main = "src/index.ts"
4
4
  compatibility_date = "<TBD>"
5
5
  compatibility_flags = ["nodejs_compat"]
6
6
 
7
+ # Automatically place your workloads in an optimal location to minimize latency.
8
+ # If you are running back-end logic in a Worker, 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/workers/configuration/smart-placement/#smart-placement
11
+ # [placement]
12
+ # mode = "smart"
13
+
7
14
  # Variable bindings. These are arbitrary, plaintext strings (similar to environment variables)
8
15
  # Docs:
9
16
  # - https://developers.cloudflare.com/workers/wrangler/configuration/#environment-variables
@@ -1,7 +1,7 @@
1
1
  export default {
2
2
  configVersion: 1,
3
3
  id: "hello-world-durable-object",
4
- displayName: '"Hello World" Durable Object',
4
+ displayName: "Co-ordination / multiplayer API (using Durable Objects)",
5
5
  platform: "workers",
6
6
  copyFiles: {
7
7
  variants: {
@@ -8,6 +8,6 @@
8
8
  "start": "wrangler dev"
9
9
  },
10
10
  "devDependencies": {
11
- "wrangler": "^3.0.0"
11
+ "wrangler": "^3.60.3"
12
12
  }
13
13
  }
@@ -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
  *
@@ -16,25 +18,27 @@
16
18
  */
17
19
 
18
20
  /** A Durable Object's behavior is defined in an exported Javascript class */
19
- export class MyDurableObject {
21
+ export class MyDurableObject extends DurableObject {
20
22
  /**
21
23
  * The constructor is invoked once upon creation of the Durable Object, i.e. the first call to
22
- * `DurableObjectStub::get` for a given identifier
24
+ * `DurableObjectStub::get` for a given identifier (no-op constructors can be omitted)
23
25
  *
24
- * @param {DurableObjectState} state - The interface for interacting with Durable Object state
26
+ * @param {DurableObjectState} ctx - The interface for interacting with Durable Object state
25
27
  * @param {Env} env - The interface to reference bindings declared in wrangler.toml
26
28
  */
27
- constructor(state, env) {}
29
+ constructor(ctx, env) {
30
+ super(ctx, env);
31
+ }
28
32
 
29
33
  /**
30
- * The Durable Object fetch handler will be invoked when a Durable Object instance receives a
31
- * request from a Worker via an associated stub
34
+ * The Durable Object exposes an RPC method sayHello which will be invoked when when a Durable
35
+ * Object instance receives a request from a Worker via the same method invocation on the stub
32
36
  *
33
- * @param {Request} request - The request submitted to a Durable Object instance from a Worker
34
- * @returns {Promise<Response>} The response to be sent back to the Worker
37
+ * @param {string} name - The name provided to a Durable Object instance from a Worker
38
+ * @returns {Promise<string>} The greeting to be sent back to the Worker
35
39
  */
36
- async fetch(request) {
37
- return new Response('Hello World');
40
+ async sayHello(name) {
41
+ return `Hello, ${name}!`;
38
42
  }
39
43
  }
40
44
 
@@ -56,10 +60,10 @@ export default {
56
60
  // The Durable Object constructor will be invoked upon the first call for a given id
57
61
  let stub = env.MY_DURABLE_OBJECT.get(id);
58
62
 
59
- // We call `fetch()` on the stub to send a request to the Durable Object instance
60
- // The Durable Object instance will invoke its fetch handler to handle the request
61
- let response = await stub.fetch(request);
63
+ // We call the `sayHello()` RPC method on the stub to invoke the method on the remote
64
+ // Durable Object instance
65
+ let greeting = await stub.sayHello("world");
62
66
 
63
- return response;
67
+ return new Response(greeting);
64
68
  },
65
69
  };
@@ -1,8 +1,15 @@
1
1
  #:schema node_modules/wrangler/config-schema.json
2
2
  name = "<TBD>"
3
- main = "src/index.ts"
3
+ main = "src/index.js"
4
4
  compatibility_date = "<TBD>"
5
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
+
6
13
  # Variable bindings. These are arbitrary, plaintext strings (similar to environment variables)
7
14
  # Docs:
8
15
  # - https://developers.cloudflare.com/workers/wrangler/configuration/#environment-variables
@@ -9,8 +9,7 @@
9
9
  "cf-typegen": "wrangler types"
10
10
  },
11
11
  "devDependencies": {
12
- "@cloudflare/workers-types": "^4.20231218.0",
13
- "typescript": "^5.0.4",
14
- "wrangler": "^3.0.0"
12
+ "typescript": "^5.5.2",
13
+ "wrangler": "^3.60.3"
15
14
  }
16
15
  }
@@ -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
  *
@@ -11,26 +13,49 @@
11
13
  * Learn more at https://developers.cloudflare.com/durable-objects
12
14
  */
13
15
 
16
+
17
+ /**
18
+ * Associate bindings declared in wrangler.toml with the TypeScript type system
19
+ */
20
+ export interface Env {
21
+ // Example binding to KV. Learn more at https://developers.cloudflare.com/workers/runtime-apis/kv/
22
+ // MY_KV_NAMESPACE: KVNamespace;
23
+ //
24
+ // Example binding to Durable Object. Learn more at https://developers.cloudflare.com/workers/runtime-apis/durable-objects/
25
+ MY_DURABLE_OBJECT: DurableObjectNamespace<MyDurableObject>;
26
+ //
27
+ // Example binding to R2. Learn more at https://developers.cloudflare.com/workers/runtime-apis/r2/
28
+ // MY_BUCKET: R2Bucket;
29
+ //
30
+ // Example binding to a Service. Learn more at https://developers.cloudflare.com/workers/runtime-apis/service-bindings/
31
+ // MY_SERVICE: Fetcher;
32
+ //
33
+ // Example binding to a Queue. Learn more at https://developers.cloudflare.com/queues/javascript-apis/
34
+ // MY_QUEUE: Queue;
35
+ }
36
+
14
37
  /** A Durable Object's behavior is defined in an exported Javascript class */
15
- export class MyDurableObject {
38
+ export class MyDurableObject extends DurableObject {
16
39
  /**
17
40
  * The constructor is invoked once upon creation of the Durable Object, i.e. the first call to
18
- * `DurableObjectStub::get` for a given identifier
41
+ * `DurableObjectStub::get` for a given identifier (no-op constructors can be omitted)
19
42
  *
20
- * @param state - The interface for interacting with Durable Object state
43
+ * @param ctx - The interface for interacting with Durable Object state
21
44
  * @param env - The interface to reference bindings declared in wrangler.toml
22
45
  */
23
- constructor(state: DurableObjectState, env: Env) {}
46
+ constructor(ctx: DurableObjectState, env: Env) {
47
+ super(ctx, env);
48
+ }
24
49
 
25
50
  /**
26
- * The Durable Object fetch handler will be invoked when a Durable Object instance receives a
27
- * request from a Worker via an associated stub
51
+ * The Durable Object exposes an RPC method sayHello which will be invoked when when a Durable
52
+ * Object instance receives a request from a Worker via the same method invocation on the stub
28
53
  *
29
- * @param request - The request submitted to a Durable Object instance from a Worker
30
- * @returns The response to be sent back to the Worker
54
+ * @param name - The name provided to a Durable Object instance from a Worker
55
+ * @returns The greeting to be sent back to the Worker
31
56
  */
32
- async fetch(request: Request): Promise<Response> {
33
- return new Response('Hello World');
57
+ async sayHello(name: string): Promise<string> {
58
+ return `Hello, ${name}!`;
34
59
  }
35
60
  }
36
61
 
@@ -43,19 +68,19 @@ export default {
43
68
  * @param ctx - The execution context of the Worker
44
69
  * @returns The response to be sent back to the client
45
70
  */
46
- async fetch(request: Request, env: Env, ctx: ExecutionContext): Promise<Response> {
71
+ async fetch(request, env, ctx): Promise<Response> {
47
72
  // We will create a `DurableObjectId` using the pathname from the Worker request
48
73
  // This id refers to a unique instance of our 'MyDurableObject' class above
49
74
  let id: DurableObjectId = env.MY_DURABLE_OBJECT.idFromName(new URL(request.url).pathname);
50
75
 
51
76
  // This stub creates a communication channel with the Durable Object instance
52
77
  // The Durable Object constructor will be invoked upon the first call for a given id
53
- let stub: DurableObjectStub = env.MY_DURABLE_OBJECT.get(id);
78
+ let stub = env.MY_DURABLE_OBJECT.get(id);
54
79
 
55
- // We call `fetch()` on the stub to send a request to the Durable Object instance
56
- // The Durable Object instance will invoke its fetch handler to handle the request
57
- let response = await stub.fetch(request);
80
+ // We call the `sayHello()` RPC method on the stub to invoke the method on the remote
81
+ // Durable Object instance
82
+ let greeting = await stub.sayHello("world");
58
83
 
59
- return response;
84
+ return new Response(greeting);
60
85
  },
61
- };
86
+ } satisfies ExportedHandler<Env>;
@@ -13,7 +13,7 @@
13
13
  /* Language and Environment */
14
14
  "target": "es2021" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
15
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. */,
16
+ "jsx": "react-jsx" /* Specify what JSX code is generated. */,
17
17
  // "experimentalDecorators": true, /* Enable experimental support for TC39 stage 2 draft decorators. */
18
18
  // "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */
19
19
  // "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h' */
@@ -3,6 +3,13 @@ name = "<TBD>"
3
3
  main = "src/index.ts"
4
4
  compatibility_date = "<TBD>"
5
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
+
6
13
  # Variable bindings. These are arbitrary, plaintext strings (similar to environment variables)
7
14
  # Docs:
8
15
  # - https://developers.cloudflare.com/workers/wrangler/configuration/#environment-variables
@@ -41,13 +48,13 @@ compatibility_date = "<TBD>"
41
48
 
42
49
  # Bind a Durable Object. Durable objects are a scale-to-zero compute primitive based on the actor model.
43
50
  # Durable Objects can live for as long as needed. Use these when you need a long-running "server", such as in realtime apps.
44
- # Docs: https://developers.cloudflare.com/workers/runtime-apis/durable-objects
51
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#durable-objects
45
52
  [[durable_objects.bindings]]
46
53
  name = "MY_DURABLE_OBJECT"
47
54
  class_name = "MyDurableObject"
48
55
 
49
56
  # Durable Object migrations.
50
- # Docs: https://developers.cloudflare.com/workers/learning/using-durable-objects#configure-durable-object-classes-with-migrations
57
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#migrations
51
58
  [[migrations]]
52
59
  tag = "v1"
53
60
  new_classes = ["MyDurableObject"]
@@ -8,6 +8,6 @@
8
8
  "start": "wrangler dev"
9
9
  },
10
10
  "devDependencies": {
11
- "wrangler": "^3.0.0"
11
+ "wrangler": "^3.60.3"
12
12
  }
13
13
  }
@@ -4,6 +4,13 @@ main = "src/entry.py"
4
4
  compatibility_flags = ["python_workers"]
5
5
  compatibility_date = "<TBD>"
6
6
 
7
+ # Automatically place your workloads in an optimal location to minimize latency.
8
+ # If you are running back-end logic in a Worker, 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/workers/configuration/smart-placement/#smart-placement
11
+ # [placement]
12
+ # mode = "smart"
13
+
7
14
  # Variable bindings. These are arbitrary, plaintext strings (similar to environment variables)
8
15
  # Docs:
9
16
  # - https://developers.cloudflare.com/workers/wrangler/configuration/#environment-variables
@@ -1,24 +1,77 @@
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
+ // 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
 
@@ -35,7 +35,7 @@ const generate = async (ctx: C3Context) => {
35
35
  // (instead of making it a special case which needs extra care)
36
36
  const newTomlContent = wranglerToml.replace(
37
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}`
38
+ ($1) => `# KV Example:\n${$1}`,
39
39
  );
40
40
 
41
41
  if (!/# KV Example/.test(newTomlContent)) {
@@ -63,7 +63,7 @@ const updateNextConfig = () => {
63
63
 
64
64
  // Here we use the @cloudflare/next-on-pages next-dev module to allow us to use bindings during local development
65
65
  // (when running the application with \`next dev\`), for more information see:
66
- // 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
67
67
  if (process.env.NODE_ENV === 'development') {
68
68
  await setupDevPlatform();
69
69
  }
@@ -97,7 +97,7 @@ const configure = async (ctx: C3Context) => {
97
97
  if (usesTs) {
98
98
  copyFile(
99
99
  join(getTemplatePath(ctx), "env.d.ts"),
100
- join(projectPath, "env.d.ts")
100
+ join(projectPath, "env.d.ts"),
101
101
  );
102
102
  updateStatus("Created an env.d.ts file");
103
103
  }
@@ -112,7 +112,7 @@ const configure = async (ctx: C3Context) => {
112
112
 
113
113
  copyFile(
114
114
  join(getTemplatePath(ctx), "README.md"),
115
- join(projectPath, "README.md")
115
+ join(projectPath, "README.md"),
116
116
  );
117
117
  updateStatus("Updated the README file");
118
118
 
@@ -120,15 +120,17 @@ const configure = async (ctx: C3Context) => {
120
120
  };
121
121
 
122
122
  export const shouldInstallNextOnPagesEslintPlugin = async (
123
- ctx: C3Context
123
+ ctx: C3Context,
124
124
  ): Promise<boolean> => {
125
125
  const eslintUsage = usesEslint(ctx);
126
126
 
127
- if (!eslintUsage.used) return false;
127
+ if (!eslintUsage.used) {
128
+ return false;
129
+ }
128
130
 
129
131
  if (eslintUsage.configType !== ".eslintrc.json") {
130
132
  warn(
131
- `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`,
132
134
  );
133
135
  return false;
134
136
  }
@@ -4,6 +4,13 @@ compatibility_date = "<TBD>"
4
4
  compatibility_flags = ["nodejs_compat"]
5
5
  pages_build_output_dir = ".vercel/output/static"
6
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"
13
+
7
14
  # Variable bindings. These are arbitrary, plaintext strings (similar to environment variables)
8
15
  # Docs:
9
16
  # - https://developers.cloudflare.com/pages/functions/bindings/#environment-variables