create-cloudflare 0.0.0-bd00dc82 → 0.0.0-bd2031bd

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 (60) hide show
  1. package/dist/cli.js +830 -696
  2. package/package.json +4 -4
  3. package/templates/analog/c3.ts +134 -0
  4. package/templates/analog/snippets/devBindingsModule.ts +7 -0
  5. package/templates/analog/templates/env.d.ts +13 -0
  6. package/templates/analog/templates/src/dev-bindings.ts +18 -0
  7. package/templates/analog/templates/worker-configuration.d.ts +4 -0
  8. package/templates/analog/templates/wrangler.toml +78 -0
  9. package/templates/astro/c3.ts +3 -3
  10. package/templates/astro/templates/wrangler.toml +28 -2
  11. package/templates/common/js/wrangler.toml +4 -1
  12. package/templates/common/ts/package.json +2 -1
  13. package/templates/common/ts/src/index.ts +3 -0
  14. package/templates/common/ts/worker-configuration.d.ts +2 -14
  15. package/templates/common/ts/wrangler.toml +4 -1
  16. package/templates/hello-world/js/package.json +2 -1
  17. package/templates/hello-world/js/test/index.spec.js +17 -17
  18. package/templates/hello-world/js/wrangler.toml +4 -1
  19. package/templates/hello-world/ts/package.json +2 -1
  20. package/templates/hello-world/ts/src/index.ts +3 -17
  21. package/templates/hello-world/ts/test/index.spec.ts +17 -17
  22. package/templates/hello-world/ts/worker-configuration.d.ts +4 -0
  23. package/templates/hello-world/ts/wrangler.toml +4 -1
  24. package/templates/hello-world-durable-object/js/wrangler.toml +4 -1
  25. package/templates/hello-world-durable-object/ts/package.json +2 -1
  26. package/templates/hello-world-durable-object/ts/src/index.ts +3 -20
  27. package/templates/hello-world-durable-object/ts/worker-configuration.d.ts +6 -0
  28. package/templates/hello-world-durable-object/ts/wrangler.toml +4 -2
  29. package/templates/hello-world-python/py/wrangler.toml +97 -0
  30. package/templates/next/README.md +5 -5
  31. package/templates/next/c3.ts +3 -3
  32. package/templates/next/wrangler.toml +26 -1
  33. package/templates/nuxt/c3.ts +4 -4
  34. package/templates/nuxt/templates/worker-configuration.d.ts +1 -1
  35. package/templates/nuxt/templates/wrangler.toml +28 -2
  36. package/templates/openapi/ts/package.json +2 -1
  37. package/templates/openapi/ts/worker-configuration.d.ts +4 -0
  38. package/templates/openapi/ts/wrangler.toml +97 -0
  39. package/templates/pre-existing/js/wrangler.toml +1 -0
  40. package/templates/queues/js/wrangler.toml +4 -1
  41. package/templates/queues/ts/package.json +2 -1
  42. package/templates/queues/ts/src/index.ts +3 -5
  43. package/templates/queues/ts/worker-configuration.d.ts +5 -0
  44. package/templates/queues/ts/wrangler.toml +4 -1
  45. package/templates/qwik/c3.ts +3 -3
  46. package/templates/qwik/templates/worker-configuration.d.ts +1 -1
  47. package/templates/qwik/templates/wrangler.toml +28 -2
  48. package/templates/remix/c3.ts +3 -3
  49. package/templates/remix/templates/worker-configuration.d.ts +1 -1
  50. package/templates/remix/templates/wrangler.toml +28 -2
  51. package/templates/scheduled/js/wrangler.toml +5 -2
  52. package/templates/scheduled/ts/package.json +2 -1
  53. package/templates/scheduled/ts/src/index.ts +3 -20
  54. package/templates/scheduled/ts/worker-configuration.d.ts +4 -0
  55. package/templates/scheduled/ts/wrangler.toml +5 -2
  56. package/templates/solid/c3.ts +5 -3
  57. package/templates/solid/templates/wrangler.toml +77 -0
  58. package/templates/svelte/c3.ts +3 -3
  59. package/templates/svelte/js/wrangler.toml +28 -2
  60. package/templates/svelte/ts/wrangler.toml +28 -2
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "create-cloudflare",
3
- "version": "0.0.0-bd00dc82",
3
+ "version": "0.0.0-bd2031bd",
4
4
  "description": "A CLI for creating and deploying new applications to Cloudflare.",
