Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: use defineCommand in wrangler docs #7246

Merged
merged 2 commits into from
Nov 14, 2024
Merged

chore: use defineCommand in wrangler docs #7246

merged 2 commits into from
Nov 14, 2024

Conversation

emily-shen
Copy link
Contributor

Fixes #[insert GH or internal issue link(s)].

related #6655


  • Tests
    • TODO (before merge)
    • Tests included
    • Tests not necessary because: no behaviour change, just needs to pass existing
  • E2E Tests CI Job required? (Use "e2e" label or ask maintainer to run separately)
    • I don't know
    • Required
    • Not required because: no behaviour change, just needs to pass existing
  • Public documentation
    • TODO (before merge)
    • Cloudflare docs PR(s):
    • Documentation not necessary because: internal refactor

@emily-shen emily-shen requested a review from a team as a code owner November 13, 2024 09:29
Copy link

changeset-bot bot commented Nov 13, 2024

⚠️ No Changeset found

Latest commit: 48829ca

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

Copy link
Contributor

github-actions bot commented Nov 13, 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/11821727259/npm-package-wrangler-7246

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

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

Or you can use npx with this latest build directly:

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

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


wrangler@3.86.1 includes the following runtime dependencies:

Package Constraint Resolved
miniflare workspace:* 3.20241106.0
workerd 1.20241106.1 1.20241106.1
workerd --version 1.20241106.1 2024-11-06

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

defineCommand({
command: "wrangler docs",
metadata: {
description: "📚 Open Wrangler's command documentation in your browser\n",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you know what is the usage of \n here? Is it used to adjust the layout of the help message?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah, there are line breaks to group the commands in the help

@@ -49,6 +48,7 @@ import { initHandler, initOptions } from "./init";
import "./kv";
import "./workflows";
import "./user/commands";
import "./docs";
Copy link
Member

@edmundhung edmundhung Nov 13, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the import order matters in terms of which commands are displayed first on the help message and the docs command was the first one..? Can you help confirming?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sort of - right now register.registerNamespace determines the order, because it needs to be interleaved with the non-defineCommand commands (which is why the help tests are passing). i think eventually it will pull from the import order and then we can get rid of registerNamespace. I forgot about that tho, will reorder.

@emily-shen emily-shen merged commit 56dcc94 into main Nov 14, 2024
30 checks passed
@emily-shen emily-shen deleted the emily/docs-cmd branch November 14, 2024 09:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants