wrangler 0.0.0-e9e9872 → 0.0.0-e9f8a2fa

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 (178) hide show
  1. package/README.md +25 -13
  2. package/bin/wrangler.js +51 -61
  3. package/config-schema.json +2939 -0
  4. package/package.json +222 -160
  5. package/templates/__tests__/pages-dev-util.test.ts +128 -0
  6. package/templates/__tests__/tsconfig-sanity.ts +12 -0
  7. package/templates/__tests__/tsconfig.json +8 -0
  8. package/templates/checked-fetch.js +19 -6
  9. package/templates/facade.d.ts +19 -0
  10. package/templates/gitignore +0 -4
  11. package/templates/init-tests/test-jest-new-worker.js +23 -0
  12. package/templates/init-tests/test-vitest-new-worker.js +24 -0
  13. package/templates/init-tests/test-vitest-new-worker.ts +25 -0
  14. package/templates/middleware/common.ts +67 -0
  15. package/templates/middleware/loader-modules.ts +133 -0
  16. package/templates/middleware/loader-sw.ts +229 -0
  17. package/templates/middleware/middleware-ensure-req-body-drained.ts +18 -0
  18. package/templates/middleware/middleware-miniflare3-json-error.ts +32 -0
  19. package/templates/middleware/middleware-pretty-error.ts +40 -0
  20. package/templates/middleware/middleware-scheduled.ts +15 -0
  21. package/templates/middleware/middleware-serve-static-assets.d.ts +6 -0
  22. package/templates/middleware/middleware-serve-static-assets.ts +56 -0
  23. package/templates/modules-watch-stub.js +4 -0
  24. package/templates/new-worker-scheduled.ts +1 -1
  25. package/templates/new-worker.js +1 -1
  26. package/templates/new-worker.ts +4 -1
  27. package/templates/pages-dev-pipeline.ts +32 -0
  28. package/templates/pages-dev-util.ts +55 -0
  29. package/templates/pages-shim.ts +9 -0
  30. package/templates/pages-template-plugin.ts +53 -18
  31. package/templates/pages-template-worker.ts +49 -12
  32. package/templates/startDevWorker/InspectorProxyWorker.ts +664 -0
  33. package/templates/startDevWorker/ProxyWorker.ts +334 -0
  34. package/templates/tsconfig-sanity.ts +11 -0
  35. package/templates/tsconfig.init.json +105 -0
  36. package/templates/tsconfig.json +5 -102
  37. package/wrangler-dist/InspectorProxyWorker.js +464 -0
  38. package/wrangler-dist/InspectorProxyWorker.js.map +6 -0
  39. package/wrangler-dist/ProxyWorker.js +240 -0
  40. package/wrangler-dist/ProxyWorker.js.map +6 -0
  41. package/wrangler-dist/cli.d.ts +23879 -146
  42. package/wrangler-dist/cli.js +186358 -107113
  43. package/wrangler-dist/wasm-sync.wasm +0 -0
  44. package/import_meta_url.js +0 -3
  45. package/miniflare-config-stubs/.env.empty +0 -0
  46. package/miniflare-config-stubs/package.empty.json +0 -1
  47. package/miniflare-config-stubs/wrangler.empty.toml +0 -0
  48. package/miniflare-dist/index.mjs +0 -4894
  49. package/src/__tests__/config-cache-without-cache-dir.test.ts +0 -38
  50. package/src/__tests__/config-cache.test.ts +0 -42
  51. package/src/__tests__/configuration.test.ts +0 -3946
  52. package/src/__tests__/dev.test.tsx +0 -1159
  53. package/src/__tests__/guess-worker-format.test.ts +0 -85
  54. package/src/__tests__/helpers/clipboardy-mock.js +0 -4
  55. package/src/__tests__/helpers/cmd-shim.d.ts +0 -11
  56. package/src/__tests__/helpers/mock-account-id.ts +0 -48
  57. package/src/__tests__/helpers/mock-bin.ts +0 -36
  58. package/src/__tests__/helpers/mock-cfetch.ts +0 -211
  59. package/src/__tests__/helpers/mock-console.ts +0 -97
  60. package/src/__tests__/helpers/mock-dialogs.ts +0 -153
  61. package/src/__tests__/helpers/mock-http-server.ts +0 -46
  62. package/src/__tests__/helpers/mock-istty.ts +0 -74
  63. package/src/__tests__/helpers/mock-kv.ts +0 -33
  64. package/src/__tests__/helpers/mock-oauth-flow.ts +0 -250
  65. package/src/__tests__/helpers/mock-process.ts +0 -39
  66. package/src/__tests__/helpers/mock-stdin.ts +0 -108
  67. package/src/__tests__/helpers/mock-web-socket.ts +0 -29
  68. package/src/__tests__/helpers/run-in-tmp.ts +0 -38
  69. package/src/__tests__/helpers/run-wrangler.ts +0 -16
  70. package/src/__tests__/helpers/write-worker-source.ts +0 -31
  71. package/src/__tests__/helpers/write-wrangler-toml.ts +0 -17
  72. package/src/__tests__/https-options.test.ts +0 -163
  73. package/src/__tests__/index.test.ts +0 -262
  74. package/src/__tests__/init.test.ts +0 -1992
  75. package/src/__tests__/jest.setup.ts +0 -120
  76. package/src/__tests__/kv.test.ts +0 -1650
  77. package/src/__tests__/logger.test.ts +0 -141
  78. package/src/__tests__/package-manager.test.ts +0 -353
  79. package/src/__tests__/pages.test.ts +0 -1254
  80. package/src/__tests__/parse.test.ts +0 -330
  81. package/src/__tests__/publish.test.ts +0 -6595
  82. package/src/__tests__/pubsub.test.ts +0 -367
  83. package/src/__tests__/r2.test.ts +0 -233
  84. package/src/__tests__/route.test.ts +0 -45
  85. package/src/__tests__/secret.test.ts +0 -492
  86. package/src/__tests__/tail.test.ts +0 -698
  87. package/src/__tests__/user.test.ts +0 -143
  88. package/src/__tests__/whoami.test.tsx +0 -230
  89. package/src/__tests__/worker-namespace.test.ts +0 -327
  90. package/src/abort.d.ts +0 -3
  91. package/src/api/dev.ts +0 -52
  92. package/src/api/index.ts +0 -1
  93. package/src/bundle-reporter.tsx +0 -29
  94. package/src/bundle.ts +0 -212
  95. package/src/cfetch/index.ts +0 -121
  96. package/src/cfetch/internal.ts +0 -149
  97. package/src/cli.ts +0 -27
  98. package/src/config/README.md +0 -107
  99. package/src/config/config.ts +0 -243
  100. package/src/config/diagnostics.ts +0 -80
  101. package/src/config/environment.ts +0 -453
  102. package/src/config/index.ts +0 -238
  103. package/src/config/validation-helpers.ts +0 -584
  104. package/src/config/validation.ts +0 -1745
  105. package/src/config-cache.ts +0 -83
  106. package/src/create-worker-preview.ts +0 -255
  107. package/src/create-worker-upload-form.ts +0 -263
  108. package/src/dev/dev-vars.ts +0 -36
  109. package/src/dev/dev.tsx +0 -417
  110. package/src/dev/local.tsx +0 -354
  111. package/src/dev/remote.tsx +0 -382
  112. package/src/dev/use-esbuild.ts +0 -150
  113. package/src/dev.tsx +0 -538
  114. package/src/dialogs.tsx +0 -135
  115. package/src/durable.ts +0 -102
  116. package/src/entry.ts +0 -328
  117. package/src/environment-variables.ts +0 -35
  118. package/src/errors.ts +0 -11
  119. package/src/faye-websocket.d.ts +0 -6
  120. package/src/generate.ts +0 -33
  121. package/src/git-client.ts +0 -42
  122. package/src/global-wrangler-config-path.ts +0 -26
  123. package/src/https-options.ts +0 -127
  124. package/src/index.tsx +0 -1896
  125. package/src/init.ts +0 -549
  126. package/src/inspect.ts +0 -662
  127. package/src/intl-polyfill.d.ts +0 -139
  128. package/src/is-interactive.ts +0 -12
  129. package/src/kv.ts +0 -430
  130. package/src/logger.ts +0 -73
  131. package/src/miniflare-cli/README.md +0 -30
  132. package/src/miniflare-cli/enum-keys.ts +0 -17
  133. package/src/miniflare-cli/index.ts +0 -53
  134. package/src/miniflare-cli/request-context.ts +0 -40
  135. package/src/module-collection.ts +0 -258
  136. package/src/open-in-browser.ts +0 -17
  137. package/src/package-manager.ts +0 -219
  138. package/src/pages/build.tsx +0 -202
  139. package/src/pages/constants.ts +0 -7
  140. package/src/pages/deployments.tsx +0 -101
  141. package/src/pages/dev.tsx +0 -964
  142. package/src/pages/functions/buildPlugin.ts +0 -105
  143. package/src/pages/functions/buildWorker.ts +0 -151
  144. package/src/pages/functions/filepath-routing.test.ts +0 -234
  145. package/src/pages/functions/filepath-routing.ts +0 -189
  146. package/src/pages/functions/identifiers.ts +0 -78
  147. package/src/pages/functions/routes.ts +0 -151
  148. package/src/pages/index.tsx +0 -84
  149. package/src/pages/projects.tsx +0 -157
  150. package/src/pages/publish.tsx +0 -335
  151. package/src/pages/types.ts +0 -40
  152. package/src/pages/upload.tsx +0 -396
  153. package/src/pages/utils.ts +0 -12
  154. package/src/parse.ts +0 -286
  155. package/src/paths.ts +0 -26
  156. package/src/preview.ts +0 -31
  157. package/src/proxy.ts +0 -476
  158. package/src/publish.ts +0 -780
  159. package/src/pubsub/index.ts +0 -286
  160. package/src/pubsub/pubsub-commands.tsx +0 -577
  161. package/src/r2.ts +0 -50
  162. package/src/selfsigned.d.ts +0 -29
  163. package/src/sites.tsx +0 -372
  164. package/src/tail/filters.ts +0 -279
  165. package/src/tail/index.ts +0 -299
  166. package/src/tail/printing.ts +0 -67
  167. package/src/update-check.ts +0 -19
  168. package/src/user/choose-account.tsx +0 -60
  169. package/src/user/env-vars.ts +0 -46
  170. package/src/user/generate-auth-url.ts +0 -33
  171. package/src/user/generate-random-state.ts +0 -16
  172. package/src/user/index.ts +0 -3
  173. package/src/user/user.tsx +0 -1170
  174. package/src/whoami.tsx +0 -90
  175. package/src/worker-namespace.ts +0 -190
  176. package/src/worker.ts +0 -191
  177. package/src/zones.ts +0 -76
  178. package/templates/static-asset-facade.js +0 -49