5
5
  "keywords": [
6
6
  "cloudflare",
@@ -30,7 +30,7 @@
30
30
  "@babel/types": "^7.21.4",
31
31
  "@clack/prompts": "^0.6.3",
32
32
  "@cloudflare/eslint-config-worker": "*",
33
- "@cloudflare/workers-types": "^4.20240320.1",
33
+ "@cloudflare/workers-types": "^4.20240405.0",
34
34
  "@iarna/toml": "^3.0.0",
35
35
  "@types/command-exists": "^1.2.0",
36
36
  "@types/cross-spawn": "^6.0.2",
@@ -69,8 +69,8 @@
69
69
  "yargs": "^17.7.1",
70
70
  "yarn": "^1.22.19",
71
71
  "@cloudflare/cli": "1.1.1",
72
- "@cloudflare/workers-tsconfig": "0.0.0",
73
- "wrangler": "3.44.0"
72
+ "wrangler": "3.51.0",
73
+ "@cloudflare/workers-tsconfig": "0.0.0"
74
74
  },
75
75
  "engines": {
76
76
  "node": ">=18.14.1"
@@ -0,0 +1,134 @@
1
+ import { logRaw } from "@cloudflare/cli";
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 { getLatestTypesEntrypoint } from "helpers/compatDate";
7
+ import { readFile, writeFile } from "helpers/files";
8
+ import { detectPackageManager } from "helpers/packageManagers";
9
+ import { installPackages } from "helpers/packages";
10
+ import * as recast from "recast";
11
+ import type { TemplateConfig } from "../../src/templates";
12
+ import type { C3Context } from "types";
13
+
14
+ const { npm, name: pm } = detectPackageManager();
15
+
16
+ const generate = async (ctx: C3Context) => {
17
+ await runFrameworkGenerator(ctx, [
18
+ ctx.project.name,
19
+ "--template",
20
+ "angular-v17",
21
+ ]);
22
+
23
+ logRaw(""); // newline
24
+ };
25
+
26
+ const configure = async (ctx: C3Context) => {
27
+ // Fix hoisting issues with pnpm, yarn and bun
28
+ if (pm === "pnpm" || pm === "yarn" || pm === "bun") {
29
+ const packages = [];
30
+ packages.push("nitropack");
31
+ packages.push("h3");
32
+ packages.push("@ngtools/webpack");
33
+ packages.push("@angular-devkit/build-angular");
34
+
35
+ await installPackages(packages, {
36
+ dev: true,
37
+ startText: `Installing ${packages.join(", ")}`,
38
+ doneText: `${brandColor("installed")} ${dim(`via \`${npm} install\``)}`,
39
+ });
40
+ }
41
+
42
+ updateViteConfig(ctx);
43
+ updateEnvTypes(ctx);
44
+ };
45
+
46
+ const updateEnvTypes = (ctx: C3Context) => {
47
+ const filepath = "env.d.ts";
48
+
49
+ const s = spinner();
50
+ s.start(`Updating ${filepath}`);
51
+
52
+ let file = readFile(filepath);
53
+
54
+ let typesEntrypoint = `@cloudflare/workers-types`;
55
+ const latestEntrypoint = getLatestTypesEntrypoint(ctx);
56
+ if (latestEntrypoint) {
57
+ typesEntrypoint += `/${latestEntrypoint}`;
58
+ }
59
+
60
+ // Replace placeholder with actual types entrypoint
61
+ file = file.replace("WORKERS_TYPES_ENTRYPOINT", typesEntrypoint);
62
+ writeFile("env.d.ts", file);
63
+
64
+ s.stop(`${brandColor(`updated`)} ${dim(`\`${filepath}\``)}`);
65
+ };
66
+
67
+ const updateViteConfig = (ctx: C3Context) => {
68
+ const b = recast.types.builders;
69
+ const s = spinner();
70
+
71
+ const configFile = "vite.config.ts";
72
+ s.start(`Updating \`${configFile}\``);
73
+
74
+ const snippets = loadTemplateSnippets(ctx);
75
+
76
+ transformFile(configFile, {
77
+ visitProgram(n) {
78
+ const lastImportIndex = n.node.body.findLastIndex(
79
+ (t) => t.type === "ImportDeclaration"
80
+ );
81
+ const lastImport = n.get("body", lastImportIndex);
82
+ lastImport.insertAfter(...snippets.devBindingsModuleTs);
83
+
84
+ return this.traverse(n);
85
+ },
86
+ visitCallExpression(n) {
87
+ const callee = n.node.callee as recast.types.namedTypes.Identifier;
88
+ if (callee.name === "analog") {
89
+ const pluginArguments = b.objectProperty(
90
+ b.identifier("nitro"),
91
+ b.objectExpression([
92
+ b.objectProperty(
93
+ b.identifier("preset"),
94
+ b.stringLiteral("cloudflare-pages")
95
+ ),
96
+ b.objectProperty(
97
+ b.identifier("modules"),
98
+ b.arrayExpression([b.identifier("devBindingsModule")])
99
+ ),
100
+ ])
101
+ );
102
+
103
+ n.node.arguments = [b.objectExpression([pluginArguments])];
104
+ }
105
+
106
+ return this.traverse(n);
107
+ },
108
+ });
109
+
110
+ s.stop(`${brandColor(`updated`)} ${dim(`\`${configFile}\``)}`);
111
+ };
112
+
113
+ const config: TemplateConfig = {
114
+ configVersion: 1,
115
+ id: "analog",
116
+ platform: "pages",
117
+ displayName: "Analog",
118
+ copyFiles: {
119
+ path: "./templates",
120
+ },
121
+ generate,
122
+ configure,
123
+ transformPackageJson: async () => ({
124
+ scripts: {
125
+ preview: `${npm} run build && wrangler pages dev`,
126
+ deploy: `${npm} run build && wrangler pages deploy`,
127
+ "cf-typegen": `wrangler types`,
128
+ },
129
+ }),
130
+ devScript: "dev",
131
+ deployScript: "deploy",
132
+ previewScript: "preview",
133
+ };
134
+ export default config;
@@ -0,0 +1,7 @@
1
+ import { Nitro } from 'nitropack';
2
+
3
+ const devBindingsModule = async (nitro: Nitro) => {
4
+ if (nitro.options.dev) {
5
+ nitro.options.plugins.push('./src/dev-bindings.ts');
6
+ }
7
+ };
@@ -0,0 +1,13 @@
1
+ /// <reference types="WORKERS_TYPES_ENTRYPOINT" />
2
+
3
+ declare module "h3" {
4
+ interface H3EventContext {
5
+ cf: CfProperties;
6
+ cloudflare: {
7
+ env: Env;
8
+ context: ExecutionContext;
9
+ };
10
+ }
11
+ }
12
+
13
+ export {};
@@ -0,0 +1,18 @@
1
+ import { NitroApp } from 'nitropack';
2
+ import { defineNitroPlugin } from 'nitropack/dist/runtime/plugin';
3
+
4
+ export default defineNitroPlugin((nitroApp: NitroApp) => {
5
+ nitroApp.hooks.hook('request', async (event) => {
6
+ const _pkg = 'wrangler'; // Bypass bundling!
7
+ const { getPlatformProxy } = (await import(
8
+ _pkg
9
+ )) as typeof import('wrangler');
10
+ const platform = await getPlatformProxy();
11
+
12
+ event.context.cf = platform['cf'];
13
+ event.context.cloudflare = {
14
+ env: platform['env'] as unknown as Env,
15
+ context: platform['ctx'],
16
+ };
17
+ });
18
+ });
@@ -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 Env {
4
+ }
@@ -0,0 +1,78 @@
1
+ #:schema node_modules/wrangler/config-schema.json
2
+ name = "<TBD>"
3
+ compatibility_date = "<TBD>"
4
+ pages_build_output_dir = "./dist/analog/public"
5
+
6
+ # Variable bindings. These are arbitrary, plaintext strings (similar to environment variables)
7
+ # Note: Use secrets to store sensitive data.
8
+ # Docs:
9
+ # - https://developers.cloudflare.com/pages/functions/bindings/#environment-variables
10
+ # - https://developers.cloudflare.com/pages/functions/bindings/#secrets
11
+ # [vars]
12
+ # MY_VARIABLE = "production_value"
13
+
14
+ # Bind the Workers AI model catalog. Run machine learning models, powered by serverless GPUs, on Cloudflare’s global network
15
+ # Docs: https://developers.cloudflare.com/pages/functions/bindings/#workers-ai
16
+ # [ai]
17
+ # binding = "AI"
18
+
19
+ # Bind a D1 database. D1 is Cloudflare’s native serverless SQL database.
20
+ # Docs: https://developers.cloudflare.com/pages/functions/bindings/#d1-databases
21
+ # [[d1_databases]]
22
+ # binding = "MY_DB"
23
+ # database_name = "my-database"
24
+ # database_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
25
+
26
+ # Bind a Durable Object. Durable objects are a scale-to-zero compute primitive based on the actor model.
27
+ # Durable Objects can live for as long as needed. Use these when you need a long-running "server", such as in realtime apps.
28
+ # Docs: https://developers.cloudflare.com/workers/runtime-apis/durable-objects
29
+ # [[durable_objects.bindings]]
30
+ # name = "MY_DURABLE_OBJECT"
31
+ # class_name = "MyDurableObject"
32
+ # script_name = 'my-durable-object'
33
+
34
+ # Bind a KV Namespace. Use KV as persistent storage for small key-value pairs.
35
+ # Docs: https://developers.cloudflare.com/pages/functions/bindings/#kv-namespaces
36
+ # [[kv_namespaces]]
37
+ # binding = "MY_KV_NAMESPACE"
38
+ # id = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
39
+
40
+ # Bind a Queue producer. Use this binding to schedule an arbitrary task that may be processed later by a Queue consumer.
41
+ # Docs: https://developers.cloudflare.com/pages/functions/bindings/#queue-producers
42
+ # [[queues.producers]]
43
+ # binding = "MY_QUEUE"
44
+ # queue = "my-queue"
45
+
46
+ # Bind an R2 Bucket. Use R2 to store arbitrarily large blobs of data, such as files.
47
+ # Docs: https://developers.cloudflare.com/pages/functions/bindings/#r2-buckets
48
+ # [[r2_buckets]]
49
+ # binding = "MY_BUCKET"
50
+ # bucket_name = "my-bucket"
51
+
52
+ # Bind another Worker service. Use this binding to call another Worker without network overhead.
53
+ # Docs: https://developers.cloudflare.com/pages/functions/bindings/#service-bindings
54
+ # [[services]]
55
+ # binding = "MY_SERVICE"
56
+ # service = "my-service"
57
+
58
+ # To use different bindings for preview and production environments, follow the examples below.
59
+ # When using environment-specific overrides for bindings, ALL bindings must be specified on a per-environment basis.
60
+ # Docs: https://developers.cloudflare.com/pages/functions/wrangler-configuration#environment-specific-overrides
61
+
62
+ ######## PREVIEW environment config ########
63
+
64
+ # [env.preview.vars]
65
+ # API_KEY = "xyz789"
66
+
67
+ # [[env.preview.kv_namespaces]]
68
+ # binding = "MY_KV_NAMESPACE"
69
+ # id = "<PREVIEW_NAMESPACE_ID>"
70
+
71
+ ######## PRODUCTION environment config ########
72
+
73
+ # [env.production.vars]
74
+ # API_KEY = "abc123"
75
+
76
+ # [[env.production.kv_namespaces]]
77
+ # binding = "MY_KV_NAMESPACE"
78
+ # id = "<PRODUCTION_NAMESPACE_ID>"
@@ -103,9 +103,9 @@ const config: TemplateConfig = {
103
103
  configure,
104
104
  transformPackageJson: async (pkgJson: PackageJson, ctx: C3Context) => ({
105
105
  scripts: {
106
- deploy: `astro build && wrangler pages deploy ./dist`,
107
- preview: `astro build && wrangler pages dev ./dist`,
108
- ...(usesTypescript(ctx) && { "build-cf-types": `wrangler types` }),
106
+ deploy: `astro build && wrangler pages deploy`,
107
+ preview: `astro build && wrangler pages dev`,
108
+ ...(usesTypescript(ctx) && { "cf-typegen": `wrangler types` }),
109
109
  },
110
110
  }),
111
111
  };
@@ -1,9 +1,13 @@
1
+ #:schema node_modules/wrangler/config-schema.json
1
2
  name = "<TBD>"
2
3
  compatibility_date = "<TBD>"
4
+ pages_build_output_dir = "./dist"
3
5
 
4
6
  # Variable bindings. These are arbitrary, plaintext strings (similar to environment variables)
7
+ # Docs:
8
+ # - https://developers.cloudflare.com/pages/functions/bindings/#environment-variables
5
9
  # Note: Use secrets to store sensitive data.
6
- # Docs: https://developers.cloudflare.com/pages/functions/bindings/#environment-variables
10
+ # - https://developers.cloudflare.com/pages/functions/bindings/#secrets
7
11
  # [vars]
8
12
  # MY_VARIABLE = "production_value"
9
13
 
@@ -49,4 +53,26 @@ compatibility_date = "<TBD>"
49
53
  # Docs: https://developers.cloudflare.com/pages/functions/bindings/#service-bindings
50
54
  # [[services]]
51
55
  # binding = "MY_SERVICE"
52
- # service = "my-service"
56
+ # service = "my-service"
57
+
58
+ # To use different bindings for preview and production environments, follow the examples below.
59
+ # When using environment-specific overrides for bindings, ALL bindings must be specified on a per-environment basis.
60
+ # Docs: https://developers.cloudflare.com/pages/functions/wrangler-configuration#environment-specific-overrides
61
+
62
+ ######## PREVIEW environment config ########
63
+
64
+ # [env.preview.vars]
65
+ # API_KEY = "xyz789"
66
+
67
+ # [[env.preview.kv_namespaces]]
68
+ # binding = "MY_KV_NAMESPACE"
69
+ # id = "<PREVIEW_NAMESPACE_ID>"
70
+
71
+ ######## PRODUCTION environment config ########
72
+
73
+ # [env.production.vars]
74
+ # API_KEY = "abc123"
75
+
76
+ # [[env.production.kv_namespaces]]
77
+ # binding = "MY_KV_NAMESPACE"
78
+ # id = "<PRODUCTION_NAMESPACE_ID>"
@@ -1,10 +1,13 @@
1
+ #:schema node_modules/wrangler/config-schema.json
1
2
  name = "<TBD>"
2
3
  main = "src/index.js"
3
4
  compatibility_date = "<TBD>"
4
5
 
5
6
  # Variable bindings. These are arbitrary, plaintext strings (similar to environment variables)
7
+ # Docs:
8
+ # - https://developers.cloudflare.com/workers/wrangler/configuration/#environment-variables
6
9
  # Note: Use secrets to store sensitive data.
7
- # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#environment-variables
10
+ # - https://developers.cloudflare.com/workers/configuration/secrets/
8
11
  # [vars]
9
12
  # MY_VARIABLE = "production_value"
10
13
 
@@ -5,7 +5,8 @@
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
  "itty-router": "^3.0.12",
@@ -5,6 +5,9 @@
5
5
  * - Open a browser tab at http://localhost:8787/ to see your worker in action
6
6
  * - Run `npm run deploy` to publish your worker
7
7
  *
8
+ * Bind resources to your worker in `wrangler.toml`. After adding bindings, a type definition for the
9
+ * `Env` object can be regenerated with `npm run cf-typegen`.
10
+ *
8
11
  * Learn more at https://developers.cloudflare.com/workers/
9
12
  */
10
13
 
@@ -1,16 +1,4 @@
1
+ // Generated by Wrangler
2
+ // After adding bindings to `wrangler.toml`, regenerate this interface via `npm run cf-typegen`
1
3
  interface Env {
2
- // Example binding to KV. Learn more at https://developers.cloudflare.com/workers/runtime-apis/kv/
3
- // MY_KV_NAMESPACE: KVNamespace;
4
- //
5
- // Example binding to Durable Object. Learn more at https://developers.cloudflare.com/workers/runtime-apis/durable-objects/
6
- // MY_DURABLE_OBJECT: DurableObjectNamespace;
7
- //
8
- // Example binding to R2. Learn more at https://developers.cloudflare.com/workers/runtime-apis/r2/
9
- // MY_BUCKET: R2Bucket;
10
- //
11
- // Example binding to a Service. Learn more at https://developers.cloudflare.com/workers/runtime-apis/service-bindings/
12
- // MY_SERVICE: Fetcher;
13
- //
14
- // Example binding to a Queue. Learn more at https://developers.cloudflare.com/queues/javascript-apis/
15
- // MY_QUEUE: Queue;
16
4
  }
@@ -1,10 +1,13 @@
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
 
5
6
  # Variable bindings. These are arbitrary, plaintext strings (similar to environment variables)
7
+ # Docs:
8
+ # - https://developers.cloudflare.com/workers/wrangler/configuration/#environment-variables
6
9
  # Note: Use secrets to store sensitive data.
7
- # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#environment-variables
10
+ # - https://developers.cloudflare.com/workers/configuration/secrets/
8
11
  # [vars]
9
12
  # MY_VARIABLE = "production_value"
10
13
 
@@ -5,7 +5,8 @@
5
5
  "scripts": {
6
6
  "deploy": "wrangler deploy",
7
7
  "dev": "wrangler dev",
8
- "start": "wrangler dev"
8
+ "start": "wrangler dev",
9
+ "test": "vitest"
9
10
  },
10
11
  "devDependencies": {
11
12
  "wrangler": "^3.0.0",
@@ -1,20 +1,20 @@
1
- import { env, createExecutionContext, waitOnExecutionContext, SELF } from "cloudflare:test";
2
- import { describe, it, expect } from "vitest";
3
- import worker from "../src";
1
+ import { env, createExecutionContext, waitOnExecutionContext, SELF } from 'cloudflare:test';
2
+ import { describe, it, expect } from 'vitest';
3
+ import worker from '../src';
4
4
 
5
- describe("Hello World worker", () => {
6
- it("responds with Hello World! (unit style)", async () => {
7
- const request = new Request("http://example.com");
8
- // Create an empty context to pass to `worker.fetch()`.
9
- const ctx = createExecutionContext();
10
- const response = await worker.fetch(request, env, ctx);
11
- // Wait for all `Promise`s passed to `ctx.waitUntil()` to settle before running test assertions
12
- await waitOnExecutionContext(ctx);
13
- expect(await response.text()).toMatchInlineSnapshot(`"Hello World!"`);
14
- });
5
+ describe('Hello World worker', () => {
6
+ it('responds with Hello World! (unit style)', async () => {
7
+ const request = new Request('http://example.com');
8
+ // Create an empty context to pass to `worker.fetch()`.
9
+ const ctx = createExecutionContext();
10
+ const response = await worker.fetch(request, env, ctx);
11
+ // Wait for all `Promise`s passed to `ctx.waitUntil()` to settle before running test assertions
12
+ await waitOnExecutionContext(ctx);
13
+ expect(await response.text()).toMatchInlineSnapshot(`"Hello World!"`);
14
+ });
15
15
 
16
- it("responds with Hello World! (integration style)", async () => {
17
- const response = await SELF.fetch(request, env, ctx);
18
- expect(await response.text()).toMatchInlineSnapshot(`"Hello World!"`);
19
- });
16
+ it('responds with Hello World! (integration style)', async () => {
17
+ const response = await SELF.fetch(request, env, ctx);
18
+ expect(await response.text()).toMatchInlineSnapshot(`"Hello World!"`);
19
+ });
20
20
  });
@@ -1,11 +1,14 @@
1
+ #:schema node_modules/wrangler/config-schema.json
1
2
  name = "<TBD>"
2
3
  main = "src/index.js"
3
4
  compatibility_date = "<TBD>"
4
5
  compatibility_flags = ["nodejs_compat"]
5
6
 
6
7
  # Variable bindings. These are arbitrary, plaintext strings (similar to environment variables)
8
+ # Docs:
9
+ # - https://developers.cloudflare.com/workers/wrangler/configuration/#environment-variables
7
10
  # Note: Use secrets to store sensitive data.
8
- # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#environment-variables
11
+ # - https://developers.cloudflare.com/workers/configuration/secrets/
9
12
  # [vars]
10
13
  # MY_VARIABLE = "production_value"
11
14
 
@@ -6,7 +6,8 @@
6
6
  "deploy": "wrangler deploy",
7
7
  "dev": "wrangler dev",
8
8
  "start": "wrangler dev",
9
- "test": "vitest"
9
+ "test": "vitest",
10
+ "cf-typegen": "wrangler types"
10
11
  },
11
12
  "devDependencies": {
12
13
  "typescript": "^5.0.4",
@@ -5,26 +5,12 @@
5
5
  * - Open a browser tab at http://localhost:8787/ to see your worker in action
6
6
  * - Run `npm run deploy` to publish your worker
7
7
  *
8
+ * Bind resources to your worker in `wrangler.toml`. After adding bindings, a type definition for the
9
+ * `Env` object can be regenerated with `npm run cf-typegen`.
10
+ *
8
11
  * Learn more at https://developers.cloudflare.com/workers/
9
12
  */
10
13
 
11
- export interface Env {
12
- // Example binding to KV. Learn more at https://developers.cloudflare.com/workers/runtime-apis/kv/
13
- // MY_KV_NAMESPACE: KVNamespace;
14
- //
15
- // Example binding to Durable Object. Learn more at https://developers.cloudflare.com/workers/runtime-apis/durable-objects/
16
- // MY_DURABLE_OBJECT: DurableObjectNamespace;
17
- //
18
- // Example binding to R2. Learn more at https://developers.cloudflare.com/workers/runtime-apis/r2/
19
- // MY_BUCKET: R2Bucket;
20
- //
21
- // Example binding to a Service. Learn more at https://developers.cloudflare.com/workers/runtime-apis/service-bindings/
22
- // MY_SERVICE: Fetcher;
23
- //
24
- // Example binding to a Queue. Learn more at https://developers.cloudflare.com/queues/javascript-apis/
25
- // MY_QUEUE: Queue;
26
- }
27
-
28
14
  export default {
29
15
  async fetch(request: Request, env: Env, ctx: ExecutionContext): Promise<Response> {
30
16
  return new Response('Hello World!');
@@ -1,25 +1,25 @@
1
1
  // test/index.spec.ts
2
- import { env, createExecutionContext, waitOnExecutionContext, SELF } from "cloudflare:test";
3
- import { describe, it, expect } from "vitest";
4
- import worker from "../src/index";
2
+ import { env, createExecutionContext, waitOnExecutionContext, SELF } from 'cloudflare:test';
3
+ import { describe, it, expect } from 'vitest';
4
+ import worker from '../src/index';
5
5
 
6
6
  // For now, you'll need to do something like this to get a correctly-typed
7
7
  // `Request` to pass to `worker.fetch()`.
8
8
  const IncomingRequest = Request<unknown, IncomingRequestCfProperties>;
9
9
 
10
- describe("Hello World worker", () => {
11
- it("responds with Hello World! (unit style)", async () => {
12
- const request = new IncomingRequest("http://example.com");
13
- // Create an empty context to pass to `worker.fetch()`.
14
- const ctx = createExecutionContext();
15
- const response = await worker.fetch(request, env, ctx);
16
- // Wait for all `Promise`s passed to `ctx.waitUntil()` to settle before running test assertions
17
- await waitOnExecutionContext(ctx);
18
- expect(await response.text()).toMatchInlineSnapshot(`"Hello World!"`);
19
- });
10
+ describe('Hello World worker', () => {
11
+ it('responds with Hello World! (unit style)', async () => {
12
+ const request = new IncomingRequest('http://example.com');
13
+ // Create an empty context to pass to `worker.fetch()`.
14
+ const ctx = createExecutionContext();
15
+ const response = await worker.fetch(request, env, ctx);
16
+ // Wait for all `Promise`s passed to `ctx.waitUntil()` to settle before running test assertions
17
+ await waitOnExecutionContext(ctx);
18
+ expect(await response.text()).toMatchInlineSnapshot(`"Hello World!"`);
19
+ });
20
20
 
21
- it("responds with Hello World! (integration style)", async () => {
22
- const response = await SELF.fetch("https://example.com");
23
- expect(await response.text()).toMatchInlineSnapshot(`"Hello World!"`);
24
- });
21
+ it('responds with Hello World! (integration style)', async () => {
22
+ const response = await SELF.fetch('https://example.com');
23
+ expect(await response.text()).toMatchInlineSnapshot(`"Hello World!"`);
24
+ });
25
25
  });
@@ -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 Env {
4
+ }
@@ -1,11 +1,14 @@
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
 
6
7
  # Variable bindings. These are arbitrary, plaintext strings (similar to environment variables)
8
+ # Docs:
9
+ # - https://developers.cloudflare.com/workers/wrangler/configuration/#environment-variables
7
10
  # Note: Use secrets to store sensitive data.
8
- # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#environment-variables
11
+ # - https://developers.cloudflare.com/workers/configuration/secrets/
9
12
  # [vars]
10
13
  # MY_VARIABLE = "production_value"
11
14
 
@@ -1,10 +1,13 @@
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
 
5
6
  # Variable bindings. These are arbitrary, plaintext strings (similar to environment variables)
7
+ # Docs:
8
+ # - https://developers.cloudflare.com/workers/wrangler/configuration/#environment-variables
6
9
  # Note: Use secrets to store sensitive data.
7
- # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#environment-variables
10
+ # - https://developers.cloudflare.com/workers/configuration/secrets/
8
11
  # [vars]
9
12
  # MY_VARIABLE = "production_value"
10
13
 
@@ -5,7 +5,8 @@
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
  "@cloudflare/workers-types": "^4.20231218.0",
@@ -5,29 +5,12 @@
5
5
  * - Open a browser tab at http://localhost:8787/ to see your Durable Object in action
6
6
  * - Run `npm run deploy` to publish your application
7
7
  *
8
+ * Bind resources to your worker in `wrangler.toml`. After adding bindings, a type definition for the
9
+ * `Env` object can be regenerated with `npm run cf-typegen`.
10
+ *
8
11
  * Learn more at https://developers.cloudflare.com/durable-objects
9
12
  */
10
13
 
11
- /**
12
- * Associate bindings declared in wrangler.toml with the TypeScript type system
13
- */
14
- export interface Env {
15
- // Example binding to KV. Learn more at https://developers.cloudflare.com/workers/runtime-apis/kv/
16
- // MY_KV_NAMESPACE: KVNamespace;
17
- //
18
- // Example binding to Durable Object. Learn more at https://developers.cloudflare.com/workers/runtime-apis/durable-objects/
19
- MY_DURABLE_OBJECT: DurableObjectNamespace;
20
- //
21
- // Example binding to R2. Learn more at https://developers.cloudflare.com/workers/runtime-apis/r2/
22
- // MY_BUCKET: R2Bucket;
23
- //
24
- // Example binding to a Service. Learn more at https://developers.cloudflare.com/workers/runtime-apis/service-bindings/
25
- // MY_SERVICE: Fetcher;
26
- //
27
- // Example binding to a Queue. Learn more at https://developers.cloudflare.com/queues/javascript-apis/
28
- // MY_QUEUE: Queue;
29
- }
30
-
31
14
  /** A Durable Object's behavior is defined in an exported Javascript class */
32
15
  export class MyDurableObject {
33
16
  /**