wrangler 0.0.0-ecc8b172 → 0.0.0-ecded1af1

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 (250) hide show
  1. package/README.md +17 -19
  2. package/bin/wrangler.js +24 -93
  3. package/config-schema.json +3115 -0
  4. package/package.json +197 -190
  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 +2 -3
  11. package/templates/init-tests/test-jest-new-worker.js +3 -5
  12. package/templates/init-tests/test-vitest-new-worker.js +4 -6
  13. package/templates/init-tests/test-vitest-new-worker.ts +25 -0
  14. package/templates/middleware/common.ts +9 -4
  15. package/templates/middleware/loader-modules.ts +94 -44
  16. package/templates/middleware/loader-sw.ts +48 -32
  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-mock-analytics-engine.d.ts +3 -0
  20. package/templates/middleware/middleware-mock-analytics-engine.ts +30 -0
  21. package/templates/middleware/middleware-scheduled.ts +15 -1
  22. package/templates/middleware/middleware-serve-static-assets.d.ts +6 -0
  23. package/templates/middleware/middleware-serve-static-assets.ts +56 -0
  24. package/templates/modules-watch-stub.js +4 -0
  25. package/templates/new-worker-scheduled.ts +1 -1
  26. package/templates/new-worker.ts +4 -1
  27. package/templates/pages-dev-pipeline.ts +10 -13
  28. package/templates/pages-dev-util.ts +55 -0
  29. package/templates/pages-shim.ts +1 -1
  30. package/templates/pages-template-plugin.ts +37 -14
  31. package/templates/pages-template-worker.ts +33 -7
  32. package/templates/startDevWorker/InspectorProxyWorker.ts +664 -0
  33. package/templates/startDevWorker/ProxyWorker.ts +336 -0
  34. package/templates/tsconfig-sanity.ts +11 -0
  35. package/templates/tsconfig.init.json +22 -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 +241 -0
  40. package/wrangler-dist/ProxyWorker.js.map +6 -0
  41. package/wrangler-dist/cli.d.ts +26095 -471
  42. package/wrangler-dist/cli.js +178062 -122008
  43. package/wrangler-dist/wasm-sync.wasm +0 -0
  44. package/Cloudflare_CA.pem +0 -18
  45. package/import_meta_url.js +0 -3
  46. package/miniflare-config-stubs/.env.empty +0 -0
  47. package/miniflare-config-stubs/package.empty.json +0 -1
  48. package/miniflare-config-stubs/wrangler.empty.toml +0 -0
  49. package/miniflare-dist/index.mjs +0 -6310
  50. package/src/__tests__/api-dev.test.ts +0 -209
  51. package/src/__tests__/api-devregistry.test.js +0 -56
  52. package/src/__tests__/api.test.ts +0 -80
  53. package/src/__tests__/config-cache-without-cache-dir.test.ts +0 -38
  54. package/src/__tests__/config-cache.test.ts +0 -42
  55. package/src/__tests__/configuration.test.ts +0 -3864
  56. package/src/__tests__/d1.test.ts +0 -70
  57. package/src/__tests__/delete.test.ts +0 -116
  58. package/src/__tests__/dev.test.tsx +0 -1357
  59. package/src/__tests__/dialogs.test.tsx +0 -40
  60. package/src/__tests__/generate.test.ts +0 -235
  61. package/src/__tests__/get-host-from-url.test.ts +0 -16
  62. package/src/__tests__/guess-worker-format.test.ts +0 -85
  63. package/src/__tests__/helpers/clipboardy-mock.js +0 -4
  64. package/src/__tests__/helpers/cmd-shim.d.ts +0 -11
  65. package/src/__tests__/helpers/mock-account-id.ts +0 -48
  66. package/src/__tests__/helpers/mock-bin.ts +0 -36
  67. package/src/__tests__/helpers/mock-cfetch.ts +0 -333
  68. package/src/__tests__/helpers/mock-console.ts +0 -106
  69. package/src/__tests__/helpers/mock-dialogs.ts +0 -153
  70. package/src/__tests__/helpers/mock-get-zone-from-host.ts +0 -8
  71. package/src/__tests__/helpers/mock-http-server.ts +0 -46
  72. package/src/__tests__/helpers/mock-istty.ts +0 -74
  73. package/src/__tests__/helpers/mock-known-routes.ts +0 -7
  74. package/src/__tests__/helpers/mock-kv.ts +0 -33
  75. package/src/__tests__/helpers/mock-oauth-flow.ts +0 -252
  76. package/src/__tests__/helpers/mock-process.ts +0 -39
  77. package/src/__tests__/helpers/mock-stdin.ts +0 -108
  78. package/src/__tests__/helpers/mock-web-socket.ts +0 -29
  79. package/src/__tests__/helpers/msw/handlers/namespaces.ts +0 -104
  80. package/src/__tests__/helpers/msw/handlers/oauth.ts +0 -36
  81. package/src/__tests__/helpers/msw/handlers/r2.ts +0 -80
  82. package/src/__tests__/helpers/msw/handlers/script.ts +0 -75
  83. package/src/__tests__/helpers/msw/handlers/user.ts +0 -63
  84. package/src/__tests__/helpers/msw/index.ts +0 -15
  85. package/src/__tests__/helpers/run-in-tmp.ts +0 -38
  86. package/src/__tests__/helpers/run-wrangler.ts +0 -16
  87. package/src/__tests__/helpers/worker-scripts/child-wrangler.toml +0 -1
  88. package/src/__tests__/helpers/worker-scripts/hello-world-worker.js +0 -5
  89. package/src/__tests__/helpers/worker-scripts/hello-world-wrangler.toml +0 -1
  90. package/src/__tests__/helpers/worker-scripts/parent-worker.js +0 -8
  91. package/src/__tests__/helpers/worker-scripts/parent-wrangler.toml +0 -5
  92. package/src/__tests__/helpers/write-worker-source.ts +0 -31
  93. package/src/__tests__/helpers/write-wrangler-toml.ts +0 -17
  94. package/src/__tests__/https-options.test.ts +0 -163
  95. package/src/__tests__/index.test.ts +0 -251
  96. package/src/__tests__/init.test.ts +0 -2816
  97. package/src/__tests__/jest.setup.ts +0 -191
  98. package/src/__tests__/kv.test.ts +0 -1675
  99. package/src/__tests__/logger.test.ts +0 -141
  100. package/src/__tests__/metrics.test.ts +0 -450
  101. package/src/__tests__/middleware.scheduled.test.ts +0 -135
  102. package/src/__tests__/middleware.test.ts +0 -726
  103. package/src/__tests__/package-manager.test.ts +0 -353
  104. package/src/__tests__/pages.test.ts +0 -2111
  105. package/src/__tests__/parse.test.ts +0 -330
  106. package/src/__tests__/paths.test.ts +0 -39
  107. package/src/__tests__/publish.test.ts +0 -7119
  108. package/src/__tests__/pubsub.test.ts +0 -367
  109. package/src/__tests__/r2.test.ts +0 -371
  110. package/src/__tests__/route.test.ts +0 -45
  111. package/src/__tests__/secret.test.ts +0 -644
  112. package/src/__tests__/tail.test.ts +0 -800
  113. package/src/__tests__/test-old-node-version.js +0 -31
  114. package/src/__tests__/user.test.ts +0 -155
  115. package/src/__tests__/utils-collectKeyValues.test.ts +0 -47
  116. package/src/__tests__/validate-dev-props.test.ts +0 -56
  117. package/src/__tests__/version.test.ts +0 -35
  118. package/src/__tests__/whoami.test.tsx +0 -278
  119. package/src/__tests__/worker-namespace.test.ts +0 -321
  120. package/src/abort.d.ts +0 -3
  121. package/src/api/dev.ts +0 -208
  122. package/src/api/index.ts +0 -2
  123. package/src/bundle-reporter.tsx +0 -29
  124. package/src/bundle.ts +0 -756
  125. package/src/cfetch/index.ts +0 -160
  126. package/src/cfetch/internal.ts +0 -263
  127. package/src/cli.ts +0 -29
  128. package/src/config/README.md +0 -107
  129. package/src/config/config.ts +0 -275
  130. package/src/config/diagnostics.ts +0 -80
  131. package/src/config/environment.ts +0 -505
  132. package/src/config/index.ts +0 -293
  133. package/src/config/validation-helpers.ts +0 -597
  134. package/src/config/validation.ts +0 -1930
  135. package/src/config-cache.ts +0 -85
  136. package/src/create-worker-preview.ts +0 -275
  137. package/src/create-worker-upload-form.ts +0 -301
  138. package/src/d1/backups.tsx +0 -212
  139. package/src/d1/create.tsx +0 -54
  140. package/src/d1/delete.tsx +0 -56
  141. package/src/d1/execute.tsx +0 -294
  142. package/src/d1/formatTimeAgo.ts +0 -14
  143. package/src/d1/index.ts +0 -75
  144. package/src/d1/list.tsx +0 -48
  145. package/src/d1/options.ts +0 -12
  146. package/src/d1/types.tsx +0 -14
  147. package/src/d1/utils.ts +0 -39
  148. package/src/delete.ts +0 -86
  149. package/src/deprecated/index.ts +0 -453
  150. package/src/dev/dev-vars.ts +0 -36
  151. package/src/dev/dev.tsx +0 -575
  152. package/src/dev/get-local-persistence-path.tsx +0 -31
  153. package/src/dev/local.tsx +0 -686
  154. package/src/dev/remote.tsx +0 -601
  155. package/src/dev/start-server.ts +0 -506
  156. package/src/dev/use-esbuild.ts +0 -197
  157. package/src/dev/validate-dev-props.ts +0 -31
  158. package/src/dev-registry.tsx +0 -201
  159. package/src/dev.tsx +0 -865
  160. package/src/dialogs.tsx +0 -163
  161. package/src/dispatch-namespace.ts +0 -206
  162. package/src/durable.ts +0 -102
  163. package/src/entry.ts +0 -329
  164. package/src/environment-variables.ts +0 -50
  165. package/src/errors.ts +0 -11
  166. package/src/git-client.ts +0 -124
  167. package/src/global-wrangler-config-path.ts +0 -26
  168. package/src/https-options.ts +0 -127
  169. package/src/index.tsx +0 -582
  170. package/src/init.ts +0 -970
  171. package/src/inspect.ts +0 -747
  172. package/src/intl-polyfill.d.ts +0 -139
  173. package/src/is-ci.ts +0 -14
  174. package/src/is-interactive.ts +0 -12
  175. package/src/kv/helpers.ts +0 -430
  176. package/src/kv/index.ts +0 -645
  177. package/src/logger.ts +0 -80
  178. package/src/metrics/index.ts +0 -5
  179. package/src/metrics/metrics-config.ts +0 -239
  180. package/src/metrics/metrics-dispatcher.ts +0 -96
  181. package/src/metrics/metrics-usage-headers.ts +0 -24
  182. package/src/metrics/send-event.ts +0 -94
  183. package/src/miniflare-cli/README.md +0 -30
  184. package/src/miniflare-cli/assets.ts +0 -215
  185. package/src/miniflare-cli/index.ts +0 -208
  186. package/src/miniflare-cli/request-context.ts +0 -40
  187. package/src/module-collection.ts +0 -267
  188. package/src/open-in-browser.ts +0 -17
  189. package/src/package-manager.ts +0 -219
  190. package/src/pages/build.tsx +0 -238
  191. package/src/pages/constants.ts +0 -16
  192. package/src/pages/deployments.tsx +0 -106
  193. package/src/pages/dev.tsx +0 -689
  194. package/src/pages/errors.ts +0 -66
  195. package/src/pages/functions/buildPlugin.ts +0 -110
  196. package/src/pages/functions/buildWorker.ts +0 -156
  197. package/src/pages/functions/filepath-routing.test.ts +0 -234
  198. package/src/pages/functions/filepath-routing.ts +0 -189
  199. package/src/pages/functions/identifiers.ts +0 -78
  200. package/src/pages/functions/routes-consolidation.test.ts +0 -250
  201. package/src/pages/functions/routes-consolidation.ts +0 -73
  202. package/src/pages/functions/routes-transformation.test.ts +0 -282
  203. package/src/pages/functions/routes-transformation.ts +0 -115
  204. package/src/pages/functions/routes-validation.test.ts +0 -403
  205. package/src/pages/functions/routes-validation.ts +0 -202
  206. package/src/pages/functions/routes.ts +0 -151
  207. package/src/pages/functions.tsx +0 -82
  208. package/src/pages/hash.tsx +0 -13
  209. package/src/pages/index.tsx +0 -94
  210. package/src/pages/projects.tsx +0 -169
  211. package/src/pages/publish.tsx +0 -436
  212. package/src/pages/types.ts +0 -49
  213. package/src/pages/upload.tsx +0 -398
  214. package/src/pages/utils.ts +0 -12
  215. package/src/parse.ts +0 -286
  216. package/src/paths.ts +0 -71
  217. package/src/proxy.ts +0 -657
  218. package/src/publish/index.ts +0 -267
  219. package/src/publish/publish.ts +0 -913
  220. package/src/pubsub/index.ts +0 -286
  221. package/src/pubsub/pubsub-commands.tsx +0 -623
  222. package/src/r2/helpers.ts +0 -131
  223. package/src/r2/index.ts +0 -277
  224. package/src/routes.ts +0 -140
  225. package/src/secret/index.ts +0 -403
  226. package/src/selfsigned.d.ts +0 -29
  227. package/src/sites.tsx +0 -372
  228. package/src/tail/createTail.ts +0 -315
  229. package/src/tail/filters.ts +0 -277
  230. package/src/tail/index.ts +0 -217
  231. package/src/tail/printing.ts +0 -107
  232. package/src/update-check.ts +0 -19
  233. package/src/user/choose-account.tsx +0 -69
  234. package/src/user/env-vars.ts +0 -46
  235. package/src/user/generate-auth-url.ts +0 -33
  236. package/src/user/generate-random-state.ts +0 -16
  237. package/src/user/index.ts +0 -3
  238. package/src/user/user.tsx +0 -1192
  239. package/src/utils/collectKeyValues.ts +0 -14
  240. package/src/whoami.tsx +0 -169
  241. package/src/worker.ts +0 -234
  242. package/src/yargs-types.ts +0 -7
  243. package/src/zones.ts +0 -165
  244. package/templates/d1-beta-facade.js +0 -174
  245. package/templates/experimental-local-cache-stubs.js +0 -27
  246. package/templates/first-party-worker-module-facade.ts +0 -18
  247. package/templates/format-dev-errors.ts +0 -32
  248. package/templates/serve-static-assets.ts +0 -63
  249. package/templates/service-bindings-module-facade.js +0 -54
  250. package/templates/service-bindings-sw-facade.js +0 -42
