create-cloudflare 0.0.0-e4ef867c → 0.0.0-e5cdd7fa

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 (101) hide show
  1. package/README.md +1 -52
  2. package/dist/cli.js +40432 -22674
  3. package/package.json +92 -73
  4. package/templates/angular/c3.ts +99 -0
  5. package/{dist/angular/templates/src/main.server.ts → templates/angular/templates/server.ts} +14 -15
  6. package/templates/angular/templates/tools/alter-polyfills.mjs +27 -0
  7. package/templates/angular/templates/tools/copy-files.mjs +9 -0
  8. package/templates/astro/c3.ts +50 -0
  9. package/templates/common/c3.ts +14 -0
  10. package/templates/common/js/__dot__gitignore +172 -0
  11. package/templates/common/js/package.json +1 -0
  12. package/templates/common/js/wrangler.toml +2 -2
  13. package/templates/common/ts/__dot__gitignore +172 -0
  14. package/templates/common/ts/package.json +1 -1
  15. package/templates/common/ts/wrangler.toml +2 -2
  16. package/templates/docusaurus/c3.ts +27 -0
  17. package/templates/gatsby/c3.ts +46 -0
  18. package/templates/hello-world/c3.ts +14 -0
  19. package/templates/hello-world/js/__dot__gitignore +172 -0
  20. package/templates/hello-world/js/package.json +1 -0
  21. package/templates/hello-world/js/wrangler.toml +2 -2
  22. package/templates/hello-world/ts/__dot__gitignore +172 -0
  23. package/templates/hello-world/ts/package.json +1 -1
  24. package/templates/hello-world/ts/wrangler.toml +2 -2
  25. package/templates/hello-world-durable-object/c3.ts +14 -0
  26. package/templates/hello-world-durable-object/js/.editorconfig +13 -0
  27. package/templates/hello-world-durable-object/js/.prettierrc +6 -0
  28. package/templates/hello-world-durable-object/js/__dot__gitignore +172 -0
  29. package/templates/hello-world-durable-object/js/package.json +13 -0
  30. package/templates/hello-world-durable-object/js/src/index.js +65 -0
  31. package/templates/hello-world-durable-object/js/wrangler.toml +51 -0
  32. package/templates/hello-world-durable-object/ts/.editorconfig +13 -0
  33. package/templates/hello-world-durable-object/ts/.prettierrc +6 -0
  34. package/templates/hello-world-durable-object/ts/__dot__gitignore +172 -0
  35. package/templates/hello-world-durable-object/ts/package.json +15 -0
  36. package/templates/hello-world-durable-object/ts/src/index.ts +78 -0
  37. package/templates/hello-world-durable-object/ts/tsconfig.json +101 -0
  38. package/templates/hello-world-durable-object/ts/wrangler.toml +51 -0
  39. package/templates/hono/c3.ts +25 -0
  40. package/templates/next/c3.ts +213 -0
  41. package/templates/next/templates.ts +281 -0
  42. package/templates/nuxt/c3.ts +59 -0
  43. package/templates/openapi/c3.ts +9 -0
  44. package/templates/openapi/ts/README.md +25 -0
  45. package/templates/openapi/ts/__dot__gitignore +171 -0
  46. package/templates/{chatgptPlugin → openapi}/ts/package.json +5 -3
  47. package/templates/openapi/ts/src/endpoints/taskCreate.ts +48 -0
  48. package/templates/openapi/ts/src/endpoints/taskDelete.ts +55 -0
  49. package/templates/openapi/ts/src/endpoints/taskFetch.ts +74 -0
  50. package/templates/openapi/ts/src/endpoints/taskList.ts +66 -0
  51. package/templates/openapi/ts/src/index.ts +29 -0
  52. package/templates/openapi/ts/src/types.ts +9 -0
  53. package/templates/openapi/ts/tsconfig.json +32 -0
  54. package/templates/pre-existing/c3.ts +83 -0
  55. package/templates/pre-existing/js/.editorconfig +13 -0
  56. package/templates/pre-existing/js/.prettierrc +6 -0
  57. package/templates/pre-existing/js/__dot__gitignore +172 -0
  58. package/templates/pre-existing/js/package.json +13 -0
  59. package/templates/pre-existing/js/wrangler.toml +3 -0
  60. package/templates/queues/c3.ts +24 -0
  61. package/templates/queues/js/__dot__gitignore +172 -0
  62. package/templates/queues/js/package.json +1 -0
  63. package/templates/queues/js/wrangler.toml +3 -3
  64. package/templates/queues/ts/__dot__gitignore +172 -0
  65. package/templates/queues/ts/package.json +1 -1
  66. package/templates/queues/ts/wrangler.toml +3 -3
  67. package/templates/qwik/c3.ts +92 -0
  68. package/templates/react/c3.ts +29 -0
  69. package/templates/remix/c3.ts +33 -0
  70. package/templates/scheduled/c3.ts +14 -0
  71. package/templates/scheduled/js/__dot__gitignore +172 -0
  72. package/templates/scheduled/js/package.json +1 -0
  73. package/templates/scheduled/js/wrangler.toml +1 -1
  74. package/templates/scheduled/ts/__dot__gitignore +172 -0
  75. package/templates/scheduled/ts/package.json +1 -1
  76. package/templates/scheduled/ts/wrangler.toml +2 -2
  77. package/templates/solid/c3.ts +37 -0
  78. package/templates/solid/js/vite.config.js +12 -0
  79. package/templates/solid/ts/vite.config.ts +12 -0
  80. package/templates/svelte/c3.ts +77 -0
  81. package/templates/svelte/templates.ts +13 -0
  82. package/templates/vue/c3.ts +27 -0
  83. package/dist/angular/templates/tools/bundle.mjs +0 -77
  84. package/dist/angular/templates/tools/copy-client-files.mjs +0 -4
  85. package/dist/angular/templates/tools/copy-worker-files.mjs +0 -10
  86. package/dist/angular/templates/tsconfig.server.json +0 -5
  87. package/templates/chatgptPlugin/ts/.assets/example.png +0 -0
  88. package/templates/chatgptPlugin/ts/README.md +0 -25
  89. package/templates/chatgptPlugin/ts/src/index.ts +0 -33
  90. package/templates/chatgptPlugin/ts/src/search.ts +0 -63
  91. /package/{dist → templates}/angular/templates/src/_routes.json +0 -0
  92. /package/{dist → templates}/angular/templates/tools/paths.mjs +0 -0
  93. /package/templates/common/js/src/{worker.js → index.js} +0 -0
  94. /package/templates/common/ts/src/{worker.ts → index.ts} +0 -0
  95. /package/templates/hello-world/js/src/{worker.js → index.js} +0 -0
  96. /package/templates/hello-world/ts/src/{worker.ts → index.ts} +0 -0
  97. /package/templates/{chatgptPlugin → openapi}/ts/wrangler.toml +0 -0
  98. /package/templates/queues/js/src/{worker.js → index.js} +0 -0
  99. /package/templates/queues/ts/src/{worker.ts → index.ts} +0 -0
  100. /package/templates/scheduled/js/src/{worker.js → index.js} +0 -0
  101. /package/templates/scheduled/ts/src/{worker.ts → index.ts} +0 -0
