create-cloudflare 0.0.0-eaea98f7 → 0.0.0-eaf71b86c

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 (238) hide show
  1. package/README.md +2 -53
  2. package/dist/cli.js +70932 -51602
  3. package/dist/tsconfig.tsbuildinfo +1 -0
  4. package/package.json +40 -27
  5. package/templates/analog/c3.ts +135 -0
  6. package/templates/analog/snippets/devBindingsModule.ts +7 -0
  7. package/templates/analog/templates/env.d.ts +13 -0
  8. package/templates/analog/templates/src/dev-bindings.ts +18 -0
  9. package/templates/analog/templates/worker-configuration.d.ts +4 -0
  10. package/templates/analog/templates/wrangler.toml +85 -0
  11. package/templates/angular/c3.ts +102 -0
  12. package/{dist/angular/templates/src/main.server.ts → templates/angular/templates/server.ts} +14 -15
  13. package/templates/angular/templates/tools/alter-polyfills.mjs +27 -0
  14. package/templates/angular/templates/tools/copy-files.mjs +9 -0
  15. package/templates/astro/c3.ts +113 -0
  16. package/templates/astro/snippets/runtimeDeclaration.ts +5 -0
  17. package/templates/astro/templates/wrangler.toml +85 -0
  18. package/templates/common/c3.ts +19 -0
  19. package/templates/common/js/.editorconfig +0 -1
  20. package/templates/common/js/package.json +1 -1
  21. package/templates/common/js/wrangler.toml +84 -22
  22. package/templates/common/ts/.editorconfig +0 -1
  23. package/templates/common/ts/package.json +4 -4
  24. package/templates/common/ts/src/ab-test.ts +2 -2
  25. package/templates/common/ts/src/index.ts +5 -2
  26. package/templates/common/ts/src/proxy.ts +2 -2
  27. package/templates/common/ts/src/redirect.ts +2 -2
  28. package/templates/common/ts/tsconfig.json +1 -1
  29. package/templates/common/ts/worker-configuration.d.ts +2 -14
  30. package/templates/common/ts/wrangler.toml +84 -22
  31. package/templates/docusaurus/c3.ts +28 -0
  32. package/templates/gatsby/c3.ts +49 -0
  33. package/templates/hello-world/c3.ts +20 -0
  34. package/templates/hello-world/js/.editorconfig +0 -1
  35. package/templates/hello-world/js/package.json +5 -2
  36. package/templates/hello-world/js/test/index.spec.js +20 -0
  37. package/templates/hello-world/js/vitest.config.js +11 -0
  38. package/templates/hello-world/js/wrangler.toml +85 -22
  39. package/templates/hello-world/py/__dot__gitignore +68 -0
  40. package/templates/hello-world/py/package.json +13 -0
  41. package/templates/hello-world/py/src/entry.py +4 -0
  42. package/templates/hello-world/py/wrangler.toml +114 -0
  43. package/templates/hello-world/ts/.editorconfig +0 -1
  44. package/templates/hello-world/ts/package.json +7 -4
  45. package/templates/hello-world/ts/src/index.ts +5 -19
  46. package/templates/hello-world/ts/test/index.spec.ts +25 -0
  47. package/templates/hello-world/ts/test/tsconfig.json +8 -0
  48. package/templates/hello-world/ts/tsconfig.json +5 -3
  49. package/templates/hello-world/ts/vitest.config.mts +11 -0
  50. package/templates/hello-world/ts/worker-configuration.d.ts +4 -0
  51. package/templates/hello-world/ts/wrangler.toml +85 -22
  52. package/templates/hello-world-durable-object/c3.ts +18 -0
  53. package/templates/hello-world-durable-object/js/.editorconfig +12 -0
  54. package/templates/hello-world-durable-object/js/.prettierrc +6 -0
  55. package/templates/hello-world-durable-object/js/__dot__gitignore +172 -0
  56. package/templates/hello-world-durable-object/js/package.json +13 -0
  57. package/templates/hello-world-durable-object/js/src/index.js +69 -0
  58. package/templates/hello-world-durable-object/js/wrangler.toml +113 -0
  59. package/templates/hello-world-durable-object/ts/.editorconfig +12 -0
  60. package/templates/hello-world-durable-object/ts/.prettierrc +6 -0
  61. package/templates/hello-world-durable-object/ts/__dot__gitignore +172 -0
  62. package/templates/hello-world-durable-object/ts/package.json +15 -0
  63. package/templates/hello-world-durable-object/ts/src/index.ts +65 -0
  64. package/templates/hello-world-durable-object/ts/tsconfig.json +101 -0
  65. package/templates/hello-world-durable-object/ts/worker-configuration.d.ts +5 -0
  66. package/templates/hello-world-durable-object/ts/wrangler.toml +113 -0
  67. package/templates/hono/c3.ts +69 -0
  68. package/templates/hono/snippets/appDeclaration.ts +1 -0
  69. package/templates/hono/templates/worker-configuration.d.ts +4 -0
  70. package/templates/hono/templates/wrangler.toml +113 -0
  71. package/templates/next/README.md +68 -0
  72. package/templates/next/app/js/app/api/hello/route.js +21 -0
  73. package/templates/next/app/js/app/not-found.js +58 -0
  74. package/templates/next/app/ts/app/api/hello/route.ts +22 -0
  75. package/templates/next/app/ts/app/not-found.tsx +58 -0
  76. package/templates/next/c3.ts +238 -0
  77. package/templates/next/env.d.ts +5 -0
  78. package/templates/next/pages/js/pages/api/hello.js +23 -0
  79. package/templates/next/pages/ts/pages/api/hello.ts +24 -0
  80. package/templates/next/wrangler.toml +86 -0
  81. package/templates/nuxt/c3.ts +134 -0
  82. package/templates/nuxt/templates/env.d.ts +14 -0
  83. package/templates/nuxt/templates/worker-configuration.d.ts +4 -0
  84. package/templates/nuxt/templates/wrangler.toml +86 -0
  85. package/templates/openapi/c3.ts +10 -0
  86. package/templates/openapi/ts/README.md +3 -3
  87. package/templates/openapi/ts/package.json +7 -5
  88. package/templates/openapi/ts/src/endpoints/taskCreate.ts +26 -16
  89. package/templates/openapi/ts/src/endpoints/taskDelete.ts +20 -19
  90. package/templates/openapi/ts/src/endpoints/taskFetch.ts +30 -23
  91. package/templates/openapi/ts/src/endpoints/taskList.ts +27 -24
  92. package/templates/openapi/ts/src/index.ts +16 -22
  93. package/templates/openapi/ts/src/types.ts +9 -8
  94. package/templates/openapi/ts/worker-configuration.d.ts +4 -0
  95. package/templates/openapi/ts/wrangler.toml +110 -0
  96. package/templates/pre-existing/c3.ts +83 -0
  97. package/templates/pre-existing/js/.editorconfig +12 -0
  98. package/templates/pre-existing/js/.prettierrc +6 -0
  99. package/templates/pre-existing/js/__dot__gitignore +172 -0
  100. package/templates/pre-existing/js/package.json +13 -0
  101. package/templates/pre-existing/js/wrangler.toml +4 -0
  102. package/templates/queues/c3.ts +28 -0
  103. package/templates/queues/js/.editorconfig +0 -1
  104. package/templates/queues/js/package.json +1 -1
  105. package/templates/queues/js/wrangler.toml +101 -2
  106. package/templates/queues/ts/.editorconfig +0 -1
  107. package/templates/queues/ts/package.json +4 -4
  108. package/templates/queues/ts/src/index.ts +6 -8
  109. package/templates/queues/ts/tsconfig.json +1 -1
  110. package/templates/queues/ts/worker-configuration.d.ts +5 -0
  111. package/templates/queues/ts/wrangler.toml +101 -2
  112. package/templates/qwik/c3.ts +147 -0
  113. package/templates/qwik/snippets/getPlatformProxy.ts +6 -0
  114. package/templates/qwik/templates/worker-configuration.d.ts +4 -0
  115. package/templates/qwik/templates/wrangler.toml +86 -0
  116. package/templates/react/c3.ts +61 -0
  117. package/templates/remix/c3.ts +67 -0
  118. package/templates/remix/templates/worker-configuration.d.ts +4 -0
  119. package/templates/remix/templates/wrangler.toml +85 -0
  120. package/templates/scheduled/c3.ts +18 -0
  121. package/templates/scheduled/js/.editorconfig +0 -1
  122. package/templates/scheduled/js/package.json +3 -3
  123. package/templates/scheduled/js/src/index.js +8 -1
  124. package/templates/scheduled/js/wrangler.toml +110 -0
  125. package/templates/scheduled/ts/.editorconfig +0 -1
  126. package/templates/scheduled/ts/package.json +5 -5
  127. package/templates/scheduled/ts/src/index.ts +6 -23
  128. package/templates/scheduled/ts/tsconfig.json +1 -1
  129. package/templates/scheduled/ts/worker-configuration.d.ts +4 -0
  130. package/templates/scheduled/ts/wrangler.toml +110 -0
  131. package/templates/solid/c3.ts +87 -0
  132. package/templates/solid/templates/wrangler.toml +84 -0
  133. package/templates/svelte/c3.ts +131 -0
  134. package/templates/svelte/js/wrangler.toml +85 -0
  135. package/templates/svelte/ts/wrangler.toml +85 -0
  136. package/templates/vue/c3.ts +29 -0
  137. package/templates-experimental/angular/c3.ts +98 -0
  138. package/templates-experimental/angular/templates/server.ts +34 -0
  139. package/templates-experimental/angular/templates/tools/alter-polyfills.mjs +32 -0
  140. package/templates-experimental/angular/templates/wrangler.toml +11 -0
  141. package/templates-experimental/astro/c3.ts +114 -0
  142. package/templates-experimental/astro/snippets/runtimeDeclaration.ts +5 -0
  143. package/templates-experimental/astro/templates/public/.assetsignore +4 -0
  144. package/templates-experimental/astro/templates/wrangler.toml +12 -0
  145. package/templates-experimental/docusaurus/c3.ts +32 -0
  146. package/templates-experimental/docusaurus/templates/wrangler.toml +10 -0
  147. package/templates-experimental/gatsby/c3.ts +53 -0
  148. package/templates-experimental/gatsby/templates/wrangler.toml +10 -0
  149. package/templates-experimental/hello-world-assets-only/c3.ts +15 -0
  150. package/templates-experimental/hello-world-assets-only/templates/package.json +13 -0
  151. package/templates-experimental/hello-world-assets-only/templates/public/index.html +11 -0
  152. package/templates-experimental/hello-world-assets-only/templates/wrangler.toml +10 -0
  153. package/templates-experimental/hello-world-durable-object-with-assets/c3.ts +23 -0
  154. package/templates-experimental/hello-world-durable-object-with-assets/js/.editorconfig +12 -0
  155. package/templates-experimental/hello-world-durable-object-with-assets/js/.prettierrc +6 -0
  156. package/{templates/chatgptPlugin/ts → templates-experimental/hello-world-durable-object-with-assets/js}/__dot__gitignore +1 -0
  157. package/templates-experimental/hello-world-durable-object-with-assets/js/package.json +13 -0
  158. package/templates-experimental/hello-world-durable-object-with-assets/js/public/index.html +19 -0
  159. package/templates-experimental/hello-world-durable-object-with-assets/js/src/index.js +69 -0
  160. package/templates-experimental/hello-world-durable-object-with-assets/js/wrangler.toml +24 -0
  161. package/templates-experimental/hello-world-durable-object-with-assets/ts/.editorconfig +12 -0
  162. package/templates-experimental/hello-world-durable-object-with-assets/ts/.prettierrc +6 -0
  163. package/templates-experimental/hello-world-durable-object-with-assets/ts/__dot__gitignore +172 -0
  164. package/templates-experimental/hello-world-durable-object-with-assets/ts/package.json +15 -0
  165. package/templates-experimental/hello-world-durable-object-with-assets/ts/public/index.html +19 -0
  166. package/templates-experimental/hello-world-durable-object-with-assets/ts/src/index.ts +66 -0
  167. package/templates-experimental/hello-world-durable-object-with-assets/ts/tsconfig.json +101 -0
  168. package/templates-experimental/hello-world-durable-object-with-assets/ts/worker-configuration.d.ts +5 -0
  169. package/templates-experimental/hello-world-durable-object-with-assets/ts/wrangler.toml +24 -0
  170. package/templates-experimental/hello-world-with-assets/c3.ts +22 -0
  171. package/templates-experimental/hello-world-with-assets/js/.editorconfig +12 -0
  172. package/templates-experimental/hello-world-with-assets/js/.prettierrc +6 -0
  173. package/templates-experimental/hello-world-with-assets/js/__dot__gitignore +172 -0
  174. package/templates-experimental/hello-world-with-assets/js/package.json +16 -0
  175. package/templates-experimental/hello-world-with-assets/js/public/index.html +31 -0
  176. package/templates-experimental/hello-world-with-assets/js/src/index.js +23 -0
  177. package/templates-experimental/hello-world-with-assets/js/test/index.spec.js +41 -0
  178. package/templates-experimental/hello-world-with-assets/js/vitest.config.js +11 -0
  179. package/templates-experimental/hello-world-with-assets/js/wrangler.toml +12 -0
  180. package/templates-experimental/hello-world-with-assets/py/__dot__gitignore +68 -0
  181. package/templates-experimental/hello-world-with-assets/py/package.json +13 -0
  182. package/templates-experimental/hello-world-with-assets/py/public/index.html +31 -0
  183. package/templates-experimental/hello-world-with-assets/py/src/entry.py +9 -0
  184. package/templates-experimental/hello-world-with-assets/py/wrangler.toml +12 -0
  185. package/templates-experimental/hello-world-with-assets/ts/.editorconfig +12 -0
  186. package/templates-experimental/hello-world-with-assets/ts/.prettierrc +6 -0
  187. package/templates-experimental/hello-world-with-assets/ts/__dot__gitignore +172 -0
  188. package/templates-experimental/hello-world-with-assets/ts/package.json +18 -0
  189. package/templates-experimental/hello-world-with-assets/ts/public/index.html +31 -0
  190. package/templates-experimental/hello-world-with-assets/ts/src/index.ts +26 -0
  191. package/templates-experimental/hello-world-with-assets/ts/test/index.spec.ts +41 -0
  192. package/templates-experimental/hello-world-with-assets/ts/test/tsconfig.json +8 -0
  193. package/templates-experimental/hello-world-with-assets/ts/tsconfig.json +103 -0
  194. package/templates-experimental/hello-world-with-assets/ts/vitest.config.mts +11 -0
  195. package/templates-experimental/hello-world-with-assets/ts/worker-configuration.d.ts +4 -0
  196. package/templates-experimental/hello-world-with-assets/ts/wrangler.toml +12 -0
  197. package/templates-experimental/hono/c3.ts +43 -0
  198. package/templates-experimental/hono/templates/public/index.html +19 -0
  199. package/templates-experimental/hono/templates/src/index.ts +9 -0
  200. package/templates-experimental/hono/templates/worker-configuration.d.ts +4 -0
  201. package/templates-experimental/hono/templates/wrangler.toml +5 -0
  202. package/templates-experimental/next/c3.ts +52 -0
  203. package/templates-experimental/next/templates/__dot__gitignore +42 -0
  204. package/templates-experimental/next/templates/env.d.ts +5 -0
  205. package/templates-experimental/next/templates/wrangler.toml +12 -0
  206. package/templates-experimental/nuxt/c3.ts +135 -0
  207. package/templates-experimental/nuxt/templates/cloudflare-preset/nitro.config.ts +27 -0
  208. package/templates-experimental/nuxt/templates/env.d.ts +14 -0
  209. package/templates-experimental/nuxt/templates/worker-configuration.d.ts +4 -0
  210. package/templates-experimental/nuxt/templates/wrangler.toml +11 -0
  211. package/templates-experimental/qwik/c3.ts +153 -0
  212. package/templates-experimental/qwik/snippets/getPlatformProxy.ts +6 -0
  213. package/templates-experimental/qwik/templates/public/.assetsignore +4 -0
  214. package/templates-experimental/qwik/templates/worker-configuration.d.ts +4 -0
  215. package/templates-experimental/qwik/templates/wrangler.toml +12 -0
  216. package/templates-experimental/remix/c3.ts +77 -0
  217. package/templates-experimental/remix/templates/public/.assetsignore +4 -0
  218. package/templates-experimental/remix/templates/worker-configuration.d.ts +4 -0
  219. package/templates-experimental/remix/templates/wrangler.toml +11 -0
  220. package/templates-experimental/solid/c3.ts +137 -0
  221. package/templates-experimental/solid/templates/wrangler.toml +12 -0
  222. package/templates-experimental/svelte/c3.ts +132 -0
  223. package/templates-experimental/svelte/js/static/.assetsignore +4 -0
  224. package/templates-experimental/svelte/js/wrangler.toml +11 -0
  225. package/templates-experimental/svelte/ts/static/.assetsignore +4 -0
  226. package/templates-experimental/svelte/ts/wrangler.toml +11 -0
  227. package/dist/angular/templates/tools/bundle.mjs +0 -77
  228. package/dist/angular/templates/tools/copy-client-files.mjs +0 -4
  229. package/dist/angular/templates/tools/copy-worker-files.mjs +0 -10
  230. package/dist/angular/templates/tsconfig.server.json +0 -5
  231. package/templates/chatgptPlugin/ts/.assets/example.png +0 -0
  232. package/templates/chatgptPlugin/ts/README.md +0 -25
  233. package/templates/chatgptPlugin/ts/package.json +0 -17
  234. package/templates/chatgptPlugin/ts/src/index.ts +0 -33
  235. package/templates/chatgptPlugin/ts/src/search.ts +0 -59
  236. package/templates/chatgptPlugin/ts/wrangler.toml +0 -3
  237. /package/{dist → templates}/angular/templates/src/_routes.json +0 -0
  238. /package/{dist → templates}/angular/templates/tools/paths.mjs +0 -0