@@ -1,53 +0,0 @@
1
- import { Log, LogLevel, Miniflare } from "miniflare";
2
- import yargs from "yargs";
3
- import { hideBin } from "yargs/helpers";
4
- import { enumKeys } from "./enum-keys";
5
- import { getRequestContextCheckOptions } from "./request-context";
6
-
7
- // miniflare defines this but importing it throws:
8
- // Dynamic require of "path" is not supported
9
- class NoOpLog extends Log {
10
- log(): void {}
11
-
12
- error(message: Error): void {
13
- throw message;
14
- }
15
- }
16
-
17
- async function main() {
18
- const args = await yargs(hideBin(process.argv))
19
- .help(false)
20
- .version(false)
21
- .option("log", {
22
- choices: enumKeys(LogLevel),
23
- }).argv;
24
-
25
- const logLevel = LogLevel[args.log ?? "INFO"];
26
- const requestContextCheckOptions = await getRequestContextCheckOptions();
27
- const config = {
28
- ...JSON.parse((args._[0] as string) ?? "{}"),
29
- ...requestContextCheckOptions,
30
- };
31
- //miniflare's logLevel 0 still logs routes, so lets override the logger
32
- config.log = config.disableLogs ? new NoOpLog() : new Log(logLevel);
33
-
34
- if (logLevel > LogLevel.INFO) {
35
- console.log("OPTIONS:\n", JSON.stringify(config, null, 2));
36
- }
37
-
38
- const mf = new Miniflare(config);
39
-
40
- try {
41
- // Start Miniflare development server
42
- await mf.startServer();
43
- await mf.startScheduler();
44
- process.send && process.send("ready");
45
- } catch (e) {
46
- mf.log.error(e as Error);
47
- process.exitCode = 1;
48
- // Unmount any mounted workers
49
- await mf.dispose();
50
- }
51
- }
52
-
53
- await main();
@@ -1,40 +0,0 @@
1
- import type { MiniflareOptions } from "miniflare";
2
-
3
- /**
4
- * Certain runtime APIs are only available to workers during the "request context",
5
- * which is any code that returns after receiving a request and before returning
6
- * a response.
7
- *
8
- * Miniflare emulates this behavior by using an [`AsyncLocalStorage`](https://nodejs.org/api/async_context.html#class-asynclocalstorage) and
9
- * [checking at runtime](https://github.com/cloudflare/miniflare/blob/master/packages/shared/src/context.ts#L21-L36)
10
- * to see if you're using those APIs during the request context.
11
- *
12
- * In certain environments `AsyncLocalStorage` is unavailable, such as in a
13
- * [webcontainer](https://github.com/stackblitz/webcontainer-core).
14
- * This function figures out if we're able to run those "request context" checks
15
- * and returns [a set of options](https://miniflare.dev/core/standards#global-functionality-limits)
16
- * that indicate to miniflare whether to run the checks or not.
17
- */
18
- export const getRequestContextCheckOptions = async (): Promise<
19
- Pick<MiniflareOptions, "globalAsyncIO" | "globalTimers" | "globalRandom">
20
- > => {
21
- // check that there's an implementation of AsyncLocalStorage
22
- let hasAsyncLocalStorage = true;
23
- try {
24
- // ripped from the example here https://nodejs.org/api/async_context.html#class-asynclocalstorage
25
- const { AsyncLocalStorage } = await import("node:async_hooks");
26
- const storage = new AsyncLocalStorage<string>();
27
-
28
- hasAsyncLocalStorage = storage.run("some-value", () => {
29
- return storage.getStore() === "some-value";
30
- });
31
- } catch (e) {
32
- hasAsyncLocalStorage = false;
33
- }
34
-
35
- return {
36
- globalAsyncIO: hasAsyncLocalStorage,
37
- globalRandom: hasAsyncLocalStorage,
38
- globalTimers: hasAsyncLocalStorage,
39
- };
40
- };
@@ -1,258 +0,0 @@
1
- import crypto from "node:crypto";
2
- import { readFile } from "node:fs/promises";
3
- import path from "node:path";
4
- import globToRegExp from "glob-to-regexp";
5
- import { logger } from "./logger";
6
- import type { Config, ConfigModuleRuleType } from "./config";
7
- import type { CfModule, CfModuleType, CfScriptFormat } from "./worker";
8
- import type esbuild from "esbuild";
9
-
10
- const RuleTypeToModuleType: Record<ConfigModuleRuleType, CfModuleType> = {
11
- ESModule: "esm",
12
- CommonJS: "commonjs",
13
- CompiledWasm: "compiled-wasm",
14
- Data: "buffer",
15
- Text: "text",
16
- };
17
-
18
- // This is a combination of an esbuild plugin and a mutable array
19
- // that we use to collect module references from source code.
20
- // There will be modules that _shouldn't_ be inlined directly into
21
- // the bundle. (eg. wasm modules, some text files, etc). We can include
22
- // those files as modules in the multi part worker form upload. This
23
- // plugin+array is used to collect references to these modules, reference
24
- // them correctly in the bundle, and add them to the form upload.
25
-
26
- export const DEFAULT_MODULE_RULES: Config["rules"] = [
27
- { type: "Text", globs: ["**/*.txt", "**/*.html"] },
28
- { type: "Data", globs: ["**/*.bin"] },
29
- { type: "CompiledWasm", globs: ["**/*.wasm"] },
30
- ];
31
-
32
- export default function createModuleCollector(props: {
33
- format: CfScriptFormat;
34
- rules?: Config["rules"];
35
- // a collection of "legacy" style module references, which are just file names
36
- // we will eventually deprecate this functionality, hence the verbose greppable name
37
- wrangler1xlegacyModuleReferences: {
38
- rootDirectory: string;
39
- fileNames: Set<string>;
40
- };
41
- }): {
42
- modules: CfModule[];
43
- plugin: esbuild.Plugin;
44
- } {
45
- const rules: Config["rules"] = [
46
- ...(props.rules || []),
47
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
48
- ...DEFAULT_MODULE_RULES!,
49
- ];
50
-
51
- // First, we want to add some validations to the module rules
52
- // We want to warn if rules are accidentally configured in such a way that
53
- // subsequent rules will never match because `fallthrough` hasn't been set
54
-
55
- const completedRuleLocations: Record<string, number> = {};
56
- let index = 0;
57
- const rulesToRemove: Config["rules"] = [];
58
- for (const rule of rules) {
59
- if (rule.type in completedRuleLocations) {
60
- if (rules[completedRuleLocations[rule.type]].fallthrough !== false) {
61
- if (index < (props.rules || []).length) {
62
- logger.warn(
63
- `The module rule at position ${index} (${JSON.stringify(
64
- rule
65
- )}) has the same type as a previous rule (at position ${
66
- completedRuleLocations[rule.type]
67
- }, ${JSON.stringify(
68
- rules[completedRuleLocations[rule.type]]
69
- )}). This rule will be ignored. To the previous rule, add \`fallthrough = true\` to allow this one to also be used, or \`fallthrough = false\` to silence this warning.`
70
- );
71
- } else {
72
- logger.warn(
73
- `The default module rule ${JSON.stringify(
74
- rule
75
- )} has the same type as a previous rule (at position ${
76
- completedRuleLocations[rule.type]
77
- }, ${JSON.stringify(
78
- rules[completedRuleLocations[rule.type]]
79
- )}). This rule will be ignored. To the previous rule, add \`fallthrough = true\` to allow the default one to also be used, or \`fallthrough = false\` to silence this warning.`
80
- );
81
- }
82
- }
83
-
84
- rulesToRemove.push(rule);
85
- }
86
- if (!(rule.type in completedRuleLocations) && rule.fallthrough !== true) {
87
- completedRuleLocations[rule.type] = index;
88
- }
89
- index++;
90
- }
91
-
92
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
93
- rulesToRemove.forEach((rule) => rules!.splice(rules!.indexOf(rule), 1));
94
-
95
- const modules: CfModule[] = [];
96
- return {
97
- modules,
98
- plugin: {
99
- name: "wrangler-module-collector",
100
- setup(build) {
101
- build.onStart(() => {
102
- // reset the module collection array
103
- modules.splice(0);
104
- });
105
-
106
- // ~ start legacy module specifier support ~
107
-
108
- // This section detects usage of "legacy" 1.x style module specifiers
109
- // and modifies them so they "work" in wrangler v2, but with a warning
110
-
111
- const rulesMatchers = rules.flatMap((rule) => {
112
- return rule.globs.map((glob) => {
113
- const regex = globToRegExp(glob);
114
- return {
115
- regex,
116
- rule,
117
- };
118
- });
119
- });
120
-
121
- if (props.wrangler1xlegacyModuleReferences.fileNames.size > 0) {
122
- build.onResolve(
123
- {
124
- filter: new RegExp(
125
- "^(" +
126
- [...props.wrangler1xlegacyModuleReferences.fileNames].join(
127
- "|"
128
- ) +
129
- ")$"
130
- ),
131
- },
132
- async (args: esbuild.OnResolveArgs) => {
133
- if (
134
- args.kind !== "import-statement" &&
135
- args.kind !== "require-call"
136
- ) {
137
- return;
138
- }
139
- // In the future, this will simply throw an error
140
- logger.warn(
141
- `Deprecation: detected a legacy module import in "./${path.relative(
142
- process.cwd(),
143
- args.importer
144
- )}". This will stop working in the future. Replace references to "${
145
- args.path
146
- }" with "./${args.path}";`
147
- );
148
-
149
- // take the file and massage it to a
150
- // transportable/manageable format
151
- const filePath = path.join(
152
- props.wrangler1xlegacyModuleReferences.rootDirectory,
153
- args.path
154
- );
155
- const fileContent = await readFile(filePath);
156
- const fileHash = crypto
157
- .createHash("sha1")
158
- .update(fileContent)
159
- .digest("hex");
160
- const fileName = `./${fileHash}-${path.basename(args.path)}`;
161
-
162
- const { rule } =
163
- rulesMatchers.find(({ regex }) => regex.test(fileName)) || {};
164
- if (rule) {
165
- // add the module to the array
166
- modules.push({
167
- name: fileName,
168
- content: fileContent,
169
- type: RuleTypeToModuleType[rule.type],
170
- });
171
- return {
172
- path: fileName, // change the reference to the changed module
173
- external: props.format === "modules", // mark it as external in the bundle
174
- namespace: `wrangler-module-${rule.type}`, // just a tag, this isn't strictly necessary
175
- watchFiles: [filePath], // we also add the file to esbuild's watch list
176
- };
177
- }
178
- }
179
- );
180
- }
181
-
182
- // ~ end legacy module specifier support ~
183
-
184
- rules?.forEach((rule) => {
185
- if (rule.type === "ESModule" || rule.type === "CommonJS") return; // TODO: we should treat these as js files, and use the jsx loader
186
-
187
- rule.globs.forEach((glob) => {
188
- build.onResolve(
189
- { filter: globToRegExp(glob) },
190
- async (args: esbuild.OnResolveArgs) => {
191
- // take the file and massage it to a
192
- // transportable/manageable format
193
-
194
- const filePath = path.join(args.resolveDir, args.path);
195
- const fileContent = await readFile(filePath);
196
- const fileHash = crypto
197
- .createHash("sha1")
198
- .update(fileContent)
199
- .digest("hex");
200
- const fileName = `./${fileHash}-${path.basename(args.path)}`;
201
-
202
- // add the module to the array
203
- modules.push({
204
- name: fileName,
205
- content: fileContent,
206
- type: RuleTypeToModuleType[rule.type],
207
- });
208
-
209
- return {
210
- path: fileName, // change the reference to the changed module
211
- external: props.format === "modules", // mark it as external in the bundle
212
- namespace: `wrangler-module-${rule.type}`, // just a tag, this isn't strictly necessary
213
- watchFiles: [filePath], // we also add the file to esbuild's watch list
214
- };
215
- }
216
- );
217
-
218
- if (props.format === "service-worker") {
219
- build.onLoad(
220
- { filter: globToRegExp(glob) },
221
- async (args: esbuild.OnLoadArgs) => {
222
- return {
223
- // We replace the the module with an identifier
224
- // that we'll separately add to the form upload
225
- // as part of [wasm_modules]/[text_blobs]/[data_blobs]. This identifier has to be a valid
226
- // JS identifier, so we replace all non alphanumeric characters
227
- // with an underscore.
228
- contents: `export default ${args.path.replace(
229
- /[^a-zA-Z0-9_$]/g,
230
- "_"
231
- )};`,
232
- };
233
- }
234
- );
235
- }
236
- });
237
- });
238
-
239
- rulesToRemove.forEach((rule) => {
240
- rule.globs.forEach((glob) => {
241
- build.onResolve(
242
- { filter: globToRegExp(glob) },
243
- async (args: esbuild.OnResolveArgs) => {
244
- throw new Error(
245
- `The file ${
246
- args.path
247
- } matched a module rule in your configuration (${JSON.stringify(
248
- rule
249
- )}), but was ignored because a previous rule with the same type was not marked as \`fallthrough = true\`.`
250
- );
251
- }
252
- );
253
- });
254
- });
255
- },
256
- },
257
- };
258
- }
@@ -1,17 +0,0 @@
1
- import open from "open";
2
- import { logger } from "./logger";
3
-
4
- /**
5
- * An extremely simple wrapper around the open command.
6
- * Specifically, it adds an 'error' event handler so that when this function
7
- * is called in environments where we can't open the browser (e.g. GitHub Codespaces,
8
- * StackBlitz, remote servers), it doesn't just crash the process.
9
- *
10
- * @param url the URL to point the browser at
11
- */
12
- export default async function openInBrowser(url: string): Promise<void> {
13
- const childProcess = await open(url);
14
- childProcess.on("error", () => {
15
- logger.warn("Failed to open");
16
- });
17
- }
@@ -1,219 +0,0 @@
1
- import { existsSync } from "node:fs";
2
- import { join } from "node:path";
3
- import { env } from "node:process";
4
- import { execa, execaCommandSync } from "execa";
5
- import { logger } from "./logger";
6
-
7
- export interface PackageManager {
8
- cwd: string;
9
- type: "npm" | "yarn" | "pnpm";
10
- addDevDeps(...packages: string[]): Promise<void>;
11
- install(): Promise<void>;
12
- }
13
-
14
- export async function getPackageManager(cwd: string): Promise<PackageManager> {
15
- const [hasYarn, hasNpm, hasPnpm] = await Promise.all([
16
- supportsYarn(),
17
- supportsNpm(),
18
- supportsPnpm(),
19
- ]);
20
- const hasYarnLock = existsSync(join(cwd, "yarn.lock"));
21
- const hasNpmLock = existsSync(join(cwd, "package-lock.json"));
22
- const hasPnpmLock = existsSync(join(cwd, "pnpm-lock.yaml"));
23
- const userAgent = sniffUserAgent();
24
-
25
- // check for lockfiles
26
- if (hasNpmLock) {
27
- if (hasNpm) {
28
- logger.log(
29
- "Using npm as package manager, as there is already a package-lock.json file."
30
- );
31
- return { ...NpmPackageManager, cwd };
32
- } else if (hasYarn) {
33
- logger.log("Using yarn as package manager.");
34
- logger.warn(
35
- "There is already a package-lock.json file but could not find npm on the PATH."
36
- );
37
- return { ...YarnPackageManager, cwd };
38
- }
39
- } else if (hasPnpmLock) {
40
- if (hasPnpm) {
41
- logger.log(
42
- "Using pnpm as package manager, as there is already a pnpm-lock.yaml file."
43
- );
44
- return { ...PnpmPackageManager, cwd };
45
- } else {
46
- logger.warn(
47
- "There is already a pnpm-lock.yaml file but could not find pnpm on the PATH."
48
- );
49
- // will simply fallback to the first found of [npm, yaml, pnpm] in the next if round.
50
- }
51
- } else if (hasYarnLock) {
52
- if (hasYarn) {
53
- logger.log(
54
- "Using yarn as package manager, as there is already a yarn.lock file."
55
- );
56
- return { ...YarnPackageManager, cwd };
57
- } else if (hasNpm) {
58
- logger.log("Using npm as package manager.");
59
- logger.warn(
60
- "There is already a yarn.lock file but could not find yarn on the PATH."
61
- );
62
- return { ...NpmPackageManager, cwd };
63
- }
64
- }
65
-
66
- // check the user agent
67
- if (userAgent === "npm" && hasNpm) {
68
- logger.log("Using npm as package manager.");
69
- return { ...NpmPackageManager, cwd };
70
- } else if (userAgent === "pnpm" && hasPnpm) {
71
- logger.log("Using pnpm as package manager.");
72
- return { ...PnpmPackageManager, cwd };
73
- } else if (userAgent === "yarn" && hasYarn) {
74
- logger.log("Using yarn as package manager.");
75
- return { ...YarnPackageManager, cwd };
76
- }
77
-
78
- // lastly, check what's installed
79
- if (hasNpm) {
80
- logger.log("Using npm as package manager.");
81
- return { ...NpmPackageManager, cwd };
82
- } else if (hasYarn) {
83
- logger.log("Using yarn as package manager.");
84
- return { ...YarnPackageManager, cwd };
85
- } else if (hasPnpm) {
86
- logger.log("Using pnpm as package manager.");
87
- return { ...PnpmPackageManager, cwd };
88
- } else {
89
- throw new Error(
90
- "Unable to find a package manager. Supported managers are: npm, yarn, and pnpm."
91
- );
92
- }
93
- }
94
-
95
- /**
96
- * Get the name of the given `packageManager`.
97
- */
98
- export function getPackageManagerName(packageManager: PackageManager): string {
99
- return packageManager.type ?? "unknown";
100
- }
101
-
102
- /**
103
- * Manage packages using npm
104
- */
105
- const NpmPackageManager: PackageManager = {
106
- cwd: process.cwd(),
107
- type: "npm",
108
- /** Add and install a new devDependency into the local package.json. */
109
- async addDevDeps(...packages: string[]): Promise<void> {
110
- await execa("npm", ["install", ...packages, "--save-dev"], {
111
- stdio: "inherit",
112
- cwd: this.cwd,
113
- });
114
- },
115
-
116
- /** Install all the dependencies in the local package.json. */
117
- async install(): Promise<void> {
118
- await execa("npm", ["install"], {
119
- stdio: "inherit",
120
- cwd: this.cwd,
121
- });
122
- },
123
- };
124
-
125
- /**
126
- * Manage packages using pnpm
127
- */
128
- const PnpmPackageManager: PackageManager = {
129
- cwd: process.cwd(),
130
- type: "pnpm",
131
- /** Add and install a new devDependency into the local package.json. */
132
- async addDevDeps(...packages: string[]): Promise<void> {
133
- await execa("pnpm", ["install", ...packages, "--save-dev"], {
134
- stdio: "inherit",
135
- cwd: this.cwd,
136
- });
137
- },
138
-
139
- /** Install all the dependencies in the local package.json. */
140
- async install(): Promise<void> {
141
- await execa("pnpm", ["install"], {
142
- stdio: "inherit",
143
- cwd: this.cwd,
144
- });
145
- },
146
- };
147
-
148
- /**
149
- * Manage packages using yarn
150
- */
151
- const YarnPackageManager: PackageManager = {
152
- cwd: process.cwd(),
153
- type: "yarn",
154
- /** Add and install a new devDependency into the local package.json. */
155
- async addDevDeps(...packages: string[]): Promise<void> {
156
- await execa("yarn", ["add", ...packages, "--dev"], {
157
- stdio: "inherit",
158
- cwd: this.cwd,
159
- });
160
- },
161
-
162
- /** Install all the dependencies in the local package.json. */
163
- async install(): Promise<void> {
164
- await execa("yarn", ["install"], {
165
- stdio: "inherit",
166
- cwd: this.cwd,
167
- });
168
- },
169
- };
170
-
171
- async function supports(name: string): Promise<boolean> {
172
- try {
173
- execaCommandSync(`${name} --version`, { stdio: "ignore" });
174
- return true;
175
- } catch {
176
- return false;
177
- }
178
- }
179
-
180
- function supportsYarn(): Promise<boolean> {
181
- return supports("yarn");
182
- }
183
-
184
- function supportsNpm(): Promise<boolean> {
185
- return supports("npm");
186
- }
187
-
188
- function supportsPnpm(): Promise<boolean> {
189
- return supports("pnpm");
190
- }
191
-
192
- /**
193
- * The environment variable `npm_config_user_agent` can be used to
194
- * guess the package manager that was used to execute wrangler.
195
- * It's imperfect (just like regular user agent sniffing!)
196
- * but the package managers we support all set this property:
197
- *
198
- * - [npm](https://github.com/npm/cli/blob/1415b4bdeeaabb6e0ba12b6b1b0cc56502bd64ab/lib/utils/config/definitions.js#L1945-L1979)
199
- * - [pnpm](https://github.com/pnpm/pnpm/blob/cd4f9341e966eb8b411462b48ff0c0612e0a51a7/packages/plugin-commands-script-runners/src/makeEnv.ts#L14)
200
- * - [yarn](https://yarnpkg.com/advanced/lifecycle-scripts#environment-variables)
201
- */
202
- function sniffUserAgent(): "npm" | "pnpm" | "yarn" | undefined {
203
- const userAgent = env.npm_config_user_agent;
204
- if (userAgent === undefined) {
205
- return undefined;
206
- }
207
-
208
- if (userAgent.includes("yarn")) {
209
- return "yarn";
210
- }
211
-
212
- if (userAgent.includes("pnpm")) {
213
- return "pnpm";
214
- }
215
-
216
- if (userAgent.includes("npm")) {
217
- return "npm";
218
- }
219
- }