@@ -1,275 +0,0 @@
1
- import type { Environment, RawEnvironment } from "./environment";
2
-
3
- /**
4
- * This is the static type definition for the configuration object.
5
- *
6
- * It reflects a normalized and validated version of the configuration that you can write in wrangler.toml,
7
- * and optionally augment with arguments passed directly to wrangler.
8
- *
9
- * For more information about the configuration object, see the
10
- * documentation at https://developers.cloudflare.com/workers/cli-wrangler/configuration
11
- *
12
- * Notes:
13
- *
14
- * - Fields that are only specified in `ConfigFields` and not `Environment` can only appear
15
- * in the top level config and should not appear in any environments.
16
- * - All top level fields in config and environments are optional in the wrangler.toml file.
17
- *
18
- * Legend for the annotations:
19
- *
20
- * - `@breaking`: the deprecation/optionality is a breaking change from wrangler 1.
21
- * - `@todo`: there's more work to be done (with details attached).
22
- */
23
- export type Config = ConfigFields<DevConfig> & Environment;
24
-
25
- export type RawConfig = Partial<ConfigFields<RawDevConfig>> &
26
- RawEnvironment &
27
- DeprecatedConfigFields &
28
- EnvironmentMap;
29
-
30
- export interface ConfigFields<Dev extends RawDevConfig> {
31
- configPath: string | undefined;
32
-
33
- /**
34
- * A boolean to enable "legacy" style wrangler environments (from wrangler 1).
35
- * These have been superseded by Services, but there may be projects that won't
36
- * (or can't) use them. If you're using a legacy environment, you can set this
37
- * to `true` to enable it.
38
- */
39
- legacy_env: boolean;
40
-
41
- /**
42
- * Whether Wrangler should send usage metrics to Cloudflare for this project.
43
- *
44
- * When defined this will override any user settings.
45
- * Otherwise, Wrangler will use the user's preference.
46
- */
47
- send_metrics: boolean | undefined;
48
-
49
- /**
50
- * Options to configure the development server that your worker will use.
51
- */
52
- dev: Dev;
53
-
54
- /**
55
- * A list of migrations that should be uploaded with your Worker.
56
- *
57
- * These define changes in your Durable Object declarations.
58
- *
59
- * More details at https://developers.cloudflare.com/workers/learning/using-durable-objects#configuring-durable-object-classes-with-migrations
60
- *
61
- * @default `[]`
62
- */
63
- migrations: {
64
- /** A unique identifier for this migration. */
65
- tag: string;
66
- /** The new Durable Objects being defined. */
67
- new_classes?: string[];
68
- /** The Durable Objects being renamed. */
69
- renamed_classes?: {
70
- from: string;
71
- to: string;
72
- }[];
73
- /** The Durable Objects being removed. */
74
- deleted_classes?: string[];
75
- }[];
76
-
77
- /**
78
- * The definition of a Worker Site, a feature that lets you upload
79
- * static assets with your Worker.
80
- *
81
- * More details at https://developers.cloudflare.com/workers/platform/sites
82
- */
83
- site:
84
- | {
85
- /**
86
- * The directory containing your static assets.
87
- *
88
- * It must be a path relative to your wrangler.toml file.
89
- * Example: bucket = "./public"
90
- *
91
- * If there is a `site` field then it must contain this `bucket` field.
92
- */
93
- bucket: string;
94
-
95
- /**
96
- * The location of your Worker script.
97
- *
98
- * @deprecated DO NOT use this (it's a holdover from wrangler 1.x). Either use the top level `main` field, or pass the path to your entry file as a command line argument.
99
- * @breaking
100
- */
101
- "entry-point"?: string;
102
-
103
- /**
104
- * An exclusive list of .gitignore-style patterns that match file
105
- * or directory names from your bucket location. Only matched
106
- * items will be uploaded. Example: include = ["upload_dir"]
107
- *
108
- * @optional
109
- * @default `[]`
110
- */
111
- include?: string[];
112
-
113
- /**
114
- * A list of .gitignore-style patterns that match files or
115
- * directories in your bucket that should be excluded from
116
- * uploads. Example: exclude = ["ignore_dir"]
117
- *
118
- * @optional
119
- * @default `[]`
120
- */
121
- exclude?: string[];
122
- }
123
- | undefined;
124
-
125
- /**
126
- * Serve a folder of static assets with your Worker, without any additional code.
127
- * This can either be a string, or an object with additional config fields.
128
- */
129
- assets:
130
- | {
131
- bucket: string;
132
- include: string[];
133
- exclude: string[];
134
- browser_TTL: number | undefined;
135
- serve_single_page_app: boolean;
136
- }
137
- | undefined;
138
-
139
- /**
140
- * A list of wasm modules that your worker should be bound to. This is
141
- * the "legacy" way of binding to a wasm module. ES module workers should
142
- * do proper module imports.
143
- */
144
- wasm_modules:
145
- | {
146
- [key: string]: string;
147
- }
148
- | undefined;
149
-
150
- /**
151
- * A list of text files that your worker should be bound to. This is
152
- * the "legacy" way of binding to a text file. ES module workers should
153
- * do proper module imports.
154
- */
155
- text_blobs:
156
- | {
157
- [key: string]: string;
158
- }
159
- | undefined;
160
-
161
- /**
162
- * A list of data files that your worker should be bound to. This is
163
- * the "legacy" way of binding to a data file. ES module workers should
164
- * do proper module imports.
165
- */
166
- data_blobs:
167
- | {
168
- [key: string]: string;
169
- }
170
- | undefined;
171
-
172
- /**
173
- * By default, wrangler.toml is the source of truth for your environment configuration, like a terraform file.
174
- *
175
- * If you change your vars in the dashboard, wrangler *will* override/delete them on its next publish.
176
- *
177
- * If you want to keep your dashboard vars when wrangler deploys, set this field to true.
178
- *
179
- * @default false
180
- * @nonInheritable
181
- */
182
- keep_vars?: boolean;
183
- }
184
-
185
- export interface DevConfig {
186
- /**
187
- * IP address for the local dev server to listen on,
188
- *
189
- * @default `0.0.0.0`
190
- */
191
- ip: string;
192
-
193
- /**
194
- * Port for the local dev server to listen on
195
- *
196
- * @default `8787`
197
- */
198
- port: number | undefined;
199
-
200
- /**
201
- * Port for the local dev server's inspector to listen on
202
- *
203
- * @default `9229`
204
- */
205
- inspector_port: number | undefined;
206
-
207
- /**
208
- * Protocol that local wrangler dev server listens to requests on.
209
- *
210
- * @default `http`
211
- */
212
- local_protocol: "http" | "https";
213
-
214
- /**
215
- * Protocol that wrangler dev forwards requests on
216
- *
217
- * Setting this to `http` is not currently implemented.
218
- * See https://github.com/cloudflare/wrangler2/issues/583
219
- *
220
- * @default `https`
221
- * @todo this needs to be implemented https://github.com/cloudflare/wrangler2/issues/583
222
- */
223
- upstream_protocol: "https" | "http";
224
-
225
- /**
226
- * Host to forward requests to, defaults to the host of the first route of project
227
- */
228
- host: string | undefined;
229
- }
230
-
231
- export type RawDevConfig = Partial<DevConfig>;
232
-
233
- export interface DeprecatedConfigFields {
234
- /**
235
- * The project "type". A holdover from wrangler 1.x.
236
- * Valid values were "webpack", "javascript", and "rust".
237
- *
238
- * @deprecated DO NOT USE THIS. Most common features now work out of the box with wrangler, including modules, jsx, typescript, etc. If you need anything more, use a custom build.
239
- * @breaking
240
- */
241
- type?: "webpack" | "javascript" | "rust";
242
-
243
- /**
244
- * Path to the webpack config to use when building your worker.
245
- * A holdover from wrangler 1.x, used with `type: "webpack"`.
246
- *
247
- * @deprecated DO NOT USE THIS. Most common features now work out of the box with wrangler, including modules, jsx, typescript, etc. If you need anything more, use a custom build.
248
- * @breaking
249
- */
250
- webpack_config?: string;
251
-
252
- /**
253
- * Configuration only used by a standalone use of the miniflare binary.
254
- * @deprecated
255
- */
256
- miniflare?: unknown;
257
- }
258
-
259
- interface EnvironmentMap {
260
- /**
261
- * The `env` section defines overrides for the configuration for different environments.
262
- *
263
- * All environment fields can be specified at the top level of the config indicating the default environment settings.
264
- *
265
- * - Some fields are inherited and overridable in each environment.
266
- * - But some are not inherited and must be explicitly specified in every environment, if they are specified at the top level.
267
- *
268
- * For more information, see the documentation at https://developers.cloudflare.com/workers/cli-wrangler/configuration#environments
269
- *
270
- * @default `{}`
271
- */
272
- env?: {
273
- [envName: string]: RawEnvironment;
274
- };
275
- }
@@ -1,80 +0,0 @@
1
- /**
2
- * Diagnostic errors and warnings.
3
- *
4
- * The structure is a tree, where each node can contain zero or more errors, warnings and child diagnostics objects.
5
- * You can check whether the overall tree has errors or warnings, and you can render a string representation of the errors or warnings.
6
- */
7
- export class Diagnostics {
8
- errors: string[] = [];
9
- warnings: string[] = [];
10
- children: Diagnostics[] = [];
11
-
12
- /**
13
- * Create a new Diagnostics object.
14
- * @param description A general description of this collection of messages.
15
- */
16
- constructor(public description: string) {}
17
-
18
- /**
19
- * Merge the given `diagnostics` into this as a child.
20
- */
21
- addChild(diagnostics: Diagnostics): void {
22
- if (diagnostics.hasErrors() || diagnostics.hasWarnings()) {
23
- this.children.push(diagnostics);
24
- }
25
- }
26
-
27
- /** Does this or any of its children have errors. */
28
- hasErrors(): boolean {
29
- if (this.errors.length > 0) {
30
- return true;
31
- } else {
32
- return this.children.some((child) => child.hasErrors());
33
- }
34
- }
35
-
36
- /** Render the errors of this and all its children. */
37
- renderErrors(): string {
38
- return this.render("errors");
39
- }
40
-
41
- /** Does this or any of its children have warnings. */
42
- hasWarnings(): boolean {
43
- if (this.warnings.length > 0) {
44
- return true;
45
- } else {
46
- return this.children.some((child) => child.hasWarnings());
47
- }
48
- }
49
-
50
- /** Render the warnings of this and all its children. */
51
- renderWarnings(): string {
52
- return this.render("warnings");
53
- }
54
-
55
- private render(field: "errors" | "warnings"): string {
56
- const hasMethod = field === "errors" ? "hasErrors" : "hasWarnings";
57
- return indentText(
58
- `${this.description}\n` +
59
- // Output all the fields (errors or warnings) at this level
60
- this[field].map((message) => `- ${indentText(message)}`).join("\n") +
61
- // Output all the child diagnostics at the next level
62
- this.children
63
- .map((child) =>
64
- child[hasMethod]() ? "\n- " + child.render(field) : ""
65
- )
66
- .filter((output) => output !== "")
67
- .join("\n")
68
- );
69
- }
70
- }
71
-
72
- /** Indent all the but the first line by two spaces. */
73
- function indentText(str: string): string {
74
- return str
75
- .split("\n")
76
- .map((line, index) =>
77
- (index === 0 ? line : ` ${line}`).replace(/^\s*$/, "")
78
- )
79
- .join("\n");
80
- }