create-cloudflare 0.0.0-e5cdd7fa → 0.0.0-e5dbedd78

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 (282) hide show
  1. package/README.md +1 -1
  2. package/dist/cli.js +66474 -63680
  3. package/dist/tsconfig.tsbuildinfo +1 -0
  4. package/package.json +39 -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.jsonc +5 -0
  11. package/templates/angular/c3.ts +5 -95
  12. package/templates/angular/pages/c3.ts +134 -0
  13. package/templates/angular/pages/templates/src/server.ts +15 -0
  14. package/templates/angular/pages/templates/tools/copy-files.mjs +15 -0
  15. package/templates/angular/workers/c3.ts +130 -0
  16. package/templates/angular/workers/templates/src/server.ts +15 -0
  17. package/templates/angular/workers/templates/wrangler.jsonc +12 -0
  18. package/templates/astro/c3.ts +5 -46
  19. package/templates/astro/pages/c3.ts +98 -0
  20. package/templates/astro/pages/templates/js/wrangler.jsonc +8 -0
  21. package/templates/astro/pages/templates/ts/src/env.d.ts +5 -0
  22. package/templates/astro/pages/templates/ts/worker-configuration.d.ts +4 -0
  23. package/templates/astro/pages/templates/ts/wrangler.jsonc +8 -0
  24. package/templates/astro/workers/c3.ts +98 -0
  25. package/templates/astro/workers/templates/js/public/.assetsignore +2 -0
  26. package/templates/astro/workers/templates/js/wrangler.jsonc +15 -0
  27. package/templates/astro/workers/templates/ts/public/.assetsignore +2 -0
  28. package/templates/astro/workers/templates/ts/src/env.d.ts +5 -0
  29. package/templates/astro/workers/templates/ts/worker-configuration.d.ts +4 -0
  30. package/templates/astro/workers/templates/ts/wrangler.jsonc +15 -0
  31. package/templates/common/c3.ts +10 -5
  32. package/templates/common/js/.editorconfig +0 -1
  33. package/templates/common/js/package.json +1 -1
  34. package/templates/common/js/wrangler.jsonc +8 -0
  35. package/templates/common/ts/.editorconfig +0 -1
  36. package/templates/common/ts/package.json +4 -3
  37. package/templates/common/ts/src/ab-test.ts +2 -2
  38. package/templates/common/ts/src/index.ts +5 -2
  39. package/templates/common/ts/src/proxy.ts +2 -2
  40. package/templates/common/ts/src/redirect.ts +2 -2
  41. package/templates/common/ts/tsconfig.json +37 -95
  42. package/templates/common/ts/worker-configuration.d.ts +2 -14
  43. package/templates/common/ts/wrangler.jsonc +8 -0
  44. package/templates/docusaurus/c3.ts +5 -23
  45. package/templates/docusaurus/pages/c3.ts +30 -0
  46. package/templates/docusaurus/workers/c3.ts +33 -0
  47. package/templates/docusaurus/workers/templates/wrangler.jsonc +10 -0
  48. package/templates/gatsby/c3.ts +5 -42
  49. package/templates/gatsby/pages/c3.ts +50 -0
  50. package/templates/gatsby/workers/c3.ts +53 -0
  51. package/templates/gatsby/workers/templates/wrangler.jsonc +10 -0
  52. package/templates/hello-world/c3.ts +30 -7
  53. package/templates/hello-world/js/.editorconfig +0 -1
  54. package/templates/hello-world/js/package.json +5 -2
  55. package/templates/hello-world/js/test/index.spec.js +20 -0
  56. package/templates/hello-world/js/vitest.config.js +11 -0
  57. package/templates/hello-world/js/wrangler.jsonc +8 -0
  58. package/templates/hello-world/py/.python-version +1 -0
  59. package/templates/hello-world/py/README.md +23 -0
  60. package/templates/hello-world/py/__dot__gitignore +68 -0
  61. package/templates/hello-world/py/package.json +13 -0
  62. package/templates/hello-world/py/pyproject.toml +9 -0
  63. package/templates/hello-world/py/src/entry.py +4 -0
  64. package/templates/hello-world/py/uv.lock +22 -0
  65. package/templates/hello-world/py/wrangler.jsonc +9 -0
  66. package/templates/hello-world/ts/.editorconfig +0 -1
  67. package/templates/hello-world/ts/package.json +7 -3
  68. package/templates/hello-world/ts/src/index.ts +5 -19
  69. package/templates/hello-world/ts/test/index.spec.ts +25 -0
  70. package/templates/hello-world/ts/test/tsconfig.json +8 -0
  71. package/templates/hello-world/ts/tsconfig.json +39 -96
  72. package/templates/hello-world/ts/vitest.config.mts +11 -0
  73. package/templates/hello-world/ts/worker-configuration.d.ts +4 -0
  74. package/templates/hello-world/ts/wrangler.jsonc +8 -0
  75. package/templates/hello-world-assets-only/c3.ts +16 -0
  76. package/templates/hello-world-assets-only/templates/package.json +13 -0
  77. package/templates/hello-world-assets-only/templates/public/index.html +11 -0
  78. package/templates/hello-world-assets-only/templates/wrangler.jsonc +10 -0
  79. package/templates/hello-world-durable-object/c3.ts +10 -6
  80. package/templates/hello-world-durable-object/js/.editorconfig +0 -1
  81. package/templates/hello-world-durable-object/js/package.json +1 -1
  82. package/templates/hello-world-durable-object/js/src/index.js +28 -23
  83. package/templates/hello-world-durable-object/js/wrangler.jsonc +24 -0
  84. package/templates/hello-world-durable-object/ts/.editorconfig +0 -1
  85. package/templates/hello-world-durable-object/ts/package.json +4 -4
  86. package/templates/hello-world-durable-object/ts/src/index.ts +32 -44
  87. package/templates/hello-world-durable-object/ts/tsconfig.json +36 -95
  88. package/templates/hello-world-durable-object/ts/worker-configuration.d.ts +5 -0
  89. package/templates/hello-world-durable-object/ts/wrangler.jsonc +24 -0
  90. package/templates/hello-world-durable-object-with-assets/c3.ts +23 -0
  91. package/templates/hello-world-durable-object-with-assets/js/.editorconfig +12 -0
  92. package/templates/hello-world-durable-object-with-assets/js/.prettierrc +6 -0
  93. package/templates/hello-world-durable-object-with-assets/js/__dot__gitignore +172 -0
  94. package/templates/hello-world-durable-object-with-assets/js/package.json +13 -0
  95. package/templates/hello-world-durable-object-with-assets/js/public/index.html +19 -0
  96. package/templates/hello-world-durable-object-with-assets/js/src/index.js +69 -0
  97. package/templates/hello-world-durable-object-with-assets/js/wrangler.jsonc +28 -0
  98. package/templates/hello-world-durable-object-with-assets/ts/.editorconfig +12 -0
  99. package/templates/hello-world-durable-object-with-assets/ts/.prettierrc +6 -0
  100. package/templates/hello-world-durable-object-with-assets/ts/__dot__gitignore +172 -0
  101. package/templates/hello-world-durable-object-with-assets/ts/package.json +15 -0
  102. package/templates/hello-world-durable-object-with-assets/ts/public/index.html +19 -0
  103. package/templates/hello-world-durable-object-with-assets/ts/src/index.ts +66 -0
  104. package/templates/hello-world-durable-object-with-assets/ts/tsconfig.json +42 -0
  105. package/templates/hello-world-durable-object-with-assets/ts/worker-configuration.d.ts +5 -0
  106. package/templates/hello-world-durable-object-with-assets/ts/wrangler.jsonc +28 -0
  107. package/templates/hello-world-with-assets/c3.ts +21 -0
  108. package/templates/hello-world-with-assets/js/.editorconfig +12 -0
  109. package/templates/hello-world-with-assets/js/.prettierrc +6 -0
  110. package/templates/hello-world-with-assets/js/__dot__gitignore +172 -0
  111. package/templates/hello-world-with-assets/js/package.json +16 -0
  112. package/templates/hello-world-with-assets/js/public/index.html +31 -0
  113. package/templates/hello-world-with-assets/js/src/index.js +23 -0
  114. package/templates/hello-world-with-assets/js/test/index.spec.js +41 -0
  115. package/templates/hello-world-with-assets/js/vitest.config.js +11 -0
  116. package/templates/hello-world-with-assets/js/wrangler.jsonc +15 -0
  117. package/templates/hello-world-with-assets/py/__dot__gitignore +68 -0
  118. package/templates/hello-world-with-assets/py/package.json +13 -0
  119. package/templates/hello-world-with-assets/py/public/index.html +31 -0
  120. package/templates/hello-world-with-assets/py/src/entry.py +9 -0
  121. package/templates/hello-world-with-assets/py/wrangler.jsonc +15 -0
  122. package/templates/hello-world-with-assets/ts/.editorconfig +12 -0
  123. package/templates/hello-world-with-assets/ts/.prettierrc +6 -0
  124. package/templates/hello-world-with-assets/ts/__dot__gitignore +172 -0
  125. package/templates/hello-world-with-assets/ts/package.json +18 -0
  126. package/templates/hello-world-with-assets/ts/public/index.html +31 -0
  127. package/templates/hello-world-with-assets/ts/src/index.ts +26 -0
  128. package/templates/hello-world-with-assets/ts/test/index.spec.ts +41 -0
  129. package/templates/hello-world-with-assets/ts/test/tsconfig.json +8 -0
  130. package/templates/hello-world-with-assets/ts/tsconfig.json +44 -0
  131. package/templates/hello-world-with-assets/ts/vitest.config.mts +11 -0
  132. package/templates/hello-world-with-assets/ts/worker-configuration.d.ts +4 -0
  133. package/templates/hello-world-with-assets/ts/wrangler.jsonc +15 -0
  134. package/templates/hono/c3.ts +5 -21
  135. package/templates/hono/pages/c3.ts +42 -0
  136. package/templates/hono/pages/templates/src/index.tsx +12 -0
  137. package/templates/hono/pages/templates/worker-configuration.d.ts +4 -0
  138. package/templates/hono/pages/templates/wrangler.jsonc +9 -0
  139. package/templates/hono/workers/c3.ts +42 -0
  140. package/templates/hono/workers/templates/public/index.html +19 -0
  141. package/templates/hono/workers/templates/src/index.ts +9 -0
  142. package/templates/hono/workers/templates/worker-configuration.d.ts +4 -0
  143. package/templates/hono/workers/templates/wrangler.jsonc +9 -0
  144. package/templates/next/README.md +67 -0
  145. package/templates/next/app/js/app/api/hello/route.js +21 -0
  146. package/templates/next/app/js/app/not-found.js +58 -0
  147. package/templates/next/app/ts/app/api/hello/route.ts +21 -0
  148. package/templates/next/app/ts/app/not-found.tsx +58 -0
  149. package/templates/next/c3.ts +96 -86
  150. package/templates/next/env.d.ts +5 -0
  151. package/templates/next/pages/js/pages/api/hello.js +23 -0
  152. package/templates/next/pages/ts/pages/api/hello.ts +24 -0
  153. package/templates/next/wrangler.jsonc +8 -0
  154. package/templates/nuxt/c3.ts +5 -55
  155. package/templates/nuxt/pages/c3.ts +145 -0
  156. package/templates/nuxt/pages/templates/env.d.ts +14 -0
  157. package/templates/nuxt/pages/templates/worker-configuration.d.ts +4 -0
  158. package/templates/nuxt/pages/templates/wrangler.jsonc +5 -0
  159. package/templates/nuxt/workers/c3.ts +145 -0
  160. package/templates/nuxt/workers/templates/env.d.ts +14 -0
  161. package/templates/nuxt/workers/templates/worker-configuration.d.ts +4 -0
  162. package/templates/nuxt/workers/templates/wrangler.jsonc +12 -0
  163. package/templates/openapi/c3.ts +1 -0
  164. package/templates/openapi/ts/README.md +3 -3
  165. package/templates/openapi/ts/package.json +7 -4
  166. package/templates/openapi/ts/src/endpoints/taskCreate.ts +26 -16
  167. package/templates/openapi/ts/src/endpoints/taskDelete.ts +20 -19
  168. package/templates/openapi/ts/src/endpoints/taskFetch.ts +30 -23
  169. package/templates/openapi/ts/src/endpoints/taskList.ts +27 -24
  170. package/templates/openapi/ts/src/index.ts +14 -20
  171. package/templates/openapi/ts/src/types.ts +9 -8
  172. package/templates/openapi/ts/worker-configuration.d.ts +4 -0
  173. package/templates/openapi/ts/wrangler.jsonc +8 -0
  174. package/templates/pre-existing/c3.ts +37 -18
  175. package/templates/pre-existing/js/.editorconfig +0 -1
  176. package/templates/pre-existing/js/package.json +1 -1
  177. package/templates/queues/c3.ts +9 -5
  178. package/templates/queues/js/.editorconfig +0 -1
  179. package/templates/queues/js/package.json +1 -1
  180. package/templates/queues/js/wrangler.jsonc +21 -0
  181. package/templates/queues/ts/.editorconfig +0 -1
  182. package/templates/queues/ts/package.json +4 -3
  183. package/templates/queues/ts/src/index.ts +6 -8
  184. package/templates/queues/ts/tsconfig.json +36 -95
  185. package/templates/queues/ts/worker-configuration.d.ts +5 -0
  186. package/templates/queues/ts/wrangler.jsonc +21 -0
  187. package/templates/qwik/c3.ts +5 -88
  188. package/templates/qwik/pages/c3.ts +149 -0
  189. package/templates/qwik/pages/snippets/getPlatformProxy.ts +6 -0
  190. package/templates/qwik/pages/templates/worker-configuration.d.ts +4 -0
  191. package/templates/qwik/pages/templates/wrangler.jsonc +8 -0
  192. package/templates/qwik/workers/c3.ts +154 -0
  193. package/templates/qwik/workers/snippets/getPlatformProxy.ts +6 -0
  194. package/templates/qwik/workers/templates/public/.assetsignore +4 -0
  195. package/templates/qwik/workers/templates/worker-configuration.d.ts +4 -0
  196. package/templates/qwik/workers/templates/wrangler.jsonc +15 -0
  197. package/templates/react/c3.ts +5 -25
  198. package/templates/react/pages/c3.ts +62 -0
  199. package/templates/react/workers/c3.ts +183 -0
  200. package/templates/react/workers/js/api/index.js +13 -0
  201. package/templates/react/workers/js/src/App.css +45 -0
  202. package/templates/react/workers/js/src/App.jsx +58 -0
  203. package/templates/react/workers/js/src/assets/Cloudflare_Logo.svg +53 -0
  204. package/templates/react/workers/js/wrangler.jsonc +9 -0
  205. package/templates/react/workers/ts/api/index.ts +13 -0
  206. package/templates/react/workers/ts/src/App.css +45 -0
  207. package/templates/react/workers/ts/src/App.tsx +58 -0
  208. package/templates/react/workers/ts/src/assets/Cloudflare_Logo.svg +51 -0
  209. package/templates/react/workers/ts/tsconfig.worker.json +8 -0
  210. package/templates/react/workers/ts/worker-configuration.d.ts +5 -0
  211. package/templates/react/workers/ts/wrangler.jsonc +9 -0
  212. package/templates/remix/c3.ts +5 -29
  213. package/templates/remix/pages/c3.ts +68 -0
  214. package/templates/remix/pages/templates/worker-configuration.d.ts +4 -0
  215. package/templates/remix/pages/templates/wrangler.jsonc +5 -0
  216. package/templates/remix/workers/c3.ts +52 -0
  217. package/templates/remix/workers/templates/public/.assetsignore +0 -0
  218. package/templates/remix/workers/templates/worker-configuration.d.ts +4 -0
  219. package/templates/remix/workers/templates/wrangler.toml +11 -0
  220. package/templates/scheduled/c3.ts +9 -5
  221. package/templates/scheduled/js/.editorconfig +0 -1
  222. package/templates/scheduled/js/package.json +3 -3
  223. package/templates/scheduled/js/src/index.js +9 -2
  224. package/templates/scheduled/js/wrangler.jsonc +13 -0
  225. package/templates/scheduled/ts/.editorconfig +0 -1
  226. package/templates/scheduled/ts/package.json +5 -4
  227. package/templates/scheduled/ts/src/index.ts +8 -25
  228. package/templates/scheduled/ts/tsconfig.json +36 -95
  229. package/templates/scheduled/ts/worker-configuration.d.ts +4 -0
  230. package/templates/scheduled/ts/wrangler.jsonc +13 -0
  231. package/templates/solid/c3.ts +62 -12
  232. package/templates/solid/templates/wrangler.jsonc +8 -0
  233. package/templates/svelte/c3.ts +6 -74
  234. package/templates/svelte/pages/c3.ts +159 -0
  235. package/templates/svelte/pages/templates/wrangler.jsonc +5 -0
  236. package/templates/svelte/workers/c3.ts +129 -0
  237. package/templates/svelte/workers/templates/static/.assetsignore +2 -0
  238. package/templates/svelte/workers/templates/wrangler.jsonc +12 -0
  239. package/templates/vue/c3.ts +5 -23
  240. package/templates/vue/pages/c3.ts +30 -0
  241. package/templates/vue/workers/c3.ts +98 -0
  242. package/templates/vue/workers/js/server/index.js +13 -0
  243. package/templates/vue/workers/js/src/App.vue +107 -0
  244. package/templates/vue/workers/js/src/components/HelloWorld.vue +47 -0
  245. package/templates/vue/workers/js/vite.config.js +21 -0
  246. package/templates/vue/workers/js/wrangler.jsonc +12 -0
  247. package/templates/vue/workers/ts/server/index.ts +13 -0
  248. package/templates/vue/workers/ts/src/App.vue +107 -0
  249. package/templates/vue/workers/ts/src/components/HelloWorld.vue +44 -0
  250. package/templates/vue/workers/ts/tsconfig.worker.json +8 -0
  251. package/templates/vue/workers/ts/vite.config.ts +21 -0
  252. package/templates/vue/workers/ts/worker-configuration.d.ts +6 -0
  253. package/templates/vue/workers/ts/wrangler.jsonc +12 -0
  254. package/templates-experimental/next/c3.ts +75 -0
  255. package/templates-experimental/next/templates/.dev.vars +2 -0
  256. package/templates-experimental/next/templates/__dot__gitignore +39 -0
  257. package/templates-experimental/next/templates/cloudflare-env.d.ts +5 -0
  258. package/templates-experimental/next/templates/open-next.config.ts +6 -0
  259. package/templates-experimental/next/templates/wrangler.jsonc +12 -0
  260. package/templates-experimental/solid/c3.ts +94 -0
  261. package/templates-experimental/solid/templates/wrangler.jsonc +15 -0
  262. package/templates/angular/templates/server.ts +0 -34
  263. package/templates/angular/templates/tools/alter-polyfills.mjs +0 -27
  264. package/templates/angular/templates/tools/copy-files.mjs +0 -9
  265. package/templates/angular/templates/tools/paths.mjs +0 -9
  266. package/templates/common/js/wrangler.toml +0 -51
  267. package/templates/common/ts/wrangler.toml +0 -51
  268. package/templates/hello-world/js/wrangler.toml +0 -51
  269. package/templates/hello-world/ts/wrangler.toml +0 -51
  270. package/templates/hello-world-durable-object/js/wrangler.toml +0 -51
  271. package/templates/hello-world-durable-object/ts/wrangler.toml +0 -51
  272. package/templates/next/templates.ts +0 -281
  273. package/templates/openapi/ts/wrangler.toml +0 -3
  274. package/templates/pre-existing/js/wrangler.toml +0 -3
  275. package/templates/queues/js/wrangler.toml +0 -19
  276. package/templates/queues/ts/wrangler.toml +0 -19
  277. package/templates/scheduled/js/wrangler.toml +0 -9
  278. package/templates/scheduled/ts/wrangler.toml +0 -9
  279. package/templates/solid/js/vite.config.js +0 -12
  280. package/templates/solid/ts/vite.config.ts +0 -12
  281. package/templates/svelte/templates.ts +0 -13
  282. /package/templates/angular/{templates → pages/templates}/src/_routes.json +0 -0