@@ -0,0 +1,101 @@
1
+ {
2
+ "compilerOptions": {
3
+ /* Visit https://aka.ms/tsconfig.json to read more about this file */
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
+ }
101
+ }
@@ -0,0 +1,51 @@
1
+ name = "<TBD>"
2
+ main = "src/index.ts"
3
+ compatibility_date = "<TBD>"
4
+
5
+ # Variable bindings. These are arbitrary, plaintext strings (similar to environment variables)
6
+ # Note: Use secrets to store sensitive data.
7
+ # Docs: https://developers.cloudflare.com/workers/platform/environment-variables
8
+ # [vars]
9
+ # MY_VARIABLE = "production_value"
10
+
11
+ # Bind a KV Namespace. Use KV as persistent storage for small key-value pairs.
12
+ # Docs: https://developers.cloudflare.com/workers/runtime-apis/kv
13
+ # [[kv_namespaces]]
14
+ # binding = "MY_KV_NAMESPACE"
15
+ # id = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
16
+
17
+ # Bind an R2 Bucket. Use R2 to store arbitrarily large blobs of data, such as files.
18
+ # Docs: https://developers.cloudflare.com/r2/api/workers/workers-api-usage/
19
+ # [[r2_buckets]]
20
+ # binding = "MY_BUCKET"
21
+ # bucket_name = "my-bucket"
22
+
23
+ # Bind a Queue producer. Use this binding to schedule an arbitrary task that may be processed later by a Queue consumer.
24
+ # Docs: https://developers.cloudflare.com/queues/get-started
25
+ # [[queues.producers]]
26
+ # binding = "MY_QUEUE"
27
+ # queue = "my-queue"
28
+
29
+ # Bind a Queue consumer. Queue Consumers can retrieve tasks scheduled by Producers to act on them.
30
+ # Docs: https://developers.cloudflare.com/queues/get-started
31
+ # [[queues.consumers]]
32
+ # queue = "my-queue"
33
+
34
+ # Bind another Worker service. Use this binding to call another Worker without network overhead.
35
+ # Docs: https://developers.cloudflare.com/workers/platform/services
36
+ # [[services]]
37
+ # binding = "MY_SERVICE"
38
+ # service = "my-service"
39
+
40
+ # Bind a Durable Object. Durable objects are a scale-to-zero compute primitive based on the actor model.
41
+ # Durable Objects can live for as long as needed. Use these when you need a long-running "server", such as in realtime apps.
42
+ # Docs: https://developers.cloudflare.com/workers/runtime-apis/durable-objects
43
+ [[durable_objects.bindings]]
44
+ name = "MY_DURABLE_OBJECT"
45
+ class_name = "MyDurableObject"
46
+
47
+ # Durable Object migrations.
48
+ # Docs: https://developers.cloudflare.com/workers/learning/using-durable-objects#configure-durable-object-classes-with-migrations
49
+ [[migrations]]
50
+ tag = "v1"
51
+ new_classes = ["MyDurableObject"]
@@ -0,0 +1,25 @@
1
+ import { logRaw } from "@cloudflare/cli";
2
+ import { runFrameworkGenerator } from "helpers/command";
3
+ import type { TemplateConfig } from "../../src/templates";
4
+ import type { C3Context } from "types";
5
+
6
+ const generate = async (ctx: C3Context) => {
7
+ await runFrameworkGenerator(ctx, [
8
+ ctx.project.name,
9
+ "--template",
10
+ "cloudflare-workers",
11
+ ]);
12
+
13
+ logRaw(""); // newline
14
+ };
15
+
16
+ const config: TemplateConfig = {
17
+ configVersion: 1,
18
+ id: "hono",
19
+ displayName: "Hono",
20
+ platform: "workers",
21
+ generate,
22
+ devScript: "dev",
23
+ deployScript: "deploy",
24
+ };
25
+ export default config;
@@ -0,0 +1,213 @@
1
+ import { existsSync, mkdirSync } from "fs";
2
+ import { crash, updateStatus, warn } from "@cloudflare/cli";
3
+ import { processArgument } from "@cloudflare/cli/args";
4
+ import { brandColor, dim } from "@cloudflare/cli/colors";
5
+ import { installPackages, runFrameworkGenerator } from "helpers/command";
6
+ import {
7
+ compatDateFlag,
8
+ probePaths,
9
+ readJSON,
10
+ usesEslint,
11
+ usesTypescript,
12
+ writeFile,
13
+ writeJSON,
14
+ } from "helpers/files";
15
+ import { detectPackageManager } from "helpers/packages";
16
+ import {
17
+ apiAppDirHelloJs,
18
+ apiAppDirHelloTs,
19
+ apiPagesDirHelloJs,
20
+ apiPagesDirHelloTs,
21
+ appDirNotFoundJs,
22
+ appDirNotFoundTs,
23
+ envDts,
24
+ nextConfig,
25
+ readme,
26
+ } from "./templates";
27
+ import type { TemplateConfig } from "../../src/templates";
28
+ import type { C3Args, C3Context } from "types";
29
+
30
+ const { npm, npx } = detectPackageManager();
31
+
32
+ const generate = async (ctx: C3Context) => {
33
+ const projectName = ctx.project.name;
34
+
35
+ await runFrameworkGenerator(ctx, [projectName]);
36
+ };
37
+
38
+ const getApiTemplate = (
39
+ apiPath: string,
40
+ isTypescript: boolean
41
+ ): [string, string] => {
42
+ const isAppDir = /\/app\/api$/.test(apiPath);
43
+
44
+ if (isAppDir) {
45
+ // App directory uses route handlers that are defined in a subdirectory (`/api/hello/route.ts`).
46
+ const routeHandlerPath = `${apiPath}/hello`;
47
+ mkdirSync(routeHandlerPath, { recursive: true });
48
+
49
+ return isTypescript
50
+ ? [`${routeHandlerPath}/route.ts`, apiAppDirHelloTs]
51
+ : [`${routeHandlerPath}/route.js`, apiAppDirHelloJs];
52
+ }
53
+
54
+ return isTypescript
55
+ ? [`${apiPath}/hello.ts`, apiPagesDirHelloTs]
56
+ : [`${apiPath}/hello.js`, apiPagesDirHelloJs];
57
+ };
58
+
59
+ const configure = async (ctx: C3Context) => {
60
+ const projectPath = ctx.project.path;
61
+
62
+ // Add a compatible function handler example
63
+ const path = probePaths([
64
+ `${projectPath}/pages/api`,
65
+ `${projectPath}/src/pages/api`,
66
+ `${projectPath}/src/app/api`,
67
+ `${projectPath}/app/api`,
68
+ `${projectPath}/src/app`,
69
+ `${projectPath}/app`,
70
+ ]);
71
+
72
+ if (!path) {
73
+ crash("Could not find the `/api` or `/app` directory");
74
+ }
75
+
76
+ // App directory template may not generate an API route handler, so we update the path to add an `api` directory.
77
+ const apiPath = path.replace(/\/app$/, "/app/api");
78
+
79
+ const usesTs = usesTypescript(ctx);
80
+
81
+ const appDirPath = probePaths([
82
+ `${projectPath}/src/app`,
83
+ `${projectPath}/app`,
84
+ ]);
85
+
86
+ if (appDirPath) {
87
+ // Add a custom app not-found edge route as recommended in next-on-pages
88
+ // (see: https://github.com/cloudflare/next-on-pages/blob/2b5c8f25/packages/next-on-pages/docs/gotchas.md#not-found)
89
+ const notFoundPath = `${appDirPath}/not-found.${usesTs ? "tsx" : "js"}`;
90
+ if (!existsSync(notFoundPath)) {
91
+ const notFoundContent = usesTs ? appDirNotFoundTs : appDirNotFoundJs;
92
+ writeFile(notFoundPath, notFoundContent);
93
+ updateStatus("Created a custom edge not-found route");
94
+ }
95
+ }
96
+
97
+ const [handlerPath, handlerFile] = getApiTemplate(
98
+ apiPath,
99
+ usesTypescript(ctx)
100
+ );
101
+ writeFile(handlerPath, handlerFile);
102
+ updateStatus("Created an example API route handler");
103
+
104
+ if (usesTs) {
105
+ writeFile(`${projectPath}/env.d.ts`, envDts);
106
+ updateStatus("Created an env.d.ts file");
107
+ }
108
+
109
+ const installEslintPlugin = await shouldInstallNextOnPagesEslintPlugin(ctx);
110
+
111
+ if (installEslintPlugin) {
112
+ await writeEslintrc(ctx);
113
+ }
114
+
115
+ writeFile(`${projectPath}/next.config.mjs`, nextConfig);
116
+ updateStatus("Updated the next.config.js file");
117
+
118
+ writeFile(`${projectPath}/README.md`, readme);
119
+ updateStatus("Updated the README file");
120
+
121
+ await addDevDependencies(installEslintPlugin);
122
+ };
123
+
124
+ export const shouldInstallNextOnPagesEslintPlugin = async (
125
+ ctx: C3Context
126
+ ): Promise<boolean> => {
127
+ const eslintUsage = usesEslint(ctx);
128
+
129
+ if (!eslintUsage.used) return false;
130
+
131
+ if (eslintUsage.configType !== ".eslintrc.json") {
132
+ warn(
133
+ `Expected .eslintrc.json from Next.js scaffolding but found ${eslintUsage.configType} instead`
134
+ );
135
+ return false;
136
+ }
137
+
138
+ return await processArgument(ctx.args, "eslint-plugin" as keyof C3Args, {
139
+ type: "confirm",
140
+ question: "Do you want to use the next-on-pages eslint-plugin?",
141
+ label: "eslint-plugin",
142
+ defaultValue: true,
143
+ });
144
+ };
145
+
146
+ export const writeEslintrc = async (ctx: C3Context): Promise<void> => {
147
+ const eslintConfig = readJSON(`${ctx.project.path}/.eslintrc.json`);
148
+
149
+ eslintConfig.plugins ??= [];
150
+ eslintConfig.plugins.push("eslint-plugin-next-on-pages");
151
+
152
+ if (typeof eslintConfig.extends === "string") {
153
+ eslintConfig.extends = [eslintConfig.extends];
154
+ }
155
+ eslintConfig.extends ??= [];
156
+ eslintConfig.extends.push("plugin:eslint-plugin-next-on-pages/recommended");
157
+
158
+ writeJSON(`${ctx.project.path}/.eslintrc.json`, eslintConfig);
159
+ };
160
+
161
+ const addDevDependencies = async (installEslintPlugin: boolean) => {
162
+ const packages = [
163
+ "@cloudflare/next-on-pages@1",
164
+ "@cloudflare/workers-types",
165
+ "vercel",
166
+ ...(installEslintPlugin ? ["eslint-plugin-next-on-pages"] : []),
167
+ ];
168
+ await installPackages(packages, {
169
+ dev: true,
170
+ startText: "Adding the Cloudflare Pages adapter",
171
+ doneText: `${brandColor(`installed`)} ${dim(packages.join(", "))}`,
172
+ });
173
+ };
174
+
175
+ export default {
176
+ configVersion: 1,
177
+ id: "next",
178
+ platform: "pages",
179
+ displayName: "Next",
180
+ devScript: "dev",
181
+ previewScript: "pages:preview",
182
+ generate,
183
+ configure,
184
+ transformPackageJson: async () => {
185
+ const isNpm = npm === "npm";
186
+ const isBun = npm === "bun";
187
+ const isNpmOrBun = isNpm || isBun;
188
+ const nextOnPagesScope = isNpmOrBun ? "@cloudflare/" : "";
189
+ const nextOnPagesCommand = `${nextOnPagesScope}next-on-pages`;
190
+ const pmCommand = isNpmOrBun ? npx : npm;
191
+ const pagesBuildRunCommand = `${
192
+ isNpm ? "npm run" : isBun ? "bun" : pmCommand
193
+ } pages:build`;
194
+ return {
195
+ scripts: {
196
+ "pages:build": `${pmCommand} ${nextOnPagesCommand}`,
197
+ "pages:preview": `${pagesBuildRunCommand} && wrangler pages dev .vercel/output/static ${await compatDateFlag()} --compatibility-flag=nodejs_compat`,
198
+ "pages:deploy": `${pagesBuildRunCommand} && wrangler pages deploy .vercel/output/static`,
199
+ },
200
+ };
201
+ },
202
+ testFlags: [
203
+ "--typescript",
204
+ "--no-install",
205
+ "--eslint",
206
+ "--tailwind",
207
+ "--src-dir",
208
+ "--app",
209
+ "--import-alias",
210
+ "@/*",
211
+ ],
212
+ compatibilityFlags: ["nodejs_compat"],
213
+ } as TemplateConfig;
@@ -0,0 +1,281 @@
1
+ const handlerCode = ` let responseText = 'Hello World'
2
+
3
+ // In the edge runtime you can use Bindings that are available in your application
4
+ // (for more details see:
5
+ // - https://developers.cloudflare.com/pages/framework-guides/deploy-a-nextjs-site/#use-bindings-in-your-nextjs-application
6
+ // - https://developers.cloudflare.com/pages/functions/bindings/
7
+ // )
8
+ //
9
+ // KV Example:
10
+ // const myKv = process.env.MY_KV
11
+ // await myKv.put('suffix', ' from a KV store!')
12
+ // const suffix = await myKv.get('suffix')
13
+ // responseText += suffix
14
+
15
+ return new Response(responseText)`;
16
+
17
+ export const apiPagesDirHelloTs = `// Next.js Edge API Routes: https://nextjs.org/docs/pages/building-your-application/routing/api-routes#edge-api-routes
18
+
19
+ import type { NextRequest } from 'next/server'
20
+
21
+ export const config = {
22
+ runtime: 'edge',
23
+ }
24
+
25
+ export default async function handler(req: NextRequest) {
26
+ ${handlerCode}
27
+ }
28
+ `;
29
+
30
+ export const apiPagesDirHelloJs = `// Next.js Edge API Routes: https://nextjs.org/docs/pages/building-your-application/routing/api-routes#edge-api-routes
31
+
32
+ export const config = {
33
+ runtime: 'edge',
34
+ }
35
+
36
+ export default async function handler(req) {
37
+ ${handlerCode}
38
+ }
39
+ `;
40
+
41
+ export const apiAppDirHelloTs = `// Next.js Edge API Route Handlers: https://nextjs.org/docs/app/building-your-application/routing/router-handlers#edge-and-nodejs-runtimes
42
+
43
+ import type { NextRequest } from 'next/server'
44
+
45
+ export const runtime = 'edge'
46
+
47
+ export async function GET(request: NextRequest) {
48
+ ${handlerCode}
49
+ }
50
+ `;
51
+
52
+ export const apiAppDirHelloJs = `// Next.js Edge API Route Handlers: https://nextjs.org/docs/app/building-your-application/routing/router-handlers#edge-and-nodejs-runtimes
53
+
54
+ export const runtime = 'edge'
55
+
56
+ export async function GET(request) {
57
+ ${handlerCode}
58
+ }
59
+ `;
60
+
61
+ // Simplified and adjusted version of the Next.js built-in not-found component (https://github.com/vercel/next.js/blob/1c65c5575/packages/next/src/client/components/not-found-error.tsx)
62
+ export const appDirNotFoundJs = `export const runtime = "edge";
63
+
64
+ export default function NotFound() {
65
+ return (
66
+ <>
67
+ <title>404: This page could not be found.</title>
68
+ <div style={styles.error}>
69
+ <div>
70
+ <style
71
+ dangerouslySetInnerHTML={{
72
+ __html: \`body{color:#000;background:#fff;margin:0}.next-error-h1{border-right:1px solid rgba(0,0,0,.3)}@media (prefers-color-scheme:dark){body{color:#fff;background:#000}.next-error-h1{border-right:1px solid rgba(255,255,255,.3)}}\`,
73
+ }}
74
+ />
75
+ <h1 className="next-error-h1" style={styles.h1}>
76
+ 404
77
+ </h1>
78
+ <div style={styles.desc}>
79
+ <h2 style={styles.h2}>This page could not be found.</h2>
80
+ </div>
81
+ </div>
82
+ </div>
83
+ </>
84
+ );
85
+ }
86
+
87
+ const styles = {
88
+ error: {
89
+ fontFamily:
90
+ 'system-ui,"Segoe UI",Roboto,Helvetica,Arial,sans-serif,"Apple Color Emoji","Segoe UI Emoji"',
91
+ height: "100vh",
92
+ textAlign: "center",
93
+ display: "flex",
94
+ flexDirection: "column",
95
+ alignItems: "center",
96
+ justifyContent: "center",
97
+ },
98
+
99
+ desc: {
100
+ display: "inline-block",
101
+ },
102
+
103
+ h1: {
104
+ display: "inline-block",
105
+ margin: "0 20px 0 0",
106
+ padding: "0 23px 0 0",
107
+ fontSize: 24,
108
+ fontWeight: 500,
109
+ verticalAlign: "top",
110
+ lineHeight: "49px",
111
+ },
112
+
113
+ h2: {
114
+ fontSize: 14,
115
+ fontWeight: 400,
116
+ lineHeight: "49px",
117
+ margin: 0,
118
+ },
119
+ };
120
+ `;
121
+
122
+ // Simplified and adjusted version of the Next.js built-in not-found component (https://github.com/vercel/next.js/blob/1c65c5575/packages/next/src/client/components/not-found-error.tsx)
123
+ export const appDirNotFoundTs = `export const runtime = "edge";
124
+
125
+ export default function NotFound() {
126
+ return (
127
+ <>
128
+ <title>404: This page could not be found.</title>
129
+ <div style={styles.error}>
130
+ <div>
131
+ <style
132
+ dangerouslySetInnerHTML={{
133
+ __html: \`body{color:#000;background:#fff;margin:0}.next-error-h1{border-right:1px solid rgba(0,0,0,.3)}@media (prefers-color-scheme:dark){body{color:#fff;background:#000}.next-error-h1{border-right:1px solid rgba(255,255,255,.3)}}\`,
134
+ }}
135
+ />
136
+ <h1 className="next-error-h1" style={styles.h1}>
137
+ 404
138
+ </h1>
139
+ <div style={styles.desc}>
140
+ <h2 style={styles.h2}>This page could not be found.</h2>
141
+ </div>
142
+ </div>
143
+ </div>
144
+ </>
145
+ );
146
+ }
147
+
148
+ const styles = {
149
+ error: {
150
+ fontFamily:
151
+ 'system-ui,"Segoe UI",Roboto,Helvetica,Arial,sans-serif,"Apple Color Emoji","Segoe UI Emoji"',
152
+ height: "100vh",
153
+ textAlign: "center",
154
+ display: "flex",
155
+ flexDirection: "column",
156
+ alignItems: "center",
157
+ justifyContent: "center",
158
+ },
159
+
160
+ desc: {
161
+ display: "inline-block",
162
+ },
163
+
164
+ h1: {
165
+ display: "inline-block",
166
+ margin: "0 20px 0 0",
167
+ padding: "0 23px 0 0",
168
+ fontSize: 24,
169
+ fontWeight: 500,
170
+ verticalAlign: "top",
171
+ lineHeight: "49px",
172
+ },
173
+
174
+ h2: {
175
+ fontSize: 14,
176
+ fontWeight: 400,
177
+ lineHeight: "49px",
178
+ margin: 0,
179
+ },
180
+ } as const;
181
+ `;
182
+
183
+ export const nextConfig = `import { setupDevBindings } from '@cloudflare/next-on-pages/next-dev';
184
+
185
+ /** @type {import('next').NextConfig} */
186
+ const nextConfig = {};
187
+
188
+ // Here we use the @cloudflare/next-on-pages next-dev module to allow us to use bindings during local development
189
+ // (when running the application with \`next dev\`), for more information see:
190
+ // https://github.com/cloudflare/next-on-pages/blob/8e93067/internal-packages/next-dev/README.md
191
+ if (process.env.NODE_ENV === 'development') {
192
+ await setupDevBindings({
193
+ bindings: {
194
+ // Add here the Cloudflare Bindings you want to have available during local development,
195
+ // for more details on Bindings see: https://developers.cloudflare.com/pages/functions/bindings/)
196
+ //
197
+ // KV Example:
198
+ // MY_KV: {
199
+ // type: 'kv',
200
+ // id: 'xxx',
201
+ // }
202
+ }
203
+ });
204
+ }
205
+
206
+ export default nextConfig;
207
+ `;
208
+
209
+ export const envDts = `declare global {
210
+ namespace NodeJS {
211
+ interface ProcessEnv {
212
+ // Add here the Cloudflare Bindings you want to have available in your application
213
+ // (for more details on Bindings see: https://developers.cloudflare.com/pages/functions/bindings/)
214
+ //
215
+ // KV Example:
216
+ // MY_KV: KVNamespace
217
+ }
218
+ }
219
+ }
220
+
221
+ export {}
222
+ `;
223
+
224
+ export const readme = `This is a [Next.js](https://nextjs.org/) project bootstrapped with [\`c3\`](https://developers.cloudflare.com/pages/get-started/c3).
225
+
226
+ ## Getting Started
227
+
228
+ First, run the development server:
229
+
230
+ \`\`\`bash
231
+ npm run dev
232
+ # or
233
+ yarn dev
234
+ # or
235
+ pnpm dev
236
+ # or
237
+ bun dev
238
+ \`\`\`
239
+
240
+ Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
241
+
242
+ ## Cloudflare integration
243
+
244
+ Besides the \`dev\` script mentioned above \`c3\` has added a few extra scripts that allow you to integrate the application with the [Cloudflare Pages](https://pages.cloudflare.com/) environment, these are:
245
+ - \`pages:build\` to build the application for Pages using the [\`@cloudflare/next-on-pages\`](https://github.com/cloudflare/next-on-pages) CLI
246
+ - \`pages:preview\` to locally preview your Pages application using the [Wrangler](https://developers.cloudflare.com/workers/wrangler/) CLI
247
+ - \`pages:deploy\` to deploy your Pages application using the [Wrangler](https://developers.cloudflare.com/workers/wrangler/) CLI
248
+
249
+ > __Note:__ while the \`dev\` script is optimal for local development you should preview your Pages application as well (periodically or before deployments) in order to make sure that it can properly work in the Pages environment (for more details see the [\`@cloudflare/next-on-pages\` recommended workflow](https://github.com/cloudflare/next-on-pages/blob/05b6256/internal-packages/next-dev/README.md#recommended-workflow))
250
+
251
+ ### Bindings
252
+
253
+ Cloudflare [Bindings](https://developers.cloudflare.com/pages/functions/bindings/) are what allows you to interact with resources available in the Cloudflare Platform.
254
+
255
+ You can use bindings during development, when previewing locally your application and of course in the deployed application:
256
+
257
+ - To use bindings in dev mode you need to define them in the \`next.config.js\` file under \`setupDevBindings\`, this mode uses the \`next-dev\` \`@cloudflare/next-on-pages\` submodule. For more details see its [documentation](https://github.com/cloudflare/next-on-pages/blob/05b6256/internal-packages/next-dev/README.md).
258
+
259
+ - To use bindings in the preview mode you need to add them to the \`pages:preview\` script accordingly to the \`wrangler pages dev\` command. For more details see its [documentation](https://developers.cloudflare.com/workers/wrangler/commands/#dev-1) or the [Pages Bindings documentation](https://developers.cloudflare.com/pages/functions/bindings/).
260
+
261
+ - To use bindings in the deployed application you will need to configure them in the Cloudflare [dashboard](https://dash.cloudflare.com/). For more details see the [Pages Bindings documentation](https://developers.cloudflare.com/pages/functions/bindings/).
262
+
263
+ #### KV Example
264
+
265
+ \`c3\` has added for you an example showing how you can use a KV binding, in order to enable the example, search for lines containing the following comment:
266
+ \`\`\`ts
267
+ // KV Example:
268
+ \`\`\`
269
+
270
+ and uncomment the commented lines below it.
271
+
272
+ After doing this you can run the \`dev\` script and visit the \`/api/hello\` route to see the example in action.
273
+
274
+ To then enable such example also in preview mode add a \`kv\` in the \`pages:preview\` script like so:
275
+ \`\`\`diff
276
+ - "pages:preview": "npm run pages:build && wrangler pages dev .vercel/output/static --compatibility-date=2023-12-18 --compatibility-flag=nodejs_compat",
277
+ + "pages:preview": "npm run pages:build && wrangler pages dev .vercel/output/static --compatibility-date=2023-12-18 --compatibility-flag=nodejs_compat --kv MY_KV",
278
+ \`\`\`
279
+
280
+ Finally, if you also want to see the example work in the deployed application make sure to add a \`MY_KV\` binding to your Pages application in its [dashboard kv bindings settings section](https://dash.cloudflare.com/?to=/:account/pages/view/:pages-project/settings/functions#kv_namespace_bindings_section). After having configured it make sure to re-deploy your application.
281
+ `;