fix(wrangler): enforce single value on non-array arguments #7005
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🦋 Changeset detectedLatest commit: 18b523b The changes in this PR will be included in the next version bump. This PR includes changesets to release 2 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
edmundhung
changed the title
|
A wrangler prerelease is available for testing. You can install this latest build in your project with: npm install --save-dev https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/11458507774/npm-package-wrangler-7005You can reference the automatically updated head of this PR with: npm install --save-dev https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/prs/7005/npm-package-wrangler-7005Or you can use npx https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/11458507774/npm-package-wrangler-7005 dev path/to/script.jsAdditional artifacts:npx https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/11458507774/npm-package-create-cloudflare-7005 --no-auto-updatenpm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/11458507774/npm-package-cloudflare-kv-asset-handler-7005npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/11458507774/npm-package-miniflare-7005npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/11458507774/npm-package-cloudflare-pages-shared-7005npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/11458507774/npm-package-cloudflare-vitest-pool-workers-7005npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/11458507774/npm-package-cloudflare-workers-editor-shared-7005npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/11458507774/npm-package-cloudflare-workers-shared-7005Note that these links will no longer work once the GitHub Actions artifact expires.
Please ensure constraints are pinned, and |
edmundhung
force-pushed
the
edmundhung/no-array-on-non-array-args
branch
from
7864a86
to
4c27cf8
Compare
edmundhung
changed the title
RamIdeas
reviewed
Oct 18, 2024
Comment on lines
+129
to
+138
| // Yargs offers an `array: true` option that will always coerces the value to an array | ||
| // e.g. `--name foo` becomes `{ name: ["foo"] }` instead of `{ name: "foo" }` | ||
| // However, non-array arguments can still receives multiple values | ||
| // e.g. `--name foo --name bar` becomes `{ name: ["foo", "bar"] }` regardless of the `array` setting | ||
| // @see https://github.com/yargs/yargs/issues/1318 | ||
| for (const [key, opt] of Object.entries(def.args)) { | ||
| if (!opt.array) { | ||
| yargs.check(demandSingleValue(key)); | ||
| } | ||
| } |
There was a problem hiding this comment.
Good stuff! This util is intended for us to be more opinionated than yargs 👏
RamIdeas
reviewed
Oct 18, 2024
edmundhung
force-pushed
the
edmundhung/no-array-on-non-array-args
branch
2 times, most recently
from
4bf4f4b
to
9386d88
Compare
edmundhung
commented
Oct 21, 2024
| }; | ||
| } | ||
|
|
||
| export class CommandLineArgsError extends UserError {} |
There was a problem hiding this comment.
I moved it to errors.ts since both demandOneOfOption and demandSingleValue need this error class.
edmundhung
force-pushed
the
edmundhung/no-array-on-non-array-args
branch
from
abc064e
to
c1d4738
Compare
edmundhung
force-pushed
the
edmundhung/no-array-on-non-array-args
branch
from
c1d4738
to
18b523b
Compare
RamIdeas
approved these changes
Oct 22, 2024
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What this PR solves / how to test
Fixes n/a
Author has addressed the following