create-cloudflare 0.0.0-bd00dc82 → 0.0.0-bd7d79a2c
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.
- package/dist/cli.js +8493 -8978
- package/dist/tsconfig.tsbuildinfo +1 -0
- package/package.json +22 -23
- package/templates/analog/c3.ts +134 -0
- package/templates/analog/snippets/devBindingsModule.ts +7 -0
- package/templates/analog/templates/env.d.ts +13 -0
- package/templates/analog/templates/src/dev-bindings.ts +18 -0
- package/templates/analog/templates/worker-configuration.d.ts +4 -0
- package/templates/analog/templates/wrangler.toml +85 -0
- package/templates/angular/c3.ts +3 -2
- package/templates/astro/c3.ts +6 -6
- package/templates/astro/templates/wrangler.toml +35 -2
- package/templates/common/c3.ts +3 -0
- package/templates/common/js/package.json +1 -1
- package/templates/common/js/wrangler.toml +11 -1
- package/templates/common/ts/package.json +4 -3
- package/templates/common/ts/src/ab-test.ts +2 -2
- package/templates/common/ts/src/index.ts +5 -2
- package/templates/common/ts/src/proxy.ts +2 -2
- package/templates/common/ts/src/redirect.ts +2 -2
- package/templates/common/ts/tsconfig.json +1 -1
- package/templates/common/ts/worker-configuration.d.ts +2 -14
- package/templates/common/ts/wrangler.toml +11 -1
- package/templates/hello-world/c3.ts +5 -1
- package/templates/hello-world/js/package.json +5 -4
- package/templates/hello-world/js/test/index.spec.js +17 -17
- package/templates/hello-world/js/vitest.config.js +8 -8
- package/templates/hello-world/js/wrangler.toml +11 -1
- package/templates/{hello-world-python → hello-world}/py/package.json +1 -1
- package/templates/hello-world/py/wrangler.toml +108 -0
- package/templates/hello-world/ts/package.json +6 -5
- package/templates/hello-world/ts/src/index.ts +5 -19
- package/templates/hello-world/ts/test/index.spec.ts +17 -17
- package/templates/hello-world/ts/test/tsconfig.json +6 -9
- package/templates/hello-world/ts/tsconfig.json +3 -2
- package/templates/hello-world/ts/vitest.config.mts +11 -0
- package/templates/hello-world/ts/worker-configuration.d.ts +4 -0
- package/templates/hello-world/ts/wrangler.toml +11 -1
- package/templates/hello-world-durable-object/c3.ts +3 -1
- package/templates/hello-world-durable-object/js/package.json +1 -1
- package/templates/hello-world-durable-object/js/src/index.js +18 -14
- package/templates/hello-world-durable-object/js/wrangler.toml +12 -2
- package/templates/hello-world-durable-object/ts/package.json +4 -4
- package/templates/hello-world-durable-object/ts/src/index.ts +26 -18
- package/templates/hello-world-durable-object/ts/tsconfig.json +1 -1
- package/templates/hello-world-durable-object/ts/worker-configuration.d.ts +6 -0
- package/templates/hello-world-durable-object/ts/wrangler.toml +13 -4
- package/templates/hono/c3.ts +43 -0
- package/templates/hono/snippets/appDeclaration.ts +1 -0
- package/templates/hono/templates/worker-configuration.d.ts +4 -0
- package/templates/hono/templates/wrangler.toml +107 -0
- package/templates/next/README.md +6 -6
- package/templates/next/c3.ts +12 -10
- package/templates/next/wrangler.toml +33 -1
- package/templates/nuxt/c3.ts +12 -13
- package/templates/nuxt/templates/worker-configuration.d.ts +1 -1
- package/templates/nuxt/templates/wrangler.toml +35 -2
- package/templates/openapi/c3.ts +1 -0
- package/templates/openapi/ts/README.md +3 -3
- package/templates/openapi/ts/package.json +7 -4
- package/templates/openapi/ts/src/endpoints/taskCreate.ts +26 -16
- package/templates/openapi/ts/src/endpoints/taskDelete.ts +20 -19
- package/templates/openapi/ts/src/endpoints/taskFetch.ts +30 -23
- package/templates/openapi/ts/src/endpoints/taskList.ts +27 -24
- package/templates/openapi/ts/src/index.ts +14 -20
- package/templates/openapi/ts/src/types.ts +9 -8
- package/templates/openapi/ts/worker-configuration.d.ts +4 -0
- package/templates/openapi/ts/wrangler.toml +104 -0
- package/templates/pre-existing/c3.ts +5 -5
- package/templates/pre-existing/js/package.json +1 -1
- package/templates/pre-existing/js/wrangler.toml +1 -0
- package/templates/queues/c3.ts +2 -0
- package/templates/queues/js/package.json +1 -1
- package/templates/queues/js/wrangler.toml +11 -1
- package/templates/queues/ts/package.json +4 -3
- package/templates/queues/ts/src/index.ts +6 -8
- package/templates/queues/ts/tsconfig.json +1 -1
- package/templates/queues/ts/worker-configuration.d.ts +5 -0
- package/templates/queues/ts/wrangler.toml +11 -1
- package/templates/qwik/c3.ts +6 -6
- package/templates/qwik/templates/worker-configuration.d.ts +1 -1
- package/templates/qwik/templates/wrangler.toml +35 -2
- package/templates/remix/c3.ts +3 -3
- package/templates/remix/templates/worker-configuration.d.ts +1 -1
- package/templates/remix/templates/wrangler.toml +35 -2
- package/templates/scheduled/c3.ts +2 -0
- package/templates/scheduled/js/package.json +3 -3
- package/templates/scheduled/js/src/index.js +8 -1
- package/templates/scheduled/js/wrangler.toml +12 -2
- package/templates/scheduled/ts/package.json +5 -4
- package/templates/scheduled/ts/src/index.ts +6 -23
- package/templates/scheduled/ts/tsconfig.json +1 -1
- package/templates/scheduled/ts/worker-configuration.d.ts +4 -0
- package/templates/scheduled/ts/wrangler.toml +12 -2
- package/templates/solid/c3.ts +16 -12
- package/templates/solid/templates/wrangler.toml +84 -0
- package/templates/svelte/c3.ts +9 -9
- package/templates/svelte/js/wrangler.toml +35 -2
- package/templates/svelte/ts/wrangler.toml +35 -2
- package/templates/hello-world/ts/vitest.config.ts +0 -11
- package/templates/hello-world-python/c3.ts +0 -9
- package/templates/hello-world-python/py/wrangler.toml +0 -4
- /package/templates/{hello-world-python → hello-world}/py/__dot__gitignore +0 -0
- /package/templates/{hello-world-python → hello-world}/py/src/entry.py +0 -0
|
@@ -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' */
|
|
@@ -98,5 +98,6 @@
|
|
|
98
98
|
// "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */
|
|
99
99
|
"skipLibCheck": true /* Skip type checking all .d.ts files. */
|
|
100
100
|
},
|
|
101
|
-
"exclude": ["test"]
|
|
101
|
+
"exclude": ["test"],
|
|
102
|
+
"include": ["worker-configuration.d.ts", "src/**/*.ts"]
|
|
102
103
|
}
|
|
@@ -1,11 +1,21 @@
|
|
|
1
|
+
#:schema node_modules/wrangler/config-schema.json
|
|
1
2
|
name = "<TBD>"
|
|
2
3
|
main = "src/index.ts"
|
|
3
4
|
compatibility_date = "<TBD>"
|
|
4
5
|
compatibility_flags = ["nodejs_compat"]
|
|
5
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
|
+
|
|
6
14
|
# Variable bindings. These are arbitrary, plaintext strings (similar to environment variables)
|
|
15
|
+
# Docs:
|
|
16
|
+
# - https://developers.cloudflare.com/workers/wrangler/configuration/#environment-variables
|
|
7
17
|
# Note: Use secrets to store sensitive data.
|
|
8
|
-
#
|
|
18
|
+
# - https://developers.cloudflare.com/workers/configuration/secrets/
|
|
9
19
|
# [vars]
|
|
10
20
|
# MY_VARIABLE = "production_value"
|
|
11
21
|
|
|
@@ -1,7 +1,9 @@
|
|
|
1
1
|
export default {
|
|
2
2
|
configVersion: 1,
|
|
3
3
|
id: "hello-world-durable-object",
|
|
4
|
-
displayName:
|
|
4
|
+
displayName: "Hello World Worker Using Durable Objects",
|
|
5
|
+
description:
|
|
6
|
+
"Get started with a basic stateful app to build projects like real-time chats, collaborative apps, and multiplayer games",
|
|
5
7
|
platform: "workers",
|
|
6
8
|
copyFiles: {
|
|
7
9
|
variants: {
|
|
@@ -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}
|
|
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(
|
|
29
|
+
constructor(ctx, env) {
|
|
30
|
+
super(ctx, env);
|
|
31
|
+
}
|
|
28
32
|
|
|
29
33
|
/**
|
|
30
|
-
* The Durable Object
|
|
31
|
-
*
|
|
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 {
|
|
34
|
-
* @returns {Promise<
|
|
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
|
|
37
|
-
return
|
|
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 `
|
|
60
|
-
//
|
|
61
|
-
let
|
|
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
|
|
67
|
+
return new Response(greeting);
|
|
64
68
|
},
|
|
65
69
|
};
|
|
@@ -1,10 +1,20 @@
|
|
|
1
|
+
#:schema node_modules/wrangler/config-schema.json
|
|
1
2
|
name = "<TBD>"
|
|
2
|
-
main = "src/index.
|
|
3
|
+
main = "src/index.js"
|
|
3
4
|
compatibility_date = "<TBD>"
|
|
4
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
|
+
|
|
5
13
|
# Variable bindings. These are arbitrary, plaintext strings (similar to environment variables)
|
|
14
|
+
# Docs:
|
|
15
|
+
# - https://developers.cloudflare.com/workers/wrangler/configuration/#environment-variables
|
|
6
16
|
# Note: Use secrets to store sensitive data.
|
|
7
|
-
#
|
|
17
|
+
# - https://developers.cloudflare.com/workers/configuration/secrets/
|
|
8
18
|
# [vars]
|
|
9
19
|
# MY_VARIABLE = "production_value"
|
|
10
20
|
|
|
@@ -5,11 +5,11 @@
|
|
|
5
5
|
"scripts": {
|
|
6
6
|
"deploy": "wrangler deploy",
|
|
7
7
|
"dev": "wrangler dev",
|
|
8
|
-
"start": "wrangler dev"
|
|
8
|
+
"start": "wrangler dev",
|
|
9
|
+
"cf-typegen": "wrangler types"
|
|
9
10
|
},
|
|
10
11
|
"devDependencies": {
|
|
11
|
-
"
|
|
12
|
-
"
|
|
13
|
-
"wrangler": "^3.0.0"
|
|
12
|
+
"typescript": "^5.5.2",
|
|
13
|
+
"wrangler": "^3.60.3"
|
|
14
14
|
}
|
|
15
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
|
*
|
|
@@ -5,9 +7,13 @@
|
|
|
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
|
|
|
16
|
+
|
|
11
17
|
/**
|
|
12
18
|
* Associate bindings declared in wrangler.toml with the TypeScript type system
|
|
13
19
|
*/
|
|
@@ -16,7 +22,7 @@ export interface Env {
|
|
|
16
22
|
// MY_KV_NAMESPACE: KVNamespace;
|
|
17
23
|
//
|
|
18
24
|
// Example binding to Durable Object. Learn more at https://developers.cloudflare.com/workers/runtime-apis/durable-objects/
|
|
19
|
-
MY_DURABLE_OBJECT: DurableObjectNamespace
|
|
25
|
+
MY_DURABLE_OBJECT: DurableObjectNamespace<MyDurableObject>;
|
|
20
26
|
//
|
|
21
27
|
// Example binding to R2. Learn more at https://developers.cloudflare.com/workers/runtime-apis/r2/
|
|
22
28
|
// MY_BUCKET: R2Bucket;
|
|
@@ -29,25 +35,27 @@ export interface Env {
|
|
|
29
35
|
}
|
|
30
36
|
|
|
31
37
|
/** A Durable Object's behavior is defined in an exported Javascript class */
|
|
32
|
-
export class MyDurableObject {
|
|
38
|
+
export class MyDurableObject extends DurableObject {
|
|
33
39
|
/**
|
|
34
40
|
* The constructor is invoked once upon creation of the Durable Object, i.e. the first call to
|
|
35
|
-
* `DurableObjectStub::get` for a given identifier
|
|
41
|
+
* `DurableObjectStub::get` for a given identifier (no-op constructors can be omitted)
|
|
36
42
|
*
|
|
37
|
-
* @param
|
|
43
|
+
* @param ctx - The interface for interacting with Durable Object state
|
|
38
44
|
* @param env - The interface to reference bindings declared in wrangler.toml
|
|
39
45
|
*/
|
|
40
|
-
constructor(
|
|
46
|
+
constructor(ctx: DurableObjectState, env: Env) {
|
|
47
|
+
super(ctx, env);
|
|
48
|
+
}
|
|
41
49
|
|
|
42
50
|
/**
|
|
43
|
-
* The Durable Object
|
|
44
|
-
*
|
|
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
|
|
45
53
|
*
|
|
46
|
-
* @param
|
|
47
|
-
* @returns The
|
|
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
|
|
48
56
|
*/
|
|
49
|
-
async
|
|
50
|
-
return
|
|
57
|
+
async sayHello(name: string): Promise<string> {
|
|
58
|
+
return `Hello, ${name}!`;
|
|
51
59
|
}
|
|
52
60
|
}
|
|
53
61
|
|
|
@@ -60,19 +68,19 @@ export default {
|
|
|
60
68
|
* @param ctx - The execution context of the Worker
|
|
61
69
|
* @returns The response to be sent back to the client
|
|
62
70
|
*/
|
|
63
|
-
async fetch(request
|
|
71
|
+
async fetch(request, env, ctx): Promise<Response> {
|
|
64
72
|
// We will create a `DurableObjectId` using the pathname from the Worker request
|
|
65
73
|
// This id refers to a unique instance of our 'MyDurableObject' class above
|
|
66
74
|
let id: DurableObjectId = env.MY_DURABLE_OBJECT.idFromName(new URL(request.url).pathname);
|
|
67
75
|
|
|
68
76
|
// This stub creates a communication channel with the Durable Object instance
|
|
69
77
|
// The Durable Object constructor will be invoked upon the first call for a given id
|
|
70
|
-
let stub
|
|
78
|
+
let stub = env.MY_DURABLE_OBJECT.get(id);
|
|
71
79
|
|
|
72
|
-
// We call `
|
|
73
|
-
//
|
|
74
|
-
let
|
|
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");
|
|
75
83
|
|
|
76
|
-
return
|
|
84
|
+
return new Response(greeting);
|
|
77
85
|
},
|
|
78
|
-
}
|
|
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' */
|
|
@@ -1,10 +1,20 @@
|
|
|
1
|
+
#:schema node_modules/wrangler/config-schema.json
|
|
1
2
|
name = "<TBD>"
|
|
2
3
|
main = "src/index.ts"
|
|
3
4
|
compatibility_date = "<TBD>"
|
|
4
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
|
+
|
|
5
13
|
# Variable bindings. These are arbitrary, plaintext strings (similar to environment variables)
|
|
14
|
+
# Docs:
|
|
15
|
+
# - https://developers.cloudflare.com/workers/wrangler/configuration/#environment-variables
|
|
6
16
|
# Note: Use secrets to store sensitive data.
|
|
7
|
-
#
|
|
17
|
+
# - https://developers.cloudflare.com/workers/configuration/secrets/
|
|
8
18
|
# [vars]
|
|
9
19
|
# MY_VARIABLE = "production_value"
|
|
10
20
|
|
|
@@ -38,13 +48,13 @@ compatibility_date = "<TBD>"
|
|
|
38
48
|
|
|
39
49
|
# Bind a Durable Object. Durable objects are a scale-to-zero compute primitive based on the actor model.
|
|
40
50
|
# Durable Objects can live for as long as needed. Use these when you need a long-running "server", such as in realtime apps.
|
|
41
|
-
# Docs: https://developers.cloudflare.com/workers/
|
|
51
|
+
# Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#durable-objects
|
|
42
52
|
[[durable_objects.bindings]]
|
|
43
53
|
name = "MY_DURABLE_OBJECT"
|
|
44
54
|
class_name = "MyDurableObject"
|
|
45
55
|
|
|
46
56
|
# Durable Object migrations.
|
|
47
|
-
# Docs: https://developers.cloudflare.com/workers/
|
|
57
|
+
# Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#migrations
|
|
48
58
|
[[migrations]]
|
|
49
59
|
tag = "v1"
|
|
50
60
|
new_classes = ["MyDurableObject"]
|
|
@@ -95,4 +105,3 @@ new_classes = ["MyDurableObject"]
|
|
|
95
105
|
# [[vectorize]]
|
|
96
106
|
# binding = "MY_INDEX"
|
|
97
107
|
# index_name = "my-index"
|
|
98
|
-
|
package/templates/hono/c3.ts
CHANGED
|
@@ -1,24 +1,67 @@
|
|
|
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",
|
|
19
51
|
displayName: "Hono",
|
|
52
|
+
copyFiles: {
|
|
53
|
+
path: "./templates",
|
|
54
|
+
},
|
|
20
55
|
platform: "workers",
|
|
21
56
|
generate,
|
|
57
|
+
configure,
|
|
58
|
+
transformPackageJson: async () => ({
|
|
59
|
+
scripts: {
|
|
60
|
+
dev: "wrangler dev",
|
|
61
|
+
deploy: "wrangler deploy --minify",
|
|
62
|
+
"cf-typegen": "wrangler types --env-interface CloudflareBindings",
|
|
63
|
+
},
|
|
64
|
+
}),
|
|
22
65
|
devScript: "dev",
|
|
23
66
|
deployScript: "deploy",
|
|
24
67
|
};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
new Hono<{ Bindings: CloudflareBindings }>()
|
|
@@ -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"
|
package/templates/next/README.md
CHANGED
|
@@ -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/
|
|
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,15 +52,15 @@ In order to enable the example:
|
|
|
52
52
|
```
|
|
53
53
|
# KV Example:
|
|
54
54
|
```
|
|
55
|
-
- If you're using TypeScript run the `
|
|
55
|
+
- If you're using TypeScript run the `cf-typegen` script to update the `env.d.ts` file:
|
|
56
56
|
```bash
|
|
57
|
-
npm run
|
|
57
|
+
npm run cf-typegen
|
|
58
58
|
# or
|
|
59
|
-
yarn
|
|
59
|
+
yarn cf-typegen
|
|
60
60
|
# or
|
|
61
|
-
pnpm
|
|
61
|
+
pnpm cf-typegen
|
|
62
62
|
# or
|
|
63
|
-
bun
|
|
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.
|
package/templates/next/c3.ts
CHANGED
|
@@ -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/
|
|
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)
|
|
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
|
}
|
|
@@ -221,10 +223,10 @@ export default {
|
|
|
221
223
|
return {
|
|
222
224
|
scripts: {
|
|
223
225
|
"pages:build": `${pmCommand} ${nextOnPagesCommand}`,
|
|
224
|
-
preview: `${pagesBuildRunCommand} && wrangler pages dev
|
|
225
|
-
deploy: `${pagesBuildRunCommand} && wrangler pages deploy
|
|
226
|
+
preview: `${pagesBuildRunCommand} && wrangler pages dev`,
|
|
227
|
+
deploy: `${pagesBuildRunCommand} && wrangler pages deploy`,
|
|
226
228
|
...(usesTypescript(ctx) && {
|
|
227
|
-
"
|
|
229
|
+
"cf-typegen": `wrangler types --env-interface CloudflareEnv env.d.ts`,
|
|
228
230
|
}),
|
|
229
231
|
},
|
|
230
232
|
};
|