@@ -0,0 +1,50 @@
1
+ import { inputPrompt } from "@cloudflare/cli/interactive";
2
+ import { runFrameworkGenerator } from "frameworks/index";
3
+ import { detectPackageManager } from "helpers/packageManagers";
4
+ import type { TemplateConfig } from "../../../src/templates";
5
+ import type { C3Context } from "types";
6
+
7
+ const { npm } = detectPackageManager();
8
+
9
+ const generate = async (ctx: C3Context) => {
10
+ const defaultTemplate = "https://github.com/gatsbyjs/gatsby-starter-blog";
11
+
12
+ const useTemplate = await inputPrompt({
13
+ type: "confirm",
14
+ question: "Would you like to use a template?",
15
+ label: "template",
16
+ defaultValue: true,
17
+ });
18
+
19
+ let templateUrl = "";
20
+ if (useTemplate) {
21
+ templateUrl = await inputPrompt({
22
+ type: "text",
23
+ question: `Please specify the url of the template you'd like to use`,
24
+ label: "template",
25
+ defaultValue: defaultTemplate,
26
+ });
27
+ }
28
+
29
+ await runFrameworkGenerator(ctx, ["new", ctx.project.name, templateUrl]);
30
+ };
31
+
32
+ const config: TemplateConfig = {
33
+ configVersion: 1,
34
+ id: "gatsby",
35
+ frameworkCli: "gatsby",
36
+ platform: "pages",
37
+ displayName: "Gatsby",
38
+ path: "templates/gatsby/pages",
39
+ generate,
40
+ transformPackageJson: async () => ({
41
+ scripts: {
42
+ deploy: `${npm} run build && wrangler pages deploy ./public`,
43
+ preview: `${npm} run build && wrangler pages dev ./public`,
44
+ },
45
+ }),
46
+ devScript: "develop",
47
+ deployScript: "deploy",
48
+ previewScript: "preview",
49
+ };
50
+ export default config;
@@ -0,0 +1,53 @@
1
+ import { inputPrompt } from "@cloudflare/cli/interactive";
2
+ import { runFrameworkGenerator } from "frameworks/index";
3
+ import { detectPackageManager } from "helpers/packageManagers";
4
+ import type { TemplateConfig } from "../../../src/templates";
5
+ import type { C3Context } from "types";
6
+
7
+ const { npm } = detectPackageManager();
8
+
9
+ const generate = async (ctx: C3Context) => {
10
+ const defaultTemplate = "https://github.com/gatsbyjs/gatsby-starter-blog";
11
+
12
+ const useTemplate = await inputPrompt({
13
+ type: "confirm",
14
+ question: "Would you like to use a template?",
15
+ label: "template",
16
+ defaultValue: true,
17
+ });
18
+
19
+ let templateUrl = "";
20
+ if (useTemplate) {
21
+ templateUrl = await inputPrompt({
22
+ type: "text",
23
+ question: `Please specify the url of the template you'd like to use`,
24
+ label: "template",
25
+ defaultValue: defaultTemplate,
26
+ });
27
+ }
28
+
29
+ await runFrameworkGenerator(ctx, ["new", ctx.project.name, templateUrl]);
30
+ };
31
+
32
+ const config: TemplateConfig = {
33
+ configVersion: 1,
34
+ id: "gatsby",
35
+ frameworkCli: "gatsby",
36
+ platform: "workers",
37
+ displayName: "Gatsby",
38
+ copyFiles: {
39
+ path: "./templates",
40
+ },
41
+ path: "templates/gatsby/workers",
42
+ generate,
43
+ transformPackageJson: async () => ({
44
+ scripts: {
45
+ deploy: `${npm} run build && wrangler deploy`,
46
+ preview: `${npm} run build && wrangler dev`,
47
+ },
48
+ }),
49
+ devScript: "develop",
50
+ deployScript: "deploy",
51
+ previewScript: "preview",
52
+ };
53
+ export default config;
@@ -0,0 +1,10 @@
1
+ {
2
+ "name": "<TBD>",
3
+ "compatibility_date": "<TBD>",
4
+ "assets": {
5
+ "directory": "./public"
6
+ },
7
+ "observability": {
8
+ "enabled": true
9
+ }
10
+ }
@@ -1,14 +1,37 @@
1
+ import { readFile, writeFile } from "node:fs/promises";
2
+ import { resolve } from "node:path";
3
+ import type { TemplateConfig } from "../../src/templates";
4
+
1
5
  export default {
2
6
  configVersion: 1,
3
7
  id: "hello-world",
4
- displayName: '"Hello World" Worker',
8
+ displayName: "Worker only",
9
+ description:
10
+ "For processing requests, transforming responses, or API endpoints",
5
11
  platform: "workers",
12
+ async configure(ctx) {
13
+ if (ctx.args.lang === "python") {
14
+ for (const file of ["pyproject.toml", "uv.lock"]) {
15
+ const contents = await readFile(
16
+ resolve(ctx.project.path, file),
17
+ "utf8",
18
+ );
19
+ const updated = contents.replaceAll(/<TBD>/g, ctx.project.name);
20
+ await writeFile(resolve(ctx.project.path, file), updated);
21
+ }
22
+ }
23
+ },
6
24
  copyFiles: {
7
- js: {
8
- path: "./js",
9
- },
10
- ts: {
11
- path: "./ts",
25
+ variants: {
26
+ js: {
27
+ path: "./js",
28
+ },
29
+ ts: {
30
+ path: "./ts",
31
+ },
32
+ python: {
33
+ path: "./py",
34
+ },
12
35
  },
13
36
  },
14
- };
37
+ } satisfies TemplateConfig;
@@ -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
@@ -5,9 +5,12 @@
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
- "wrangler": "^3.0.0"
12
+ "@cloudflare/vitest-pool-workers": "^0.7.5",
13
+ "wrangler": "^3.101.0",
14
+ "vitest": "~3.0.7"
12
15
  }
