create-cloudflare 0.0.0-ce6d4bc4 → 0.0.0-cfa7de51
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 +41150 -39597
- package/dist/tsconfig.tsbuildinfo +1 -0
- package/package.json +18 -14
- 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 +12 -11
- package/templates/astro/c3.ts +82 -20
- package/templates/astro/snippets/runtimeDeclaration.ts +5 -0
- package/templates/astro/templates/wrangler.toml +85 -0
- package/templates/common/js/.editorconfig +0 -1
- package/templates/common/js/wrangler.toml +78 -22
- package/templates/common/ts/.editorconfig +0 -1
- package/templates/common/ts/package.json +3 -2
- 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/worker-configuration.d.ts +2 -14
- package/templates/common/ts/wrangler.toml +78 -22
- package/templates/docusaurus/c3.ts +5 -6
- package/templates/gatsby/c3.ts +7 -5
- package/templates/hello-world/js/.editorconfig +0 -1
- package/templates/hello-world/js/package.json +5 -2
- package/templates/hello-world/js/test/index.spec.js +20 -0
- package/templates/hello-world/js/vitest.config.js +11 -0
- package/templates/hello-world/js/wrangler.toml +79 -22
- package/templates/hello-world/ts/.editorconfig +0 -1
- package/templates/hello-world/ts/package.json +7 -3
- package/templates/hello-world/ts/src/index.ts +5 -19
- package/templates/hello-world/ts/test/index.spec.ts +25 -0
- package/templates/hello-world/ts/test/tsconfig.json +8 -0
- package/templates/hello-world/ts/tsconfig.json +3 -2
- package/templates/hello-world/ts/vitest.config.ts +11 -0
- package/templates/hello-world/ts/worker-configuration.d.ts +4 -0
- package/templates/hello-world/ts/wrangler.toml +79 -22
- package/templates/hello-world-durable-object/c3.ts +1 -1
- package/templates/hello-world-durable-object/js/.editorconfig +0 -1
- package/templates/hello-world-durable-object/js/src/index.js +18 -14
- package/templates/hello-world-durable-object/js/wrangler.toml +78 -22
- package/templates/hello-world-durable-object/ts/.editorconfig +0 -1
- package/templates/hello-world-durable-object/ts/package.json +3 -3
- package/templates/hello-world-durable-object/ts/src/index.ts +26 -18
- package/templates/hello-world-durable-object/ts/worker-configuration.d.ts +6 -0
- package/templates/hello-world-durable-object/ts/wrangler.toml +78 -22
- package/templates/hello-world-python/c3.ts +9 -0
- package/templates/hello-world-python/py/__dot__gitignore +68 -0
- package/templates/hello-world-python/py/package.json +13 -0
- package/templates/hello-world-python/py/src/entry.py +4 -0
- package/templates/hello-world-python/py/wrangler.toml +108 -0
- package/templates/hono/c3.ts +54 -1
- package/templates/hono/snippets/appDeclaration.ts +1 -0
- package/templates/hono/snippets/bindingsType.ts +3 -0
- package/templates/hono/templates/worker-configuration.d.ts +4 -0
- package/templates/hono/templates/wrangler.toml +107 -0
- package/templates/next/README.md +29 -18
- package/templates/next/app/js/app/api/hello/route.js +3 -1
- package/templates/next/app/ts/app/api/hello/route.ts +2 -1
- package/templates/next/c3.ts +70 -28
- package/templates/next/env.d.ts +4 -12
- package/templates/next/pages/js/pages/api/hello.js +3 -1
- package/templates/next/pages/ts/pages/api/hello.ts +2 -1
- package/templates/next/wrangler.toml +86 -0
- package/templates/nuxt/c3.ts +54 -20
- package/templates/nuxt/templates/env.d.ts +14 -0
- package/templates/nuxt/templates/worker-configuration.d.ts +4 -0
- package/templates/nuxt/templates/wrangler.toml +60 -25
- package/templates/openapi/ts/package.json +3 -2
- package/templates/openapi/ts/src/index.ts +1 -1
- package/templates/openapi/ts/worker-configuration.d.ts +4 -0
- package/templates/openapi/ts/wrangler.toml +104 -0
- package/templates/pre-existing/c3.ts +7 -7
- package/templates/pre-existing/js/.editorconfig +0 -1
- package/templates/pre-existing/js/wrangler.toml +1 -0
- package/templates/queues/js/.editorconfig +0 -1
- package/templates/queues/js/wrangler.toml +95 -2
- package/templates/queues/ts/.editorconfig +0 -1
- package/templates/queues/ts/package.json +3 -2
- package/templates/queues/ts/src/index.ts +6 -8
- package/templates/queues/ts/worker-configuration.d.ts +5 -0
- package/templates/queues/ts/wrangler.toml +95 -2
- package/templates/qwik/c3.ts +81 -30
- package/templates/qwik/snippets/getPlatformProxy.ts +6 -0
- package/templates/qwik/templates/worker-configuration.d.ts +4 -0
- package/templates/qwik/templates/wrangler.toml +60 -25
- package/templates/react/c3.ts +7 -5
- package/templates/remix/c3.ts +39 -6
- package/templates/remix/templates/worker-configuration.d.ts +4 -0
- package/templates/remix/templates/wrangler.toml +85 -0
- package/templates/scheduled/js/.editorconfig +0 -1
- package/templates/scheduled/js/package.json +2 -2
- package/templates/scheduled/js/src/index.js +8 -1
- package/templates/scheduled/js/wrangler.toml +104 -0
- package/templates/scheduled/ts/.editorconfig +0 -1
- package/templates/scheduled/ts/package.json +4 -3
- package/templates/scheduled/ts/src/index.ts +6 -23
- package/templates/scheduled/ts/worker-configuration.d.ts +4 -0
- package/templates/scheduled/ts/wrangler.toml +104 -0
- package/templates/solid/c3.ts +60 -13
- package/templates/solid/templates/wrangler.toml +84 -0
- package/templates/svelte/c3.ts +83 -30
- package/templates/svelte/js/wrangler.toml +85 -0
- package/templates/svelte/ts/wrangler.toml +85 -0
- package/templates/vue/c3.ts +7 -6
- package/templates/next/next.config.mjs +0 -24
- package/templates/solid/js/vite.config.js +0 -12
- package/templates/solid/ts/vite.config.ts +0 -12
- package/templates/svelte/templates.ts +0 -13
|
@@ -0,0 +1,108 @@
|
|
|
1
|
+
#:schema node_modules/wrangler/config-schema.json
|
|
2
|
+
name = "<TBD>"
|
|
3
|
+
main = "src/entry.py"
|
|
4
|
+
compatibility_flags = ["python_workers"]
|
|
5
|
+
compatibility_date = "<TBD>"
|
|
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
|
+
|
|
14
|
+
# Variable bindings. These are arbitrary, plaintext strings (similar to environment variables)
|
|
15
|
+
# Docs:
|
|
16
|
+
# - https://developers.cloudflare.com/workers/wrangler/configuration/#environment-variables
|
|
17
|
+
# Note: Use secrets to store sensitive data.
|
|
18
|
+
# - https://developers.cloudflare.com/workers/configuration/secrets/
|
|
19
|
+
# [vars]
|
|
20
|
+
# MY_VARIABLE = "production_value"
|
|
21
|
+
|
|
22
|
+
# Bind the Workers AI model catalog. Run machine learning models, powered by serverless GPUs, on Cloudflare’s global network
|
|
23
|
+
# Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#workers-ai
|
|
24
|
+
# [ai]
|
|
25
|
+
# binding = "AI"
|
|
26
|
+
|
|
27
|
+
# Bind an Analytics Engine dataset. Use Analytics Engine to write analytics within your Pages Function.
|
|
28
|
+
# Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#analytics-engine-datasets
|
|
29
|
+
# [[analytics_engine_datasets]]
|
|
30
|
+
# binding = "MY_DATASET"
|
|
31
|
+
|
|
32
|
+
# Bind a headless browser instance running on Cloudflare's global network.
|
|
33
|
+
# Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#browser-rendering
|
|
34
|
+
# [browser]
|
|
35
|
+
# binding = "MY_BROWSER"
|
|
36
|
+
|
|
37
|
+
# Bind a D1 database. D1 is Cloudflare’s native serverless SQL database.
|
|
38
|
+
# Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#d1-databases
|
|
39
|
+
# [[d1_databases]]
|
|
40
|
+
# binding = "MY_DB"
|
|
41
|
+
# database_name = "my-database"
|
|
42
|
+
# database_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
|
|
43
|
+
|
|
44
|
+
# Bind a dispatch namespace. Use Workers for Platforms to deploy serverless functions programmatically on behalf of your customers.
|
|
45
|
+
# Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#dispatch-namespace-bindings-workers-for-platforms
|
|
46
|
+
# [[dispatch_namespaces]]
|
|
47
|
+
# binding = "MY_DISPATCHER"
|
|
48
|
+
# namespace = "my-namespace"
|
|
49
|
+
|
|
50
|
+
# Bind a Durable Object. Durable objects are a scale-to-zero compute primitive based on the actor model.
|
|
51
|
+
# Durable Objects can live for as long as needed. Use these when you need a long-running "server", such as in realtime apps.
|
|
52
|
+
# Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#durable-objects
|
|
53
|
+
# [[durable_objects.bindings]]
|
|
54
|
+
# name = "MY_DURABLE_OBJECT"
|
|
55
|
+
# class_name = "MyDurableObject"
|
|
56
|
+
|
|
57
|
+
# Durable Object migrations.
|
|
58
|
+
# Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#migrations
|
|
59
|
+
# [[migrations]]
|
|
60
|
+
# tag = "v1"
|
|
61
|
+
# new_classes = ["MyDurableObject"]
|
|
62
|
+
|
|
63
|
+
# Bind a Hyperdrive configuration. Use to accelerate access to your existing databases from Cloudflare Workers.
|
|
64
|
+
# Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#hyperdrive
|
|
65
|
+
# [[hyperdrive]]
|
|
66
|
+
# binding = "MY_HYPERDRIVE"
|
|
67
|
+
# id = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
|
|
68
|
+
|
|
69
|
+
# Bind a KV Namespace. Use KV as persistent storage for small key-value pairs.
|
|
70
|
+
# Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#kv-namespaces
|
|
71
|
+
# [[kv_namespaces]]
|
|
72
|
+
# binding = "MY_KV_NAMESPACE"
|
|
73
|
+
# id = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
|
|
74
|
+
|
|
75
|
+
# Bind an mTLS certificate. Use to present a client certificate when communicating with another service.
|
|
76
|
+
# Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#mtls-certificates
|
|
77
|
+
# [[mtls_certificates]]
|
|
78
|
+
# binding = "MY_CERTIFICATE"
|
|
79
|
+
# certificate_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
|
|
80
|
+
|
|
81
|
+
# Bind a Queue producer. Use this binding to schedule an arbitrary task that may be processed later by a Queue consumer.
|
|
82
|
+
# Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#queues
|
|
83
|
+
# [[queues.producers]]
|
|
84
|
+
# binding = "MY_QUEUE"
|
|
85
|
+
# queue = "my-queue"
|
|
86
|
+
|
|
87
|
+
# Bind a Queue consumer. Queue Consumers can retrieve tasks scheduled by Producers to act on them.
|
|
88
|
+
# Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#queues
|
|
89
|
+
# [[queues.consumers]]
|
|
90
|
+
# queue = "my-queue"
|
|
91
|
+
|
|
92
|
+
# Bind an R2 Bucket. Use R2 to store arbitrarily large blobs of data, such as files.
|
|
93
|
+
# Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#r2-buckets
|
|
94
|
+
# [[r2_buckets]]
|
|
95
|
+
# binding = "MY_BUCKET"
|
|
96
|
+
# bucket_name = "my-bucket"
|
|
97
|
+
|
|
98
|
+
# Bind another Worker service. Use this binding to call another Worker without network overhead.
|
|
99
|
+
# Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#service-bindings
|
|
100
|
+
# [[services]]
|
|
101
|
+
# binding = "MY_SERVICE"
|
|
102
|
+
# service = "my-service"
|
|
103
|
+
|
|
104
|
+
# Bind a Vectorize index. Use to store and query vector embeddings for semantic search, classification and other vector search use-cases.
|
|
105
|
+
# Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#vectorize-indexes
|
|
106
|
+
# [[vectorize]]
|
|
107
|
+
# binding = "MY_INDEX"
|
|
108
|
+
# index_name = "my-index"
|
package/templates/hono/c3.ts
CHANGED
|
@@ -1,24 +1,77 @@
|
|
|
1
1
|
import { logRaw } from "@cloudflare/cli";
|
|
2
|
-
import {
|
|
2
|
+
import { brandColor, dim } from "@cloudflare/cli/colors";
|
|
3
|
+
import { spinner } from "@cloudflare/cli/interactive";
|
|
4
|
+
import { runFrameworkGenerator } from "frameworks/index";
|
|
5
|
+
import { loadTemplateSnippets, transformFile } from "helpers/codemod";
|
|
6
|
+
import { detectPackageManager } from "helpers/packageManagers";
|
|
3
7
|
import type { TemplateConfig } from "../../src/templates";
|
|
8
|
+
import type * as recast from "recast";
|
|
4
9
|
import type { C3Context } from "types";
|
|
5
10
|
|
|
6
11
|
const generate = async (ctx: C3Context) => {
|
|
12
|
+
const { name: pm } = detectPackageManager();
|
|
13
|
+
|
|
7
14
|
await runFrameworkGenerator(ctx, [
|
|
8
15
|
ctx.project.name,
|
|
9
16
|
"--template",
|
|
10
17
|
"cloudflare-workers",
|
|
18
|
+
"--install",
|
|
19
|
+
"--pm",
|
|
20
|
+
pm,
|
|
11
21
|
]);
|
|
12
22
|
|
|
13
23
|
logRaw(""); // newline
|
|
14
24
|
};
|
|
15
25
|
|
|
26
|
+
const configure = async (ctx: C3Context) => {
|
|
27
|
+
const indexFile = "src/index.ts";
|
|
28
|
+
|
|
29
|
+
const s = spinner();
|
|
30
|
+
s.start(`Updating \`${indexFile}\``);
|
|
31
|
+
|
|
32
|
+
const snippets = loadTemplateSnippets(ctx);
|
|
33
|
+
|
|
34
|
+
transformFile(indexFile, {
|
|
35
|
+
// Insert the env declaration after the last import (but before the rest of the body)
|
|
36
|
+
visitProgram: function (n) {
|
|
37
|
+
const lastImportIndex = n.node.body.findLastIndex(
|
|
38
|
+
(t) => t.type === "ImportDeclaration",
|
|
39
|
+
);
|
|
40
|
+
const lastImport = n.get("body", lastImportIndex);
|
|
41
|
+
lastImport.insertAfter(...snippets.bindingsTypeTs);
|
|
42
|
+
|
|
43
|
+
return this.traverse(n);
|
|
44
|
+
},
|
|
45
|
+
visitVariableDeclarator(n) {
|
|
46
|
+
if (n.node.id.type === "Identifier" && n.node.id.name === "app") {
|
|
47
|
+
n.node.init = snippets
|
|
48
|
+
.appDeclarationTs[0] as recast.types.namedTypes.NewExpression;
|
|
49
|
+
|
|
50
|
+
return false;
|
|
51
|
+
}
|
|
52
|
+
},
|
|
53
|
+
});
|
|
54
|
+
|
|
55
|
+
s.stop(`${brandColor("updated")} \`${dim(indexFile)}\``);
|
|
56
|
+
};
|
|
57
|
+
|
|
16
58
|
const config: TemplateConfig = {
|
|
17
59
|
configVersion: 1,
|
|
18
60
|
id: "hono",
|
|
19
61
|
displayName: "Hono",
|
|
62
|
+
copyFiles: {
|
|
63
|
+
path: "./templates",
|
|
64
|
+
},
|
|
20
65
|
platform: "workers",
|
|
21
66
|
generate,
|
|
67
|
+
configure,
|
|
68
|
+
transformPackageJson: async () => ({
|
|
69
|
+
scripts: {
|
|
70
|
+
dev: "wrangler dev",
|
|
71
|
+
deploy: "wrangler deploy --minify",
|
|
72
|
+
"cf-typegen": "wrangler types --env-interface CloudflareBindings",
|
|
73
|
+
},
|
|
74
|
+
}),
|
|
22
75
|
devScript: "dev",
|
|
23
76
|
deployScript: "deploy",
|
|
24
77
|
};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
new Hono<{ Bindings: Bindings }>()
|
|
@@ -0,0 +1,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
|
@@ -20,8 +20,8 @@ Open [http://localhost:3000](http://localhost:3000) with your browser to see the
|
|
|
20
20
|
|
|
21
21
|
Besides the `dev` script mentioned above `c3` has added a few extra scripts that allow you to integrate the application with the [Cloudflare Pages](https://pages.cloudflare.com/) environment, these are:
|
|
22
22
|
- `pages:build` to build the application for Pages using the [`@cloudflare/next-on-pages`](https://github.com/cloudflare/next-on-pages) CLI
|
|
23
|
-
- `
|
|
24
|
-
- `
|
|
23
|
+
- `preview` to locally preview your Pages application using the [Wrangler](https://developers.cloudflare.com/workers/wrangler/) CLI
|
|
24
|
+
- `deploy` to deploy your Pages application using the [Wrangler](https://developers.cloudflare.com/workers/wrangler/) CLI
|
|
25
25
|
|
|
26
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))
|
|
27
27
|
|
|
@@ -39,19 +39,30 @@ You can use bindings during development, when previewing locally your applicatio
|
|
|
39
39
|
|
|
40
40
|
#### KV Example
|
|
41
41
|
|
|
42
|
-
`c3` has added for you an example showing how you can use a KV binding
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
```
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
42
|
+
`c3` has added for you an example showing how you can use a KV binding.
|
|
43
|
+
|
|
44
|
+
In order to enable the example:
|
|
45
|
+
- Search for javascript/typescript lines containing the following comment:
|
|
46
|
+
```ts
|
|
47
|
+
// KV Example:
|
|
48
|
+
```
|
|
49
|
+
and uncomment the commented lines below it.
|
|
50
|
+
- Do the same in the `wrangler.toml` file, where
|
|
51
|
+
the comment is:
|
|
52
|
+
```
|
|
53
|
+
# KV Example:
|
|
54
|
+
```
|
|
55
|
+
- If you're using TypeScript run the `cf-typegen` script to update the `env.d.ts` file:
|
|
56
|
+
```bash
|
|
57
|
+
npm run cf-typegen
|
|
58
|
+
# or
|
|
59
|
+
yarn cf-typegen
|
|
60
|
+
# or
|
|
61
|
+
pnpm cf-typegen
|
|
62
|
+
# or
|
|
63
|
+
bun cf-typegen
|
|
64
|
+
```
|
|
65
|
+
|
|
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
|
+
|
|
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,3 +1,5 @@
|
|
|
1
|
+
import { getRequestContext } from '@cloudflare/next-on-pages'
|
|
2
|
+
|
|
1
3
|
export const runtime = 'edge'
|
|
2
4
|
|
|
3
5
|
export async function GET(request) {
|
|
@@ -10,7 +12,7 @@ export async function GET(request) {
|
|
|
10
12
|
// )
|
|
11
13
|
//
|
|
12
14
|
// KV Example:
|
|
13
|
-
// const myKv =
|
|
15
|
+
// const myKv = getRequestContext().env.MY_KV_NAMESPACE
|
|
14
16
|
// await myKv.put('suffix', ' from a KV store!')
|
|
15
17
|
// const suffix = await myKv.get('suffix')
|
|
16
18
|
// responseText += suffix
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import type { NextRequest } from 'next/server'
|
|
2
|
+
import { getRequestContext } from '@cloudflare/next-on-pages'
|
|
2
3
|
|
|
3
4
|
export const runtime = 'edge'
|
|
4
5
|
|
|
@@ -12,7 +13,7 @@ export async function GET(request: NextRequest) {
|
|
|
12
13
|
// )
|
|
13
14
|
//
|
|
14
15
|
// KV Example:
|
|
15
|
-
// const myKv =
|
|
16
|
+
// const myKv = getRequestContext().env.MY_KV_NAMESPACE
|
|
16
17
|
// await myKv.put('suffix', ' from a KV store!')
|
|
17
18
|
// const suffix = await myKv.get('suffix')
|
|
18
19
|
// responseText += suffix
|
package/templates/next/c3.ts
CHANGED
|
@@ -2,17 +2,20 @@ import { join } from "path";
|
|
|
2
2
|
import { crash, updateStatus, warn } from "@cloudflare/cli";
|
|
3
3
|
import { processArgument } from "@cloudflare/cli/args";
|
|
4
4
|
import { brandColor, dim } from "@cloudflare/cli/colors";
|
|
5
|
-
import {
|
|
5
|
+
import { spinner } from "@cloudflare/cli/interactive";
|
|
6
|
+
import { runFrameworkGenerator } from "frameworks/index";
|
|
6
7
|
import {
|
|
7
|
-
compatDateFlag,
|
|
8
8
|
copyFile,
|
|
9
9
|
probePaths,
|
|
10
|
+
readFile,
|
|
10
11
|
readJSON,
|
|
11
12
|
usesEslint,
|
|
12
13
|
usesTypescript,
|
|
14
|
+
writeFile,
|
|
13
15
|
writeJSON,
|
|
14
16
|
} from "helpers/files";
|
|
15
|
-
import { detectPackageManager } from "helpers/
|
|
17
|
+
import { detectPackageManager } from "helpers/packageManagers";
|
|
18
|
+
import { installPackages } from "helpers/packages";
|
|
16
19
|
import { getTemplatePath } from "../../src/templates";
|
|
17
20
|
import type { TemplateConfig } from "../../src/templates";
|
|
18
21
|
import type { C3Args, C3Context } from "types";
|
|
@@ -23,6 +26,53 @@ const generate = async (ctx: C3Context) => {
|
|
|
23
26
|
const projectName = ctx.project.name;
|
|
24
27
|
|
|
25
28
|
await runFrameworkGenerator(ctx, [projectName]);
|
|
29
|
+
|
|
30
|
+
const wranglerToml = readFile(join(getTemplatePath(ctx), "wrangler.toml"));
|
|
31
|
+
|
|
32
|
+
// Note: here we add `# KV Example:` to the toml file for the KV example, we don't actually
|
|
33
|
+
// include the comment in the template wrangler.toml file just so to keep it identical
|
|
34
|
+
// and consistent with that of all the other frameworks
|
|
35
|
+
// (instead of making it a special case which needs extra care)
|
|
36
|
+
const newTomlContent = wranglerToml.replace(
|
|
37
|
+
/#\s+\[\[kv_namespaces\]\]\n#\s+binding\s+=\s+"MY_KV_NAMESPACE"\n#\s+id\s+=\s+"[a-zA-Z0-9]+?"/,
|
|
38
|
+
($1) => `# KV Example:\n${$1}`,
|
|
39
|
+
);
|
|
40
|
+
|
|
41
|
+
if (!/# KV Example/.test(newTomlContent)) {
|
|
42
|
+
// This should never happen to users, it is a check mostly so that
|
|
43
|
+
// if the toml file is changed in a way that breaks the "KV Example" addition
|
|
44
|
+
// the C3 Next.js e2e runs will fail with this
|
|
45
|
+
crash("Failed to properly generate the wrangler.toml file");
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
writeFile(join(ctx.project.path, "wrangler.toml"), newTomlContent);
|
|
49
|
+
|
|
50
|
+
updateStatus("Created wrangler.toml file");
|
|
51
|
+
};
|
|
52
|
+
|
|
53
|
+
const updateNextConfig = () => {
|
|
54
|
+
const s = spinner();
|
|
55
|
+
|
|
56
|
+
const configFile = "next.config.mjs";
|
|
57
|
+
s.start(`Updating \`${configFile}\``);
|
|
58
|
+
|
|
59
|
+
const configContent = readFile(configFile);
|
|
60
|
+
|
|
61
|
+
const updatedConfigFile =
|
|
62
|
+
`import { setupDevPlatform } from '@cloudflare/next-on-pages/next-dev';
|
|
63
|
+
|
|
64
|
+
// Here we use the @cloudflare/next-on-pages next-dev module to allow us to use bindings during local development
|
|
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
|
|
67
|
+
if (process.env.NODE_ENV === 'development') {
|
|
68
|
+
await setupDevPlatform();
|
|
69
|
+
}
|
|
70
|
+
|
|
71
|
+
`.replace(/\n\t*/g, "\n") + configContent;
|
|
72
|
+
|
|
73
|
+
writeFile(configFile, updatedConfigFile);
|
|
74
|
+
|
|
75
|
+
s.stop(`${brandColor(`updated`)} ${dim(`\`${configFile}\``)}`);
|
|
26
76
|
};
|
|
27
77
|
|
|
28
78
|
const configure = async (ctx: C3Context) => {
|
|
@@ -47,7 +97,7 @@ const configure = async (ctx: C3Context) => {
|
|
|
47
97
|
if (usesTs) {
|
|
48
98
|
copyFile(
|
|
49
99
|
join(getTemplatePath(ctx), "env.d.ts"),
|
|
50
|
-
join(projectPath, "env.d.ts")
|
|
100
|
+
join(projectPath, "env.d.ts"),
|
|
51
101
|
);
|
|
52
102
|
updateStatus("Created an env.d.ts file");
|
|
53
103
|
}
|
|
@@ -58,15 +108,11 @@ const configure = async (ctx: C3Context) => {
|
|
|
58
108
|
await writeEslintrc(ctx);
|
|
59
109
|
}
|
|
60
110
|
|
|
61
|
-
|
|
62
|
-
join(getTemplatePath(ctx), "next.config.mjs"),
|
|
63
|
-
join(projectPath, "next.config.mjs")
|
|
64
|
-
);
|
|
65
|
-
updateStatus("Updated the next.config.mjs file");
|
|
111
|
+
updateNextConfig();
|
|
66
112
|
|
|
67
113
|
copyFile(
|
|
68
114
|
join(getTemplatePath(ctx), "README.md"),
|
|
69
|
-
join(projectPath, "README.md")
|
|
115
|
+
join(projectPath, "README.md"),
|
|
70
116
|
);
|
|
71
117
|
updateStatus("Updated the README file");
|
|
72
118
|
|
|
@@ -74,15 +120,17 @@ const configure = async (ctx: C3Context) => {
|
|
|
74
120
|
};
|
|
75
121
|
|
|
76
122
|
export const shouldInstallNextOnPagesEslintPlugin = async (
|
|
77
|
-
ctx: C3Context
|
|
123
|
+
ctx: C3Context,
|
|
78
124
|
): Promise<boolean> => {
|
|
79
125
|
const eslintUsage = usesEslint(ctx);
|
|
80
126
|
|
|
81
|
-
if (!eslintUsage.used)
|
|
127
|
+
if (!eslintUsage.used) {
|
|
128
|
+
return false;
|
|
129
|
+
}
|
|
82
130
|
|
|
83
131
|
if (eslintUsage.configType !== ".eslintrc.json") {
|
|
84
132
|
warn(
|
|
85
|
-
`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`,
|
|
86
134
|
);
|
|
87
135
|
return false;
|
|
88
136
|
}
|
|
@@ -129,8 +177,6 @@ export default {
|
|
|
129
177
|
id: "next",
|
|
130
178
|
platform: "pages",
|
|
131
179
|
displayName: "Next",
|
|
132
|
-
devScript: "dev",
|
|
133
|
-
previewScript: "pages:preview",
|
|
134
180
|
generate,
|
|
135
181
|
configure,
|
|
136
182
|
copyFiles: {
|
|
@@ -164,7 +210,7 @@ export default {
|
|
|
164
210
|
},
|
|
165
211
|
},
|
|
166
212
|
},
|
|
167
|
-
transformPackageJson: async () => {
|
|
213
|
+
transformPackageJson: async (_, ctx) => {
|
|
168
214
|
const isNpm = npm === "npm";
|
|
169
215
|
const isBun = npm === "bun";
|
|
170
216
|
const isNpmOrBun = isNpm || isBun;
|
|
@@ -177,20 +223,16 @@ export default {
|
|
|
177
223
|
return {
|
|
178
224
|
scripts: {
|
|
179
225
|
"pages:build": `${pmCommand} ${nextOnPagesCommand}`,
|
|
180
|
-
|
|
181
|
-
|
|
226
|
+
preview: `${pagesBuildRunCommand} && wrangler pages dev`,
|
|
227
|
+
deploy: `${pagesBuildRunCommand} && wrangler pages deploy`,
|
|
228
|
+
...(usesTypescript(ctx) && {
|
|
229
|
+
"cf-typegen": `wrangler types --env-interface CloudflareEnv env.d.ts`,
|
|
230
|
+
}),
|
|
182
231
|
},
|
|
183
232
|
};
|
|
184
233
|
},
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
"--eslint",
|
|
189
|
-
"--tailwind",
|
|
190
|
-
"--src-dir",
|
|
191
|
-
"--app",
|
|
192
|
-
"--import-alias",
|
|
193
|
-
"@/*",
|
|
194
|
-
],
|
|
234
|
+
devScript: "dev",
|
|
235
|
+
previewScript: "preview",
|
|
236
|
+
deployScript: "deploy",
|
|
195
237
|
compatibilityFlags: ["nodejs_compat"],
|
|
196
238
|
} as TemplateConfig;
|
package/templates/next/env.d.ts
CHANGED
|
@@ -1,13 +1,5 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
interface ProcessEnv {
|
|
4
|
-
// Add here the Cloudflare Bindings you want to have available in your application
|
|
5
|
-
// (for more details on Bindings see: https://developers.cloudflare.com/pages/functions/bindings/)
|
|
6
|
-
//
|
|
7
|
-
// KV Example:
|
|
8
|
-
// MY_KV: KVNamespace
|
|
9
|
-
}
|
|
10
|
-
}
|
|
11
|
-
}
|
|
1
|
+
// Generated by Wrangler
|
|
2
|
+
// by running `wrangler types --env-interface CloudflareEnv env.d.ts`
|
|
12
3
|
|
|
13
|
-
|
|
4
|
+
interface CloudflareEnv {
|
|
5
|
+
}
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
import { getRequestContext } from '@cloudflare/next-on-pages'
|
|
2
|
+
|
|
1
3
|
export const config = {
|
|
2
4
|
runtime: 'edge',
|
|
3
5
|
}
|
|
@@ -12,7 +14,7 @@ export default async function handler(req) {
|
|
|
12
14
|
// )
|
|
13
15
|
//
|
|
14
16
|
// KV Example:
|
|
15
|
-
// const myKv =
|
|
17
|
+
// const myKv = getRequestContext().env.MY_KV_NAMESPACE
|
|
16
18
|
// await myKv.put('suffix', ' from a KV store!')
|
|
17
19
|
// const suffix = await myKv.get('suffix')
|
|
18
20
|
// responseText += suffix
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import type { NextRequest } from 'next/server'
|
|
2
|
+
import { getRequestContext } from '@cloudflare/next-on-pages'
|
|
2
3
|
|
|
3
4
|
export const config = {
|
|
4
5
|
runtime: 'edge',
|
|
@@ -14,7 +15,7 @@ export default async function handler(req: NextRequest) {
|
|
|
14
15
|
// )
|
|
15
16
|
//
|
|
16
17
|
// KV Example:
|
|
17
|
-
// const myKv =
|
|
18
|
+
// const myKv = getRequestContext().env.MY_KV_NAMESPACE
|
|
18
19
|
// await myKv.put('suffix', ' from a KV store!')
|
|
19
20
|
// const suffix = await myKv.get('suffix')
|
|
20
21
|
// responseText += suffix
|