@@ -0,0 +1,147 @@
1
+ import { endSection } from "@cloudflare/cli";
2
+ import { brandColor } 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 { quoteShellArgs, runCommand } from "helpers/command";
7
+ import { usesTypescript } from "helpers/files";
8
+ import { detectPackageManager } from "helpers/packageManagers";
9
+ import * as recast from "recast";
10
+ import type { TemplateConfig } from "../../src/templates";
11
+ import type { C3Context } from "types";
12
+
13
+ const { npm, npx } = detectPackageManager();
14
+
15
+ const generate = async (ctx: C3Context) => {
16
+ await runFrameworkGenerator(ctx, ["playground", ctx.project.name]);
17
+ };
18
+
19
+ const configure = async (ctx: C3Context) => {
20
+ // Add the pages integration
21
+ const cmd = [npx, "qwik", "add", "cloudflare-pages"];
22
+ endSection(`Running ${quoteShellArgs(cmd)}`);
23
+ await runCommand(cmd);
24
+
25
+ addBindingsProxy(ctx);
26
+ populateCloudflareEnv();
27
+ };
28
+
29
+ const addBindingsProxy = (ctx: C3Context) => {
30
+ // Qwik only has a typescript template atm.
31
+ // This check is an extra precaution
32
+ if (!usesTypescript(ctx)) {
33
+ return;
34
+ }
35
+
36
+ const s = spinner();
37
+ s.start("Updating `vite.config.ts`");
38
+
39
+ const snippets = loadTemplateSnippets(ctx);
40
+ const b = recast.types.builders;
41
+
42
+ transformFile("vite.config.ts", {
43
+ // Insert the env declaration after the last import (but before the rest of the body)
44
+ visitProgram: function (n) {
45
+ const lastImportIndex = n.node.body.findLastIndex(
46
+ (t) => t.type === "ImportDeclaration",
47
+ );
48
+ const lastImport = n.get("body", lastImportIndex);
49
+ lastImport.insertAfter(...snippets.getPlatformProxyTs);
50
+
51
+ return this.traverse(n);
52
+ },
53
+ // Pass the `platform` object from the declaration to the `qwikCity` plugin
54
+ visitCallExpression: function (n) {
55
+ const callee = n.node.callee as recast.types.namedTypes.Identifier;
56
+ if (callee.name !== "qwikCity") {
57
+ return this.traverse(n);
58
+ }
59
+
60
+ // The config object passed to `qwikCity`
61
+ const configArgument = n.node.arguments[0] as
62
+ | recast.types.namedTypes.ObjectExpression
63
+ | undefined;
64
+
65
+ const platformPropery = b.objectProperty.from({
66
+ key: b.identifier("platform"),
67
+ value: b.identifier("platform"),
68
+ shorthand: true,
69
+ });
70
+
71
+ if (!configArgument) {
72
+ n.node.arguments = [b.objectExpression([platformPropery])];
73
+
74
+ return false;
75
+ }
76
+
77
+ if (configArgument.type !== "ObjectExpression") {
78
+ throw new Error("Failed to update `vite.config.ts`");
79
+ }
80
+
81
+ // Add the `platform` object to the object
82
+ configArgument.properties.push(platformPropery);
83
+
84
+ return false;
85
+ },
86
+ });
87
+
88
+ s.stop(`${brandColor("updated")} \`vite.config.ts\``);
89
+ };
90
+
91
+ const populateCloudflareEnv = () => {
92
+ const entrypointPath = "src/entry.cloudflare-pages.tsx";
93
+
94
+ const s = spinner();
95
+ s.start(`Updating \`${entrypointPath}\``);
96
+
97
+ transformFile(entrypointPath, {
98
+ visitTSInterfaceDeclaration: function (n) {
99
+ const b = recast.types.builders;
100
+ const id = n.node.id as recast.types.namedTypes.Identifier;
101
+ if (id.name !== "QwikCityPlatform") {
102
+ this.traverse(n);
103
+ }
104
+
105
+ const newBody = [
106
+ ["env", "Env"],
107
+ // Qwik doesn't supply `cf` to the platform object. Should they do so, uncomment this
108
+ // ["cf", "CfProperties"],
109
+ ].map(([varName, type]) =>
110
+ b.tsPropertySignature(
111
+ b.identifier(varName),
112
+ b.tsTypeAnnotation(b.tsTypeReference(b.identifier(type))),
113
+ ),
114
+ );
115
+
116
+ n.node.body.body = newBody;
117
+
118
+ return false;
119
+ },
120
+ });
121
+
122
+ s.stop(`${brandColor("updated")} \`${entrypointPath}\``);
123
+ };
124
+
125
+ const config: TemplateConfig = {
126
+ configVersion: 1,
127
+ id: "qwik",
128
+ frameworkCli: "create-qwik",
129
+ displayName: "Qwik",
130
+ platform: "pages",
131
+ copyFiles: {
132
+ path: "./templates",
133
+ },
134
+ generate,
135
+ configure,
136
+ transformPackageJson: async () => ({
137
+ scripts: {
138
+ deploy: `${npm} run build && wrangler pages deploy`,
139
+ preview: `${npm} run build && wrangler pages dev`,
140
+ "cf-typegen": `wrangler types`,
141
+ },
142
+ }),
143
+ devScript: "dev",
144
+ deployScript: "deploy",
145
+ previewScript: "preview",
146
+ };
147
+ export default config;
@@ -0,0 +1,6 @@
1
+ let platform = {};
2
+
3
+ if(process.env.NODE_ENV === 'development') {
4
+ const { getPlatformProxy } = await import('wrangler');
5
+ platform = await getPlatformProxy();
6
+ }
@@ -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,86 @@
1
+ #:schema node_modules/wrangler/config-schema.json
2
+ name = "<TBD>"
3
+ compatibility_date = "<TBD>"
4
+ pages_build_output_dir = "./dist"
5
+ compatibility_flags = ["nodejs_compat"]
6
+
7
+ # Automatically place your workloads in an optimal location to minimize latency.
8
+ # If you are running back-end logic in a Pages Function, running it closer to your back-end infrastructure
9
+ # rather than the end user may result in better performance.
10
+ # Docs: https://developers.cloudflare.com/pages/functions/smart-placement/#smart-placement
11
+ # [placement]
12
+ # mode = "smart"
13
+
14
+ # Variable bindings. These are arbitrary, plaintext strings (similar to environment variables)
15
+ # Docs:
16
+ # - https://developers.cloudflare.com/pages/functions/bindings/#environment-variables
17
+ # Note: Use secrets to store sensitive data.
18
+ # - https://developers.cloudflare.com/pages/functions/bindings/#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/pages/functions/bindings/#workers-ai
24
+ # [ai]
25
+ # binding = "AI"
26
+
27
+ # Bind a D1 database. D1 is Cloudflare’s native serverless SQL database.
28
+ # Docs: https://developers.cloudflare.com/pages/functions/bindings/#d1-databases
29
+ # [[d1_databases]]
30
+ # binding = "MY_DB"
31
+ # database_name = "my-database"
32
+ # database_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
33
+
34
+ # Bind a Durable Object. Durable objects are a scale-to-zero compute primitive based on the actor model.
35
+ # Durable Objects can live for as long as needed. Use these when you need a long-running "server", such as in realtime apps.
36
+ # Docs: https://developers.cloudflare.com/workers/runtime-apis/durable-objects
37
+ # [[durable_objects.bindings]]
38
+ # name = "MY_DURABLE_OBJECT"
39
+ # class_name = "MyDurableObject"
40
+ # script_name = 'my-durable-object'
41
+
42
+ # Bind a KV Namespace. Use KV as persistent storage for small key-value pairs.
43
+ # Docs: https://developers.cloudflare.com/pages/functions/bindings/#kv-namespaces
44
+ # [[kv_namespaces]]
45
+ # binding = "MY_KV_NAMESPACE"
46
+ # id = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
47
+
48
+ # Bind a Queue producer. Use this binding to schedule an arbitrary task that may be processed later by a Queue consumer.
49
+ # Docs: https://developers.cloudflare.com/pages/functions/bindings/#queue-producers
50
+ # [[queues.producers]]
51
+ # binding = "MY_QUEUE"
52
+ # queue = "my-queue"
53
+
54
+ # Bind an R2 Bucket. Use R2 to store arbitrarily large blobs of data, such as files.
55
+ # Docs: https://developers.cloudflare.com/pages/functions/bindings/#r2-buckets
56
+ # [[r2_buckets]]
57
+ # binding = "MY_BUCKET"
58
+ # bucket_name = "my-bucket"
59
+
60
+ # Bind another Worker service. Use this binding to call another Worker without network overhead.
61
+ # Docs: https://developers.cloudflare.com/pages/functions/bindings/#service-bindings
62
+ # [[services]]
63
+ # binding = "MY_SERVICE"
64
+ # service = "my-service"
65
+
66
+ # To use different bindings for preview and production environments, follow the examples below.
67
+ # When using environment-specific overrides for bindings, ALL bindings must be specified on a per-environment basis.
68
+ # Docs: https://developers.cloudflare.com/pages/functions/wrangler-configuration#environment-specific-overrides
69
+
70
+ ######## PREVIEW environment config ########
71
+
72
+ # [env.preview.vars]
73
+ # API_KEY = "xyz789"
74
+
75
+ # [[env.preview.kv_namespaces]]
76
+ # binding = "MY_KV_NAMESPACE"
77
+ # id = "<PREVIEW_NAMESPACE_ID>"
78
+
79
+ ######## PRODUCTION environment config ########
80
+
81
+ # [env.production.vars]
82
+ # API_KEY = "abc123"
83
+
84
+ # [[env.production.kv_namespaces]]
85
+ # binding = "MY_KV_NAMESPACE"
86
+ # id = "<PRODUCTION_NAMESPACE_ID>"
@@ -0,0 +1,61 @@
1
+ import { logRaw } from "@cloudflare/cli";
2
+ import { inputPrompt } from "@cloudflare/cli/interactive";
3
+ import { runFrameworkGenerator } from "frameworks/index";
4
+ import { detectPackageManager } from "helpers/packageManagers";
5
+ import type { TemplateConfig } from "../../src/templates";
6
+ import type { C3Context } from "types";
7
+
8
+ const { npm } = detectPackageManager();
9
+
10
+ const generate = async (ctx: C3Context) => {
11
+ const variant = await inputPrompt({
12
+ type: "select",
13
+ question: "Select a variant:",
14
+ label: "variant",
15
+ options: variantsOptions,
16
+ defaultValue: variantsOptions[0].value,
17
+ });
18
+
19
+ await runFrameworkGenerator(ctx, [ctx.project.name, "--template", variant]);
20
+
21
+ logRaw("");
22
+ };
23
+
24
+ const variantsOptions = [
25
+ {
26
+ value: "react-ts",
27
+ label: "TypeScript",
28
+ },
29
+ {
30
+ value: "react-swc-ts",
31
+ label: "TypeScript + SWC",
32
+ },
33
+ {
34
+ value: "react",
35
+ label: "JavaScript",
36
+ },
37
+ {
38
+ value: "react-swc",
39
+ label: "JavaScript + SWC",
40
+ },
41
+ ];
42
+
43
+ const config: TemplateConfig = {
44
+ configVersion: 1,
45
+ id: "react",
46
+ // React's documentation now recommends using create-vite.
47
+ frameworkCli: "create-vite",
48
+ displayName: "React",
49
+ platform: "pages",
50
+ generate,
51
+ transformPackageJson: async () => ({
52
+ scripts: {
53
+ deploy: `${npm} run build && wrangler pages deploy ./dist`,
54
+ preview: `${npm} run build && wrangler pages dev ./dist`,
55
+ },
56
+ }),
57
+ devScript: "dev",
58
+ deployScript: "deploy",
59
+ previewScript: "preview",
60
+ };
61
+ export default config;
@@ -0,0 +1,67 @@
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 { transformFile } from "helpers/codemod";
6
+ import { detectPackageManager } from "helpers/packageManagers";
7
+ import type { TemplateConfig } from "../../src/templates";
8
+ import type { C3Context } from "types";
9
+
10
+ const { npm } = detectPackageManager();
11
+
12
+ const generate = async (ctx: C3Context) => {
13
+ await runFrameworkGenerator(ctx, [
14
+ ctx.project.name,
15
+ "--template",
16
+ "https://github.com/remix-run/remix/tree/main/templates/cloudflare",
17
+ ]);
18
+
19
+ logRaw(""); // newline
20
+ };
21
+
22
+ const configure = async () => {
23
+ const typeDefsPath = "load-context.ts";
24
+
25
+ const s = spinner();
26
+ s.start(`Updating \`${typeDefsPath}\``);
27
+
28
+ // Remove the empty Env declaration from the template to allow the type from
29
+ // worker-configuration.d.ts to take over
30
+ transformFile(typeDefsPath, {
31
+ visitTSInterfaceDeclaration(n) {
32
+ if (n.node.id.type === "Identifier" && n.node.id.name !== "Env") {
33
+ return this.traverse(n);
34
+ }
35
+
36
+ // Removes the node
37
+ n.replace();
38
+ return false;
39
+ },
40
+ });
41
+
42
+ s.stop(`${brandColor("updated")} \`${dim(typeDefsPath)}\``);
43
+ };
44
+
45
+ const config: TemplateConfig = {
46
+ configVersion: 1,
47
+ id: "remix",
48
+ frameworkCli: "create-remix",
49
+ platform: "pages",
50
+ displayName: "Remix",
51
+ copyFiles: {
52
+ path: "./templates",
53
+ },
54
+ generate,
55
+ configure,
56
+ transformPackageJson: async () => ({
57
+ scripts: {
58
+ deploy: `${npm} run build && wrangler pages deploy`,
59
+ preview: `${npm} run build && wrangler pages dev`,
60
+ "cf-typegen": `wrangler types`,
61
+ },
62
+ }),
63
+ devScript: "dev",
64
+ deployScript: "deploy",
65
+ previewScript: "preview",
66
+ };
67
+ export default config;
@@ -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,85 @@
1
+ #:schema node_modules/wrangler/config-schema.json
2
+ name = "<TBD>"
3
+ compatibility_date = "<TBD>"
4
+ pages_build_output_dir = "./build/client"
5
+
6
+ # Automatically place your workloads in an optimal location to minimize latency.
7
+ # If you are running back-end logic in a Pages Function, 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/pages/functions/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/pages/functions/bindings/#environment-variables
16
+ # Note: Use secrets to store sensitive data.
17
+ # - https://developers.cloudflare.com/pages/functions/bindings/#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/pages/functions/bindings/#workers-ai
23
+ # [ai]
24
+ # binding = "AI"
25
+
26
+ # Bind a D1 database. D1 is Cloudflare’s native serverless SQL database.
27
+ # Docs: https://developers.cloudflare.com/pages/functions/bindings/#d1-databases
28
+ # [[d1_databases]]
29
+ # binding = "MY_DB"
30
+ # database_name = "my-database"
31
+ # database_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
32
+
33
+ # Bind a Durable Object. Durable objects are a scale-to-zero compute primitive based on the actor model.
34
+ # Durable Objects can live for as long as needed. Use these when you need a long-running "server", such as in realtime apps.
35
+ # Docs: https://developers.cloudflare.com/workers/runtime-apis/durable-objects
36
+ # [[durable_objects.bindings]]
37
+ # name = "MY_DURABLE_OBJECT"
38
+ # class_name = "MyDurableObject"
39
+ # script_name = 'my-durable-object'
40
+
41
+ # Bind a KV Namespace. Use KV as persistent storage for small key-value pairs.
42
+ # Docs: https://developers.cloudflare.com/pages/functions/bindings/#kv-namespaces
43
+ # [[kv_namespaces]]
44
+ # binding = "MY_KV_NAMESPACE"
45
+ # id = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
46
+
47
+ # Bind a Queue producer. Use this binding to schedule an arbitrary task that may be processed later by a Queue consumer.
48
+ # Docs: https://developers.cloudflare.com/pages/functions/bindings/#queue-producers
49
+ # [[queues.producers]]
50
+ # binding = "MY_QUEUE"
51
+ # queue = "my-queue"
52
+
53
+ # Bind an R2 Bucket. Use R2 to store arbitrarily large blobs of data, such as files.
54
+ # Docs: https://developers.cloudflare.com/pages/functions/bindings/#r2-buckets
55
+ # [[r2_buckets]]
56
+ # binding = "MY_BUCKET"
57
+ # bucket_name = "my-bucket"
58
+
59
+ # Bind another Worker service. Use this binding to call another Worker without network overhead.
60
+ # Docs: https://developers.cloudflare.com/pages/functions/bindings/#service-bindings
61
+ # [[services]]
62
+ # binding = "MY_SERVICE"
63
+ # service = "my-service"
64
+
65
+ # To use different bindings for preview and production environments, follow the examples below.
66
+ # When using environment-specific overrides for bindings, ALL bindings must be specified on a per-environment basis.
67
+ # Docs: https://developers.cloudflare.com/pages/functions/wrangler-configuration#environment-specific-overrides
68
+
69
+ ######## PREVIEW environment config ########
70
+
71
+ # [env.preview.vars]
72
+ # API_KEY = "xyz789"
73
+
74
+ # [[env.preview.kv_namespaces]]
75
+ # binding = "MY_KV_NAMESPACE"
76
+ # id = "<PREVIEW_NAMESPACE_ID>"
77
+
78
+ ######## PRODUCTION environment config ########
79
+
80
+ # [env.production.vars]
81
+ # API_KEY = "abc123"
82
+
83
+ # [[env.production.kv_namespaces]]
84
+ # binding = "MY_KV_NAMESPACE"
85
+ # id = "<PRODUCTION_NAMESPACE_ID>"
@@ -0,0 +1,18 @@
1
+ export default {
2
+ configVersion: 1,
3
+ id: "scheduled",
4
+ displayName: "Scheduled Worker (Cron Trigger)",
5
+ description:
6
+ "Create a Worker to be executed on a schedule for periodic (cron) jobs",
7
+ platform: "workers",
8
+ copyFiles: {
9
+ variants: {
10
+ js: {
11
+ path: "./js",
12
+ },
13
+ ts: {
14
+ path: "./ts",
15
+ },
16
+ },
17
+ },
18
+ };
@@ -3,7 +3,6 @@ root = true
3
3
 
