Skip to content

feat(wrangler): Add support for examples in --help#6513

Merged
CarmenPopoviciu merged 1 commit intomainfrom
carmen/yargs-examples
Aug 19, 2024
Merged

feat(wrangler): Add support for examples in --help#6513
CarmenPopoviciu merged 1 commit intomainfrom
carmen/yargs-examples

Conversation

@CarmenPopoviciu
Copy link
Copy Markdown
Contributor

@CarmenPopoviciu CarmenPopoviciu commented Aug 16, 2024 •
edited
Loading

What this PR solves / how to test

This commit enables yargs example support in wrangler (see https://yargs.js.org/docs/#api-reference-examplecmd1-desc1-cmd2-desc2), and adds one for vectorize query.

See #6502 (comment) for context

Screenshot 2024-08-16 at 19 45 23

Author has addressed the following

  • Tests
    • TODO (before merge)
    • Included
    • Not necessary because:
  • E2E Tests CI Job required? (Use "e2e" label or ask maintainer to run separately)
    • I don't know
    • Required / Maybe required
    • Not required because: stdout change
  • Changeset (Changeset guidelines)
    • TODO (before merge)
    • Included
    • Not necessary because: internal change
  • Public documentation
    • TODO (before merge)
    • Cloudflare docs PR(s):
    • Not necessary because: internal change

@CarmenPopoviciu
feat(wrangler): Add support for examples in --help
dbfa5ee 
This commit enables yargs `example` support in wrangler
(see https://yargs.js.org/docs/#api-reference-examplecmd1-desc1-cmd2-desc2),
and adds one for `vectorize query`.
@CarmenPopoviciu CarmenPopoviciu requested a review from a team as a code owner August 16, 2024 17:44
@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented Aug 16, 2024

⚠️ No Changeset found

Latest commit: dbfa5ee

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@CarmenPopoviciu CarmenPopoviciu mentioned this pull request Aug 16, 2024
Merged
11 tasks
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Aug 16, 2024

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/10424006763/npm-package-wrangler-6513

You can reference the automatically updated head of this PR with:

npm install --save-dev https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/prs/6513/npm-package-wrangler-6513

Or you can use npx with this latest build directly:

npx https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/10424006763/npm-package-wrangler-6513 dev path/to/script.js
Additional artifacts: 
npx https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/10424006763/npm-package-create-cloudflare-6513 --no-auto-update
npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/10424006763/npm-package-cloudflare-kv-asset-handler-6513
npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/10424006763/npm-package-miniflare-6513
npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/10424006763/npm-package-cloudflare-pages-shared-6513
npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/10424006763/npm-package-cloudflare-vitest-pool-workers-6513
npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/10424006763/npm-package-cloudflare-workers-editor-shared-6513
npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/10424006763/npm-package-cloudflare-workers-shared-6513

Note that these links will no longer work once the GitHub Actions artifact expires.

wrangler@3.72.0 includes the following runtime dependencies:

Package Constraint Resolved
miniflare workspace:* 3.20240806.1
workerd 1.20240806.0 1.20240806.0
workerd --version 1.20240806.0 2024-08-06

Please ensure constraints are pinned, and miniflare/workerd minor versions match.

@garvit-gupta
Copy link
Copy Markdown
Contributor

garvit-gupta commented Aug 16, 2024

LGTM. Approved from the Vectorize team.

@threepointone
Copy link
Copy Markdown
Contributor

threepointone commented Aug 17, 2024 •
edited
Loading

TIL, great feature.

@CarmenPopoviciu CarmenPopoviciu merged commit bd7d79a into main Aug 19, 2024
@CarmenPopoviciu CarmenPopoviciu deleted the carmen/yargs-examples branch August 19, 2024 10:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@penalosa penalosa penalosa approved these changes

Assignees

No one assigned

Labels

None yet

Projects

workers-sdk
Archived in project

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@CarmenPopoviciu @garvit-gupta @threepointone @penalosa