13
16
  }
@@ -0,0 +1,20 @@
1
+ import { env, createExecutionContext, waitOnExecutionContext, SELF } from 'cloudflare:test';
2
+ import { describe, it, expect } from 'vitest';
3
+ import worker from '../src';
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
+ });
15
+
16
+ it('responds with Hello World! (integration style)', async () => {
17
+ const response = await SELF.fetch('http://example.com');
18
+ expect(await response.text()).toMatchInlineSnapshot(`"Hello World!"`);
19
+ });
20
+ });
@@ -0,0 +1,11 @@
1
+ import { defineWorkersConfig } from '@cloudflare/vitest-pool-workers/config';
2
+
3
+ export default defineWorkersConfig({
4
+ test: {
5
+ poolOptions: {
6
+ workers: {
7
+ wrangler: { configPath: './wrangler.jsonc' },
8
+ },
9
+ },
10
+ },
11
+ });
@@ -0,0 +1,8 @@
1
+ {
2
+ "name": "<TBD>",
3
+ "main": "src/index.js",
4
+ "compatibility_date": "<TBD>",
5
+ "observability": {
6
+ "enabled": true,
7
+ },
8
+ }
@@ -0,0 +1 @@
1
+ 3.12
@@ -0,0 +1,23 @@
1
+ ## Usage
2
+
3
+ You can run the worker defined by your new project by executing `wrangler dev` in this
4
+ directory. This will start up an HTTP server and will allow you to iterate on your
5
+ worker without having to restart `wrangler`.
6
+
7
+ ### Types and autocomplete
8
+
9
+ This project also includes a pyproject.toml and uv.lock file with some requirements which
10
+ set up autocomplete and type hints for this Python Workers project.
11
+
12
+ To get these installed you'll need `uv`, which you can install by following
13
+ https://docs.astral.sh/uv/getting-started/installation/.
14
+
15
+ Once `uv` is installed, you can run the following:
16
+
17
+ ```
18
+ uv venv
19
+ uv sync
20
+ ```
21
+
22
+ Then point your editor's Python plugin at the `.venv` directory. You should then have working
23
+ autocomplete and type information in your editor.
@@ -0,0 +1,68 @@
1
+ # Logs
2
+
3
+ logs
4
+ _.log
5
+ npm-debug.log_
6
+ yarn-debug.log*
7
+ yarn-error.log*
8
+ lerna-debug.log*
9
+ .pnpm-debug.log*
10
+
11
+ # Diagnostic reports (https://nodejs.org/api/report.html)
12
+
13
+ report.[0-9]_.[0-9]_.[0-9]_.[0-9]_.json
14
+
15
+ # Runtime data
16
+
17
+ pids
18
+ _.pid
19
+ _.seed
20
+ \*.pid.lock
21
+
22
+ # Dependency directories
23
+
24
+ node_modules/
25
+ jspm_packages/
26
+
27
+ # TypeScript cache
28
+
29
+ \*.tsbuildinfo
30
+
31
+ # Optional npm cache directory
32
+
33
+ .npm
34
+
35
+ # Optional eslint cache
36
+
37
+ .eslintcache
38
+
39
+ # Optional stylelint cache
40
+
41
+ .stylelintcache
42
+
43
+ # Optional REPL history
44
+
45
+ .node_repl_history
46
+
47
+ # Output of 'npm pack'
48
+
49
+ \*.tgz
50
+
51
+ # dotenv environment variable files
52
+
53
+ .env
54
+ .env.development.local
55
+ .env.test.local
56
+ .env.production.local
57
+ .env.local
58
+
59
+ # public
60
+
61
+ # Stores VSCode versions used for testing VSCode extensions
62
+
63
+ .vscode-test
64
+
65
+ # wrangler project
66
+
67
+ .dev.vars
68
+ .wrangler/
@@ -0,0 +1,13 @@
1
+ {
2
+ "name": "<TBD>",
3
+ "version": "0.0.0",
4
+ "private": true,
5
+ "scripts": {
6
+ "deploy": "wrangler deploy",
7
+ "dev": "wrangler dev",
8
+ "start": "wrangler dev"
9
+ },
10
+ "devDependencies": {
11
+ "wrangler": "^3.101.0"
12
+ }
13
+ }
@@ -0,0 +1,9 @@
1
+ [project]
2
+ name = "<TBD>"
3
+ version = "0.1.0"
4
+ description = "Add your description here"
5
+ readme = "README.md"
6
+ requires-python = ">=3.12"
7
+ dependencies = [
8
+ "webtypy>=0.1.7",
9
+ ]
@@ -0,0 +1,4 @@
1
+ from js import Response
2
+
3
+ async def on_fetch(request, env):
4
+ return Response.new("Hello World!")
@@ -0,0 +1,22 @@
1
+ version = 1
2
+ requires-python = ">=3.12"
3
+
4
+ [[package]]
5
+ name = "<TBD>"
6
+ version = "0.1.0"
7
+ source = { virtual = "." }
8
+ dependencies = [
9
+ { name = "webtypy" },
10
+ ]
11
+
12
+ [package.metadata]
13
+ requires-dist = [{ name = "webtypy", specifier = ">=0.1.7" }]
14
+
15
+ [[package]]
16
+ name = "webtypy"
17
+ version = "0.1.7"
18
+ source = { registry = "https://pypi.org/simple" }
19
+ sdist = { url = "https://files.pythonhosted.org/packages/5e/89/c7a0311fdc73809fc2415be97767f085ff3e00c86546430034dc8465fee7/webtypy-0.1.7.tar.gz", hash = "sha256:1b7212719a949c802f3d60fac5f0d952eb503a92121409cf1ad9847d7c76a336", size = 104505 }
20
+ wheels = [
21
+ { url = "https://files.pythonhosted.org/packages/61/91/c731bdaa605279e00b28bfd2bf0ae67f48061d16890fb1c026924bfbd242/webtypy-0.1.7-py3-none-any.whl", hash = "sha256:f35e6d73a4e08783e23adfac271a11cda3a2bd1105499db70e4819244efed0ae", size = 103519 },
22
+ ]
@@ -0,0 +1,9 @@
1
+ {
2
+ "name": "<TBD>",
3
+ "main": "src/entry.py",
4
+ "compatibility_date": "<TBD>",
5
+ "compatibility_flags": ["python_workers"],
6
+ "observability": {
7
+ "enabled": true,
8
+ },
9
+ }
@@ -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
@@ -5,10 +5,14 @@
5
5
  "scripts": {
6
6
  "deploy": "wrangler deploy",
7
7
  "dev": "wrangler dev",
8
- "start": "wrangler dev"
8
+ "start": "wrangler dev",
9
+ "test": "vitest",
10
+ "cf-typegen": "wrangler types"
9
11
  },