4
4
  [*]
5
5
  indent_style = tab
6
- tab_width = 2
7
6
  end_of_line = lf
8
7
  charset = utf-8
9
8
  trim_trailing_whitespace = true
@@ -4,10 +4,10 @@
4
4
  "private": true,
5
5
  "scripts": {
6
6
  "deploy": "wrangler deploy",
7
- "dev": "wrangler dev",
8
- "start": "wrangler dev"
7
+ "dev": "wrangler dev --test-scheduled",
8
+ "start": "wrangler dev --test-scheduled"
9
9
  },
10
10
  "devDependencies": {
11
- "wrangler": "^3.0.0"
11
+ "wrangler": "^3.60.3"
12
12
  }
13
13
  }
@@ -6,13 +6,20 @@
6
6
  * https://developers.cloudflare.com/workers/platform/triggers/cron-triggers/
7
7
  *
8
8
  * - Run `npm run dev` in your terminal to start a development server
9
- * - Open a browser tab at http://localhost:8787/ to see your worker in action
9
+ * - Run `curl "http://localhost:8787/__scheduled?cron=*+*+*+*+*"` to see your worker in action
10
10
  * - Run `npm run deploy` to publish your worker
11
11
  *
12
12
  * Learn more at https://developers.cloudflare.com/workers/
