[Wrangler] Update the commands list #3735

lrapoport-cf · 2023-08-10T21:05:25Z

What this PR solves / how to test:

This PR cleans up and standardises the look and feel of all wrangler commands as displayed by wrangler --help and wrangler <cmd> --help.

Please refer to original designs here

Before

After

Here is the list of all public facing wrangler commands, in their updated version:

**wrangler deployments --help**

**wrangler deployments --x-versions --help**

**npx wrangler rollback --help**

**npx wrangler rollback --x-versions --help**

**npx wrangler versions --x-versions --help**

**wrangler triggers --x-versions --help**

**wrangler kv --help**

**wrangler queues --help**

**wrangler r2 --help**

**wrangler d1 --help**

**wrangler vectorize --help**

**wrangler hyperdrive --help**

**wrangler pages --help**

**wrangler mtls-certificate --help**

**wrangler cloudchamber --help**

**wrangler pubsub --help**

**wrangler dispatch-namespace --help**

**wrangler ai --help**

**wrangler login --help**

Author has addressed the following

Tests
- TODO (before merge)
- Included
- Not necessary because:
Changeset (Changeset guidelines)
- TODO (before merge)
- Included
- Not necessary because:
Public documentation
- TODO (before merge): put up PR to update wrangler commands list to match changes in this PR (a la this PR put up initially but which was closed because went stale: [Wrangler] Update wrangler commands cloudflare-docs#9430 )
- Cloudflare docs PR(s): [Wrangler] Update commands list cloudflare-docs#11514
- Not necessary because: simple bug fix

changeset-bot · 2023-08-10T21:05:28Z

🦋 Changeset detected

Latest commit: a61500f

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages

Name	Type
wrangler	Patch
@cloudflare/vitest-pool-workers	Patch

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

packages/wrangler/src/index.ts

github-actions · 2023-08-11T20:18:18Z

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/9601015901/npm-package-wrangler-3735

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

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

Or you can use npx with this latest build directly:

npx https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/9601015901/npm-package-wrangler-3735 dev path/to/script.js

Additional artifacts:

npx https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/9601015901/npm-package-create-cloudflare-3735 --no-auto-update

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/9601015901/npm-package-cloudflare-kv-asset-handler-3735

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/9601015901/npm-package-miniflare-3735

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/9601015901/npm-package-cloudflare-pages-shared-3735

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/9601015901/npm-package-cloudflare-vitest-pool-workers-3735

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

wrangler@3.61.0 includes the following runtime dependencies:

Package	Constraint	Resolved
`miniflare`	workspace:*	3.20240610.1
`workerd`	1.20240610.1	1.20240610.1
`workerd --version`	1.20240610.1	2024-06-10

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

codecov · 2023-10-24T15:45:18Z

Codecov Report

Attention: Patch coverage is 98.30508% with 1 line in your changes missing coverage. Please review.

Project coverage is 75.44%. Comparing base (2789f26) to head (00c640f).
Report is 296 commits behind head on main.

❗ Current head 00c640f differs from pull request most recent head 8bd2bc7

Please upload reports for the commit 8bd2bc7 to get more accurate results.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3735      +/-   ##
==========================================
+ Coverage   72.44%   75.44%   +2.99%     
==========================================
  Files         331      223     -108     
  Lines       17298    12332    -4966     
  Branches     4422     3188    -1234     
==========================================
- Hits        12532     9304    -3228     
+ Misses       4766     3028    -1738

Files	Coverage Δ
packages/wrangler/src/ai/index.ts	`100.00% <ø> (ø)`
packages/wrangler/src/constellation/index.ts	`100.00% <100.00%> (ø)`
packages/wrangler/src/hyperdrive/index.ts	`100.00% <ø> (ø)`
packages/wrangler/src/index.ts	`83.72% <100.00%> (-6.59%)`	⬇️
packages/wrangler/src/kv/index.ts	`100.00% <ø> (ø)`
packages/wrangler/src/pages/index.ts	`84.00% <100.00%> (-2.21%)`	⬇️
...wrangler/src/queues/cli/commands/consumer/index.ts	`100.00% <ø> (+15.38%)`	⬆️
packages/wrangler/src/queues/cli/commands/index.ts	`100.00% <100.00%> (ø)`
packages/wrangler/src/secret/index.ts	`88.51% <ø> (+5.18%)`	⬆️
packages/wrangler/src/vectorize/index.ts	`100.00% <ø> (ø)`
... and 1 more

... and 237 files with indirect coverage changes

RamIdeas · 2023-11-03T17:10:02Z

Great effort combing through all of this!

A couple subjective points:

I think the emojis should have a space after them before the text begins
I think using the same emoji for all commands reduces their "fun" quotient (I bet I sound fun right now 👀) and I don't think the consistency there is of any benefit
I like the introduction of a consistent emoji for all experimental commands – maybe we could use a different one that's less subtle?

lrapoport-cf · 2023-11-03T17:47:13Z

@RamIdeas thanks for the feedback! the emoji changes are based on a proposal from the design team -- i'll get them looped into the discussion. for my two cents, i agree that the consistency has a lower fun quotient 😄, but i do think it adds some informational value that the more assorted collection lacks: it signals that there is a loose relationship between the items in the different emoji groups, and also distracts less from the command descriptions.

lrapoport-cf · 2023-11-03T17:50:00Z

cc @Meahaa

Meahaa · 2023-11-03T17:54:32Z

Excellent points let's:

Add the space
Keep the emoji's agree it's more fun to have them and we can take a pass in the future to make sure they actually make sense
I'm not following too clearly here - I liked the orange text because it's a nice brand call out

RamIdeas · 2023-11-03T18:52:47Z

I'm not following too clearly here - I liked the orange text because it's a nice brand call out

I think you're referring to the "open beta" text in the figma design doc which I think being on-brand orange is great!

I was referring to the ⚑ flag emoji which blends into the text a little – a non-exhaustive set of alternatives to consider:

🧪 test tube
👩‍🔬 scientist
🥼 lab coat
🧫 petri dish
🔬 microscope

petebacondarwin · 2024-02-19T10:13:04Z

@Meahaa - can you take a look at @RamIdeas' last comment? Should we update that last emoji?
@lrapoport-cf - can we rebase and fix the conflicts while updating to fit the agreed points between @RamIdeas and @Meahaa ?

Meahaa · 2024-02-20T19:20:16Z

ooh I like the test tube let's go with that!

CarmenPopoviciu · 2024-02-26T14:32:59Z

Excellent points let's:

Add the space

Keep the emoji's agree it's more fun to have them and we can take a pass in the future to make sure they actually make sense

I'm not following too clearly here - I liked the orange text because it's a nice brand call out

@Meahaa I am taking over this PR to cross it over the finish line. Can you please clarify point 2 for me? Do we keep the current emojis as they are, or do we change them as per design?

CarmenPopoviciu · 2024-02-26T18:01:16Z

@Meahaa @RamIdeas @petebacondarwin I've added a before and after screenshot to the description of this PR. Before reviewing the code, is there consensus that, visually, things are as we want them to be? <3

petebacondarwin · 2024-02-26T18:10:51Z

I read that @Meahaa wrote:

Keep the emoji's agree it's more fun to have them and we can take a pass in the future to make sure they actually make sense

So I think that means we are all agreed that we should not switch out the mix of emojis for the boring few?

Meahaa · 2024-03-06T20:53:33Z

Yup! Let's just keep the current emojis for now! Agree with the fact that they make them more fun for now and we can always update to make them even better later!

CarmenPopoviciu · 2024-06-19T19:20:20Z

packages/wrangler/src/versions/deployments/index.ts

@@ -18,13 +18,13 @@ export default function registerVersionsDeploymentsSubcommands(
 	versionDeploymentsYargs
 		.command(
 			"list",
-			"Displays the 10 most recent deployments of your Worker [beta]",


removing, as the beta nature of these commands is signalled at command level, which should be enough?

cc// @RamIdeas

packages/wrangler/src/index.ts

CarmenPopoviciu · 2024-06-19T19:30:08Z

packages/wrangler/src/index.ts

@@ -204,33 +210,34 @@ export function createCLIParser(argv: string[]) {
 		})
 		.scriptName("wrangler")
 		.wrap(null)
+		.locale("en_US")


forcing locale here, since we don't support anything other than en. This also ensures we don't run into any unexpected behaviour when we call wrangler.updateStrings() further down

packages/wrangler/src/utils/stdout-styling.ts

packages/wrangler/src/index.ts

packages/wrangler/src/utils/stdout-styling.ts

packages/wrangler/src/index.ts

This commit cleans up and standardizes the look and of all `wrangler` commands as displayed by `wrangler --help` and `wrangler <cmd> --help`.

Skye-31 reviewed Aug 10, 2023

View reviewed changes

packages/wrangler/src/index.ts Outdated Show resolved Hide resolved

Skye-31 reviewed Aug 10, 2023

View reviewed changes

packages/wrangler/src/index.ts Show resolved Hide resolved

lrapoport-cf force-pushed the lrapoport/help-cleanup branch from 553401c to 88d9ce9 Compare August 11, 2023 20:16

lrapoport-cf force-pushed the lrapoport/help-cleanup branch from bc46957 to 1d5b6e0 Compare October 12, 2023 18:48

lrapoport-cf marked this pull request as ready for review October 24, 2023 18:58

lrapoport-cf requested review from a team as code owners October 24, 2023 18:58

lrapoport-cf marked this pull request as draft October 24, 2023 18:59

lrapoport-cf force-pushed the lrapoport/help-cleanup branch from fd41704 to 30ff496 Compare October 27, 2023 19:06

lrapoport-cf mentioned this pull request Oct 27, 2023

[Wrangler] Update commands list cloudflare/cloudflare-docs#11514

Merged

lrapoport-cf force-pushed the lrapoport/help-cleanup branch from 30ff496 to 00c640f Compare October 27, 2023 19:51

lrapoport-cf marked this pull request as ready for review October 30, 2023 13:55

lrapoport-cf added the awaiting reporter response Needs clarification or followup from OP label Nov 8, 2023

petebacondarwin assigned RamIdeas and Meahaa Feb 19, 2024

petebacondarwin removed the awaiting reporter response Needs clarification or followup from OP label Feb 21, 2024

petebacondarwin unassigned Meahaa Feb 21, 2024

CarmenPopoviciu force-pushed the lrapoport/help-cleanup branch from 00c640f to b776baf Compare February 23, 2024 15:09

CarmenPopoviciu force-pushed the lrapoport/help-cleanup branch from b776baf to 45f2f5d Compare February 26, 2024 17:55

penalosa assigned CarmenPopoviciu Apr 30, 2024

CarmenPopoviciu force-pushed the lrapoport/help-cleanup branch 2 times, most recently from fefdde5 to 902ec93 Compare June 19, 2024 19:16

CarmenPopoviciu reviewed Jun 19, 2024

View reviewed changes

packages/wrangler/src/index.ts Outdated Show resolved Hide resolved

CarmenPopoviciu reviewed Jun 19, 2024

View reviewed changes

CarmenPopoviciu force-pushed the lrapoport/help-cleanup branch from 902ec93 to 9c517a4 Compare June 19, 2024 19:33

CarmenPopoviciu reviewed Jun 19, 2024

View reviewed changes

packages/wrangler/src/utils/stdout-styling.ts Outdated Show resolved Hide resolved

penalosa reviewed Jun 19, 2024

View reviewed changes

CarmenPopoviciu force-pushed the lrapoport/help-cleanup branch from 9c517a4 to 8bd2bc7 Compare June 20, 2024 09:43

CarmenPopoviciu mentioned this pull request Jun 20, 2024

Version secrets + secret behaviour changes #5950

Merged

12 tasks

petebacondarwin approved these changes Jun 20, 2024

View reviewed changes

lrapoport-cf and others added 2 commits June 20, 2024 18:20

Clean up wrangler --help output

4556761

This commit cleans up and standardizes the look and of all `wrangler` commands as displayed by `wrangler --help` and `wrangler <cmd> --help`.

PR review fixes

a61500f

CarmenPopoviciu force-pushed the lrapoport/help-cleanup branch from 8bd2bc7 to a61500f Compare June 20, 2024 16:26

CarmenPopoviciu merged commit 9c7df38 into main Jun 20, 2024
19 checks passed

CarmenPopoviciu deleted the lrapoport/help-cleanup branch June 20, 2024 16:50

workers-devprod mentioned this pull request Jun 20, 2024

Version Packages #6081

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Wrangler] Update the commands list #3735

[Wrangler] Update the commands list #3735

lrapoport-cf commented Aug 10, 2023 •

edited by CarmenPopoviciu

Loading

changeset-bot bot commented Aug 10, 2023 •

edited

Loading

github-actions bot commented Aug 11, 2023 •

edited

Loading

codecov bot commented Oct 24, 2023 •

edited

Loading

RamIdeas commented Nov 3, 2023 •

edited

Loading

lrapoport-cf commented Nov 3, 2023

lrapoport-cf commented Nov 3, 2023

Meahaa commented Nov 3, 2023

RamIdeas commented Nov 3, 2023 •

edited

Loading

petebacondarwin commented Feb 19, 2024

Meahaa commented Feb 20, 2024

CarmenPopoviciu commented Feb 26, 2024 •

edited

Loading

CarmenPopoviciu commented Feb 26, 2024 •

edited

Loading

petebacondarwin commented Feb 26, 2024

Meahaa commented Mar 6, 2024 •

edited

Loading

CarmenPopoviciu Jun 19, 2024 •

edited

Loading

CarmenPopoviciu Jun 19, 2024

CarmenPopoviciu Jun 19, 2024

[Wrangler] Update the commands list #3735

[Wrangler] Update the commands list #3735

Conversation

lrapoport-cf commented Aug 10, 2023 • edited by CarmenPopoviciu Loading

What this PR solves / how to test:

Author has addressed the following

changeset-bot bot commented Aug 10, 2023 • edited Loading

🦋 Changeset detected

github-actions bot commented Aug 11, 2023 • edited Loading

codecov bot commented Oct 24, 2023 • edited Loading

Codecov Report

RamIdeas commented Nov 3, 2023 • edited Loading

lrapoport-cf commented Nov 3, 2023

lrapoport-cf commented Nov 3, 2023

Meahaa commented Nov 3, 2023

RamIdeas commented Nov 3, 2023 • edited Loading

petebacondarwin commented Feb 19, 2024

Meahaa commented Feb 20, 2024

CarmenPopoviciu commented Feb 26, 2024 • edited Loading

CarmenPopoviciu commented Feb 26, 2024 • edited Loading

petebacondarwin commented Feb 26, 2024

Meahaa commented Mar 6, 2024 • edited Loading

CarmenPopoviciu Jun 19, 2024 • edited Loading

Choose a reason for hiding this comment

CarmenPopoviciu Jun 19, 2024

Choose a reason for hiding this comment

CarmenPopoviciu Jun 19, 2024

Choose a reason for hiding this comment

lrapoport-cf commented Aug 10, 2023 •

edited by CarmenPopoviciu

Loading

changeset-bot bot commented Aug 10, 2023 •

edited

Loading

github-actions bot commented Aug 11, 2023 •

edited

Loading

codecov bot commented Oct 24, 2023 •

edited

Loading

RamIdeas commented Nov 3, 2023 •

edited

Loading

RamIdeas commented Nov 3, 2023 •

edited

Loading

CarmenPopoviciu commented Feb 26, 2024 •

edited

Loading

CarmenPopoviciu commented Feb 26, 2024 •

edited

Loading

Meahaa commented Mar 6, 2024 •

edited

Loading

CarmenPopoviciu Jun 19, 2024 •

edited

Loading