10
12
  "devDependencies": {
11
- "typescript": "^5.0.4",
12
- "wrangler": "^3.0.0"
13
+ "@cloudflare/vitest-pool-workers": "^0.7.5",
14
+ "typescript": "^5.5.2",
15
+ "vitest": "~3.0.7",
16
+ "wrangler": "^3.101.0"
13
17
  }
14
18
  }
@@ -5,28 +5,14 @@
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.jsonc`. 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
- async fetch(request: Request, env: Env, ctx: ExecutionContext): Promise<Response> {
15
+ async fetch(request, env, ctx): Promise<Response> {
30
16
  return new Response('Hello World!');
31
17
  },
32
- };
18
+ } satisfies ExportedHandler<Env>;
@@ -0,0 +1,25 @@
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';
5
+
6
+ // For now, you'll need to do something like this to get a correctly-typed
7
+ // `Request` to pass to `worker.fetch()`.
8
+ const IncomingRequest = Request<unknown, IncomingRequestCfProperties>;
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
+ });
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
+ });
25
+ });
@@ -0,0 +1,8 @@
1
+ {
2
+ "extends": "../tsconfig.json",
3
+ "compilerOptions": {
4
+ "types": ["@cloudflare/workers-types/experimental", "@cloudflare/vitest-pool-workers"]
5
+ },
6
+ "include": ["./**/*.ts", "../worker-configuration.d.ts"],
7
+ "exclude": []
8
+ }
@@ -2,100 +2,43 @@
2
2
  "compilerOptions": {
3
3
  /* Visit https://aka.ms/tsconfig.json to read more about this file */
4
4
 
5
- /* Projects */
6
- // "incremental": true, /* Enable incremental compilation */
7
- // "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */
8
- // "tsBuildInfoFile": "./", /* Specify the folder for .tsbuildinfo incremental compilation files. */
9
- // "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects */
10
- // "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */
11
- // "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */
12
-
13
- /* Language and Environment */
14
- "target": "es2021" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
15
- "lib": ["es2021"] /* Specify a set of bundled library declaration files that describe the target runtime environment. */,
16
- "jsx": "react" /* Specify what JSX code is generated. */,
17
- // "experimentalDecorators": true, /* Enable experimental support for TC39 stage 2 draft decorators. */
18
- // "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */
19
- // "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h' */
20
- // "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
21
- // "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using `jsx: react-jsx*`.` */
22
- // "reactNamespace": "", /* Specify the object invoked for `createElement`. This only applies when targeting `react` JSX emit. */
23
- // "noLib": true, /* Disable including any library files, including the default lib.d.ts. */
24
- // "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */
25
-
26
- /* Modules */
27
- "module": "es2022" /* Specify what module code is generated. */,
28
- // "rootDir": "./", /* Specify the root folder within your source files. */
29
- "moduleResolution": "node" /* Specify how TypeScript looks up a file from a given module specifier. */,
30
- // "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */
31
- // "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */
32
- // "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */
33
- // "typeRoots": [], /* Specify multiple folders that act like `./node_modules/@types`. */
34
- "types": ["@cloudflare/workers-types"] /* Specify type package names to be included without being referenced in a source file. */,
35
- // "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
36
- "resolveJsonModule": true /* Enable importing .json files */,
37
- // "noResolve": true, /* Disallow `import`s, `require`s or `<reference>`s from expanding the number of files TypeScript should add to a project. */
38
-
39
- /* JavaScript Support */
40
- "allowJs": true /* Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files. */,
41
- "checkJs": false /* Enable error reporting in type-checked JavaScript files. */,
42
- // "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from `node_modules`. Only applicable with `allowJs`. */
43
-
44
- /* Emit */
45
- // "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
46
- // "declarationMap": true, /* Create sourcemaps for d.ts files. */
47
- // "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */
48
- // "sourceMap": true, /* Create source map files for emitted JavaScript files. */
49
- // "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If `declaration` is true, also designates a file that bundles all .d.ts output. */
50
- // "outDir": "./", /* Specify an output folder for all emitted files. */
51
- // "removeComments": true, /* Disable emitting comments. */
52
- "noEmit": true /* Disable emitting files from a compilation. */,
53
- // "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
54
- // "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types */
55
- // "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
56
- // "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */
57
- // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
58
- // "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */
59
- // "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */
60
- // "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
61
- // "newLine": "crlf", /* Set the newline character for emitting files. */
62
- // "stripInternal": true, /* Disable emitting declarations that have `@internal` in their JSDoc comments. */
63
- // "noEmitHelpers": true, /* Disable generating custom helper functions like `__extends` in compiled output. */
64
- // "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */
65
- // "preserveConstEnums": true, /* Disable erasing `const enum` declarations in generated code. */
66
- // "declarationDir": "./", /* Specify the output directory for generated declaration files. */
67
- // "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
68
-
69
- /* Interop Constraints */
70
- "isolatedModules": true /* Ensure that each file can be safely transpiled without relying on other imports. */,
71
- "allowSyntheticDefaultImports": true /* Allow 'import x from y' when a module doesn't have a default export. */,
72
- // "esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility. */,
73
- // "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
74
- "forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,
75
-
76
- /* Type Checking */
77
- "strict": true /* Enable all strict type-checking options. */,
78
- // "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied `any` type.. */
79
- // "strictNullChecks": true, /* When type checking, take into account `null` and `undefined`. */
80
- // "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
81
- // "strictBindCallApply": true, /* Check that the arguments for `bind`, `call`, and `apply` methods match the original function. */
82
- // "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */
83
- // "noImplicitThis": true, /* Enable error reporting when `this` is given the type `any`. */
84
- // "useUnknownInCatchVariables": true, /* Type catch clause variables as 'unknown' instead of 'any'. */
85
- // "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */
86
- // "noUnusedLocals": true, /* Enable error reporting when a local variables aren't read. */
87
- // "noUnusedParameters": true, /* Raise an error when a function parameter isn't read */
88
- // "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */
89
- // "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */
90
- // "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */
91
- // "noUncheckedIndexedAccess": true, /* Include 'undefined' in index signature results */
92
- // "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */
93
- // "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type */
94
- // "allowUnusedLabels": true, /* Disable error reporting for unused labels. */
95
- // "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */
96
-
97
- /* Completeness */
98
- // "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */
99
- "skipLibCheck": true /* Skip type checking all .d.ts files. */
100
- }
5
+ /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
6
+ "target": "es2021",
7
+ /* Specify a set of bundled library declaration files that describe the target runtime environment. */
8
+ "lib": ["es2021"],
9
+ /* Specify what JSX code is generated. */
10
+ "jsx": "react-jsx",
11
+
12
+ /* Specify what module code is generated. */
13
+ "module": "es2022",
14
+ /* Specify how TypeScript looks up a file from a given module specifier. */
15
+ "moduleResolution": "Bundler",
16
+ /* Specify type package names to be included without being referenced in a source file. */
17
+ "types": ["@cloudflare/workers-types"],
18
+ /* Enable importing .json files */
19
+ "resolveJsonModule": true,
20
+
21
+ /* Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files. */
22
+ "allowJs": true,
23
+ /* Enable error reporting in type-checked JavaScript files. */
24
+ "checkJs": false,
25
+
26
+ /* Disable emitting files from a compilation. */
27
+ "noEmit": true,
28
+
29
+ /* Ensure that each file can be safely transpiled without relying on other imports. */
30
+ "isolatedModules": true,
31
+ /* Allow 'import x from y' when a module doesn't have a default export. */
32
+ "allowSyntheticDefaultImports": true,
33
+ /* Ensure that casing is correct in imports. */
34
+ "forceConsistentCasingInFileNames": true,
35
+
36
+ /* Enable all strict type-checking options. */
37
+ "strict": true,
38
+
39
+ /* Skip type checking all .d.ts files. */
40
+ "skipLibCheck": true
41
+ },
42
+ "exclude": ["test"],
43
+ "include": ["worker-configuration.d.ts", "src/**/*.ts"]
101
44
  }