13
13
  */
14
14
 
15
15
  export default {
16
+ async fetch(req) {
17
+ const url = new URL(req.url)
18
+ url.pathname = "/__scheduled";
19
+ url.searchParams.append("cron", "* * * * *");
20
+ return new Response(`To test the scheduled handler, ensure you have used the "--test-scheduled" then try running "curl ${url.href}".`);
21
+ },
22
+
16
23
  // The scheduled handler is invoked at the interval set in our wrangler.toml's
17
24
  // [[triggers]] configuration.
18
25
  async scheduled(event, env, ctx) {
@@ -1,3 +1,4 @@
1
+ #:schema node_modules/wrangler/config-schema.json
1
2
  name = "<TBD>"
2
3
  main = "src/index.js"
3
4
  compatibility_date = "<TBD>"
@@ -7,3 +8,112 @@ compatibility_date = "<TBD>"
7
8
  # Configuration: https://developers.cloudflare.com/workers/wrangler/configuration/#triggers
8
9
  [triggers]
9
10
  crons = ["* * * * *"] # * * * * * = run every minute
11
+
12
+ # Workers Logs
13
+ # Docs: https://developers.cloudflare.com/workers/observability/logs/workers-logs/
14
+ # Configuration: https://developers.cloudflare.com/workers/observability/logs/workers-logs/#enable-workers-logs
15
+ [observability]
16
+ enabled = true
17
+
18
+ # Automatically place your workloads in an optimal location to minimize latency.
19
+ # If you are running back-end logic in a Worker, running it closer to your back-end infrastructure
20
+ # rather than the end user may result in better performance.
21
+ # Docs: https://developers.cloudflare.com/workers/configuration/smart-placement/#smart-placement
22
+ # [placement]
23
+ # mode = "smart"
24
+
25
+ # Variable bindings. These are arbitrary, plaintext strings (similar to environment variables)
26
+ # Docs:
27
+ # - https://developers.cloudflare.com/workers/wrangler/configuration/#environment-variables
28
+ # Note: Use secrets to store sensitive data.
29
+ # - https://developers.cloudflare.com/workers/configuration/secrets/
30
+ # [vars]
31
+ # MY_VARIABLE = "production_value"
32
+
33
+ # Bind the Workers AI model catalog. Run machine learning models, powered by serverless GPUs, on Cloudflare’s global network
34
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#workers-ai
35
+ # [ai]
36
+ # binding = "AI"
37
+
38
+ # Bind an Analytics Engine dataset. Use Analytics Engine to write analytics within your Pages Function.
39
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#analytics-engine-datasets
40
+ # [[analytics_engine_datasets]]
41
+ # binding = "MY_DATASET"
42
+
43
+ # Bind a headless browser instance running on Cloudflare's global network.
44
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#browser-rendering
45
+ # [browser]
46
+ # binding = "MY_BROWSER"
47
+
48
+ # Bind a D1 database. D1 is Cloudflare’s native serverless SQL database.
49
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#d1-databases
50
+ # [[d1_databases]]
51
+ # binding = "MY_DB"
52
+ # database_name = "my-database"
53
+ # database_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
54
+
55
+ # Bind a dispatch namespace. Use Workers for Platforms to deploy serverless functions programmatically on behalf of your customers.
56
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#dispatch-namespace-bindings-workers-for-platforms
57
+ # [[dispatch_namespaces]]
58
+ # binding = "MY_DISPATCHER"
59
+ # namespace = "my-namespace"
60
+
61
+ # Bind a Durable Object. Durable objects are a scale-to-zero compute primitive based on the actor model.
62
+ # Durable Objects can live for as long as needed. Use these when you need a long-running "server", such as in realtime apps.
63
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#durable-objects
64
+ # [[durable_objects.bindings]]
65
+ # name = "MY_DURABLE_OBJECT"
66
+ # class_name = "MyDurableObject"
67
+
68
+ # Durable Object migrations.
69
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#migrations
70
+ # [[migrations]]
71
+ # tag = "v1"
72
+ # new_classes = ["MyDurableObject"]
73
+
74
+ # Bind a Hyperdrive configuration. Use to accelerate access to your existing databases from Cloudflare Workers.
75
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#hyperdrive
76
+ # [[hyperdrive]]
77
+ # binding = "MY_HYPERDRIVE"
78
+ # id = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
79
+
80
+ # Bind a KV Namespace. Use KV as persistent storage for small key-value pairs.
81
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#kv-namespaces
82
+ # [[kv_namespaces]]
83
+ # binding = "MY_KV_NAMESPACE"
84
+ # id = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
85
+
86
+ # Bind an mTLS certificate. Use to present a client certificate when communicating with another service.
87
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#mtls-certificates
88
+ # [[mtls_certificates]]
89
+ # binding = "MY_CERTIFICATE"
90
+ # certificate_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
91
+
92
+ # Bind a Queue producer. Use this binding to schedule an arbitrary task that may be processed later by a Queue consumer.
93
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#queues
94
+ # [[queues.producers]]
95
+ # binding = "MY_QUEUE"
96
+ # queue = "my-queue"
97
+
98
+ # Bind a Queue consumer. Queue Consumers can retrieve tasks scheduled by Producers to act on them.
99
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#queues
100
+ # [[queues.consumers]]
101
+ # queue = "my-queue"
102
+
103
+ # Bind an R2 Bucket. Use R2 to store arbitrarily large blobs of data, such as files.
104
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#r2-buckets
105
+ # [[r2_buckets]]
106
+ # binding = "MY_BUCKET"
107
+ # bucket_name = "my-bucket"
108
+
109
+ # Bind another Worker service. Use this binding to call another Worker without network overhead.
110
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#service-bindings
111
+ # [[services]]
112
+ # binding = "MY_SERVICE"
113
+ # service = "my-service"
114
+
115
+ # Bind a Vectorize index. Use to store and query vector embeddings for semantic search, classification and other vector search use-cases.
116
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#vectorize-indexes
117
+ # [[vectorize]]
118
+ # binding = "MY_INDEX"
119
+ # index_name = "my-index"
@@ -3,7 +3,6 @@ root = true
3
3
 
4
4
  [*]
5
5
  indent_style = tab
6
- tab_width = 2
7
6
  end_of_line = lf
8
7
  charset = utf-8
9
8
  trim_trailing_whitespace = true
@@ -4,12 +4,12 @@
4
4
  "private": true,
5
5
  "scripts": {
6
6
  "deploy": "wrangler deploy",
7
- "dev": "wrangler dev",
8
- "start": "wrangler dev"
7
+ "dev": "wrangler dev --test-scheduled",
8
+ "start": "wrangler dev --test-scheduled",
9
+ "cf-typegen": "wrangler types"
9
10
  },
10
11
  "devDependencies": {
11
- "@cloudflare/workers-types": "^4.20230419.0",
12
- "typescript": "^5.0.4",
13
- "wrangler": "^3.0.0"
12
+ "typescript": "^5.5.2",
13
+ "wrangler": "^3.60.3"
14
14
  }
15
15
  }