-
Notifications
You must be signed in to change notification settings - Fork 734
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
Conversation
|
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 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.
Please ensure constraints are pinned, and |
defineCommand({ | ||
command: "wrangler docs", | ||
metadata: { | ||
description: "📚 Open Wrangler's command documentation in your browser\n", |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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
packages/wrangler/src/index.ts
Outdated
@@ -49,6 +48,7 @@ import { initHandler, initOptions } from "./init"; | |||
import "./kv"; | |||
import "./workflows"; | |||
import "./user/commands"; | |||
import "./docs"; |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.
Fixes #[insert GH or internal issue link(s)].
related #6655