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

fix: update command descriptions and defaults #601

Merged
merged 1 commit into from
Apr 3, 2025

Conversation

BobbieGoede
Copy link
Member

πŸ”— Linked issue

❓ Type of change

  • πŸ“– Documentation (updates to the documentation or readme)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • πŸ‘Œ Enhancement (improving an existing functionality)
  • ✨ New feature (a non-breaking change that adds functionality)
  • 🧹 Chore (updates to the build process or auxiliary tools and libraries)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

πŸ“š Description

This is meant to further sync the documented descriptions and defaults as found on the Nuxt website, some of the changes rely on unreleased citty functionality, not trying to rush/force a release but just opening this PR so that these changes are available for others and for clarity with the PR for Nuxt's docs (nuxt/nuxt#30199).

@danielroe
Copy link
Member

would you be up for rebasing this? πŸ™

@BobbieGoede BobbieGoede force-pushed the docs/update-command-descriptions-defaults branch from 2dd2a64 to 86d7a8f Compare April 3, 2025 13:54
Copy link
Contributor

github-actions bot commented Apr 3, 2025

Bundle Stats β€” nuxt-cli size comparison

Hey there, this message comes from a GitHub action that helps you and reviewers to understand how these changes affect the size of this project's bundle.

As this PR is updated, I'll keep you updated on how the bundle size is impacted.

Total

Files count Total bundle size % Changed
30 83.86 kB β†’ 85.28 kB (+1.42 kB) +1.69%
Changeset
File Ξ” Size
home/runner/work/cli/cli/packages/nuxi/src/commands/generate.ts πŸ“ˆ +84 B (+21.65%) 388 B β†’ 472 B
home/runner/work/cli/cli/packages/nuxi/src/commands/dev.ts πŸ“ˆ +1.13 kB (+14.07%) 8.05 kB β†’ 9.18 kB
home/runner/work/cli/cli/packages/nuxi/src/commands/add.ts πŸ“ˆ +64 B (+3.22%) 1.94 kB β†’ 2 kB
home/runner/work/cli/cli/packages/nuxi/src/commands/analyze.ts πŸ“ˆ +89 B (+2.73%) 3.18 kB β†’ 3.27 kB
home/runner/work/cli/cli/packages/nuxi/src/commands/module/search.ts πŸ“ˆ +24 B (+0.80%) 2.94 kB β†’ 2.96 kB
home/runner/work/cli/cli/packages/nuxi/src/commands/upgrade.ts πŸ“ˆ +33 B (+0.52%) 6.25 kB β†’ 6.28 kB
View detailed bundle breakdown

Added

No assets were added

Removed

No assets were removed

Bigger

Asset File Size % Changed
chunks/dev.mjs 8.05 kB β†’ 9.18 kB (+1.13 kB) +14.07%
chunks/analyze.mjs 3.18 kB β†’ 3.27 kB (+89 B) +2.73%
chunks/generate.mjs 388 B β†’ 472 B (+84 B) +21.65%
chunks/add.mjs 6.83 kB β†’ 6.89 kB (+64 B) +0.91%
chunks/upgrade.mjs 6.25 kB β†’ 6.28 kB (+33 B) +0.52%
chunks/search.mjs 2.94 kB β†’ 2.96 kB (+24 B) +0.80%

Smaller

No assets were smaller

Unchanged

Asset File Size % Changed
index.mjs 224 B 0%
chunks/build.mjs 1.97 kB 0%
chunks/cleanup.mjs 471 B 0%
chunks/dev-child.mjs 2.29 kB 0%
chunks/devtools.mjs 763 B 0%
chunks/info.mjs 4.39 kB 0%
chunks/init.mjs 7.54 kB 0%
chunks/index.mjs 274 B 0%
chunks/prepare.mjs 984 B 0%
chunks/preview.mjs 3.22 kB 0%
chunks/test.mjs 1.16 kB 0%
chunks/typecheck.mjs 1.74 kB 0%
chunks/dev2.mjs 8.54 kB 0%
chunks/add2.mjs 10.48 kB 0%
shared/cli.Bs_tfqQV.mjs 5.5 kB 0%
shared/cli.Dr1-AgrT.mjs 804 B 0%
shared/cli.BnGOlRzw.mjs 294 B 0%
shared/cli.CvXMTUIz.mjs 1.23 kB 0%
shared/cli.BSm0_9Hr.mjs 107 B 0%
shared/cli.DFKm8SnQ.mjs 836 B 0%
shared/cli.DlcAx0De.mjs 1.04 kB 0%
shared/cli.CHOX_2my.mjs 1.72 kB 0%
shared/cli.BRvtDybo.mjs 78 B 0%
shared/cli.C935N1ss.mjs 687 B 0%

Copy link
Contributor

github-actions bot commented Apr 3, 2025

Bundle Stats β€” nuxi size comparison

Hey there, this message comes from a GitHub action that helps you and reviewers to understand how these changes affect the size of this project's bundle.

As this PR is updated, I'll keep you updated on how the bundle size is impacted.

Total

Files count Total bundle size % Changed
55 5.49 MB β†’ 5.49 MB (+879 B) +0.02%
Changeset
File Ξ” Size
node_modules/c12/dist/shared/c12.X4pJ8kft.mjs πŸ†• +2.5 kB 0 B β†’ 2.5 kB
src/commands/generate.ts πŸ“ˆ +84 B (+21.65%) 388 B β†’ 472 B
src/commands/dev.ts πŸ“ˆ +1.13 kB (+13.98%) 8.1 kB β†’ 9.23 kB
src/commands/add.ts πŸ“ˆ +64 B (+3.22%) 1.94 kB β†’ 2 kB
src/commands/analyze.ts πŸ“ˆ +89 B (+2.73%) 3.18 kB β†’ 3.27 kB
src/commands/module/search.ts πŸ“ˆ +24 B (+0.80%) 2.94 kB β†’ 2.96 kB
src/commands/upgrade.ts πŸ“ˆ +33 B (+0.52%) 6.25 kB β†’ 6.28 kB
node_modules/c12/dist/shared/c12.CEGFwQZa.mjs πŸ”₯ -3.06 kB (-100%) 3.06 kB β†’ 0 B
View detailed bundle breakdown

Added

Asset File Size % Changed
shared/nuxi.TVP5AJsM.mjs 0 B β†’ 14.64 kB (+14.64 kB) -

Removed

Asset File Size % Changed
shared/nuxi.Dza8Ny5q.mjs 15.2 kB β†’ 0 B (-15.2 kB) -100%

Bigger

Asset File Size % Changed
chunks/dev.mjs 8.1 kB β†’ 9.23 kB (+1.13 kB) +13.98%
chunks/analyze.mjs 3.18 kB β†’ 3.27 kB (+89 B) +2.73%
chunks/generate.mjs 388 B β†’ 472 B (+84 B) +21.65%
chunks/add.mjs 6.83 kB β†’ 6.89 kB (+64 B) +0.91%
chunks/upgrade.mjs 6.25 kB β†’ 6.28 kB (+33 B) +0.52%
chunks/search.mjs 45.83 kB β†’ 45.85 kB (+24 B) +0.05%

Smaller

No assets were smaller

Unchanged

Asset File Size % Changed
index.mjs 210 B 0%
chunks/prompt.mjs 42.91 kB 0%
chunks/build.mjs 1.97 kB 0%
chunks/cleanup.mjs 471 B 0%
chunks/dev-child.mjs 2.29 kB 0%
chunks/devtools.mjs 764 B 0%
chunks/info.mjs 4.39 kB 0%
chunks/init.mjs 663.66 kB 0%
chunks/index.mjs 274 B 0%
chunks/prepare.mjs 984 B 0%
chunks/preview.mjs 3.22 kB 0%
chunks/test.mjs 1.16 kB 0%
chunks/typecheck.mjs 1.74 kB 0%
chunks/satisfies.mjs 116 B 0%
chunks/main.mjs 15.3 kB 0%
chunks/index2.mjs 915.2 kB 0%
chunks/dev2.mjs 251.69 kB 0%
chunks/index3.mjs 17.14 kB 0%
chunks/index4.mjs 71.98 kB 0%
chunks/multipart-parser.mjs 5.11 kB 0%
chunks/add2.mjs 12.4 kB 0%
chunks/xdg-open.mjs 25.32 kB 0%
chunks/node.mjs 140.67 kB 0%
chunks/index5.mjs 1.23 kB 0%
chunks/index6.mjs 5.85 kB 0%
chunks/multipart-parser2.mjs 4.58 kB 0%
chunks/index7.mjs 886.24 kB 0%
shared/nuxi.CSptgxBl.mjs 76.33 kB 0%
shared/nuxi.DqkIr2yV.mjs 18.95 kB 0%
shared/nuxi.CDMTOway.mjs 804 B 0%
shared/nuxi.D379Yd9N.mjs 294 B 0%
shared/nuxi.CynwrLpQ.mjs 2.57 kB 0%
shared/nuxi.D2_bzAv0.mjs 1.54 kB 0%
shared/nuxi.h63hatje.mjs 4.07 kB 0%
shared/nuxi.BSm0_9Hr.mjs 107 B 0%
shared/nuxi.98PeB88r.mjs 836 B 0%
shared/nuxi.BxIDvNqq.mjs 1.34 kB 0%
shared/nuxi.DigSKSZu.mjs 25.34 kB 0%
shared/nuxi.C4l48OVX.mjs 2.02 MB 0%
shared/nuxi.D5KtpA0t.mjs 984 B 0%
shared/nuxi.BjhZEm2-.mjs 1.75 kB 0%
shared/nuxi.DwEL8L-T.mjs 715 B 0%
shared/nuxi.Kph9bHCN.mjs 26.94 kB 0%
shared/nuxi.BPxiWRC2.mjs 123.73 kB 0%
shared/nuxi.D4vggcPe.mjs 5.7 kB 0%
shared/nuxi.wIrae1ai.mjs 54.97 kB 0%
shared/nuxi.Do0aYBCO.mjs 5.46 kB 0%
shared/nuxi.jjur9XJH.mjs 43.55 kB 0%

Copy link
Contributor

github-actions bot commented Apr 3, 2025

Bundle Stats β€” create-nuxt size comparison

Hey there, this message comes from a GitHub action that helps you and reviewers to understand how these changes affect the size of this project's bundle.

As this PR is updated, I'll keep you updated on how the bundle size is impacted.

Total

Files count Total bundle size % Changed
49 5.92 MB β†’ 5.92 MB (+879 B) +0.01%
Changeset
File Ξ” Size
node_modules/c12/dist/shared/c12.X4pJ8kft.mjs πŸ†• +2.5 kB 0 B β†’ 2.5 kB
home/runner/work/cli/cli/packages/nuxi/src/commands/generate.ts πŸ“ˆ +84 B (+21.65%) 388 B β†’ 472 B
home/runner/work/cli/cli/packages/nuxi/src/commands/dev.ts πŸ“ˆ +1.13 kB (+13.98%) 8.1 kB β†’ 9.23 kB
home/runner/work/cli/cli/packages/nuxi/src/commands/add.ts πŸ“ˆ +64 B (+3.22%) 1.94 kB β†’ 2 kB
home/runner/work/cli/cli/packages/nuxi/src/commands/analyze.ts πŸ“ˆ +89 B (+2.73%) 3.18 kB β†’ 3.27 kB
home/runner/work/cli/cli/packages/nuxi/src/commands/module/search.ts πŸ“ˆ +24 B (+0.80%) 2.94 kB β†’ 2.96 kB
home/runner/work/cli/cli/packages/nuxi/src/commands/upgrade.ts πŸ“ˆ +33 B (+0.52%) 6.25 kB β†’ 6.28 kB
node_modules/c12/dist/shared/c12.CEGFwQZa.mjs πŸ”₯ -3.06 kB (-100%) 3.06 kB β†’ 0 B
View detailed bundle breakdown

Added

Asset File Size % Changed
shared/create-nuxt.ABTkms9b.mjs 0 B β†’ 14.64 kB (+14.64 kB) -

Removed

Asset File Size % Changed
shared/create-nuxt.7wzCLB1q.mjs 15.2 kB β†’ 0 B (-15.2 kB) -100%

Bigger

Asset File Size % Changed
chunks/dev.mjs 8.1 kB β†’ 9.23 kB (+1.13 kB) +13.98%
chunks/analyze.mjs 3.18 kB β†’ 3.27 kB (+89 B) +2.73%
chunks/generate.mjs 388 B β†’ 472 B (+84 B) +21.65%
chunks/add.mjs 6.83 kB β†’ 6.89 kB (+64 B) +0.91%
chunks/upgrade.mjs 6.25 kB β†’ 6.28 kB (+33 B) +0.52%
chunks/search.mjs 45.83 kB β†’ 45.85 kB (+24 B) +0.05%

Smaller

No assets were smaller

Unchanged

Asset File Size % Changed
index.mjs 1.07 kB 0%
chunks/multipart-parser.mjs 5.11 kB 0%
chunks/multipart-parser2.mjs 4.58 kB 0%
chunks/build.mjs 1.97 kB 0%
chunks/cleanup.mjs 471 B 0%
chunks/dev-child.mjs 2.29 kB 0%
chunks/devtools.mjs 764 B 0%
chunks/info.mjs 4.39 kB 0%
chunks/index.mjs 274 B 0%
chunks/prepare.mjs 984 B 0%
chunks/preview.mjs 3.22 kB 0%
chunks/test.mjs 1.16 kB 0%
chunks/typecheck.mjs 1.74 kB 0%
chunks/prompt.mjs 42.91 kB 0%
chunks/satisfies.mjs 116 B 0%
chunks/kit.mjs 1.34 kB 0%
chunks/index2.mjs 1.17 MB 0%
chunks/dev2.mjs 251.69 kB 0%
chunks/index3.mjs 17.14 kB 0%
chunks/index4.mjs 71.98 kB 0%
chunks/add2.mjs 12.4 kB 0%
chunks/xdg-open.mjs 25.32 kB 0%
chunks/node.mjs 140.67 kB 0%
chunks/index5.mjs 1.23 kB 0%
chunks/index6.mjs 6.25 kB 0%
chunks/index7.mjs 50.51 kB 0%
chunks/index8.mjs 5.85 kB 0%
chunks/index9.mjs 886.24 kB 0%
shared/create-nuxt.Cnc0B9Ka.mjs 961.2 kB 0%
shared/create-nuxt.vIGdhyxa.mjs 18.95 kB 0%
shared/create-nuxt.D052eicA.mjs 804 B 0%
shared/create-nuxt.BYvA_PAc.mjs 294 B 0%
shared/create-nuxt.BV3fL9w-.mjs 3.9 kB 0%
shared/create-nuxt.FuHYoJN8.mjs 4.07 kB 0%
shared/create-nuxt.BSm0_9Hr.mjs 107 B 0%
shared/create-nuxt.DZbvovWX.mjs 836 B 0%
shared/create-nuxt.BpLYnZfL.mjs 108.13 kB 0%
shared/create-nuxt.jjur9XJH.mjs 43.55 kB 0%
shared/create-nuxt.XLUPIWkb.mjs 2.02 MB 0%
shared/create-nuxt.BjhZEm2-.mjs 1.75 kB 0%
shared/create-nuxt.DnK9Crop.mjs 26.94 kB 0%
shared/create-nuxt.BBdEY2iV.mjs 715 B 0%

Copy link

pkg-pr-new bot commented Apr 3, 2025

Open in StackBlitz

npm i https://pkg.pr.new/create-nuxt@601
npm i https://pkg.pr.new/nuxi@601
npm i https://pkg.pr.new/@nuxt/cli@601

commit: 86d7a8f

@BobbieGoede
Copy link
Member Author

would you be up for rebasing this? πŸ™

@danielroe
Done! Note that this PR makes use of negativeDescription properties which is unreleased in citty

@BobbieGoede BobbieGoede marked this pull request as ready for review April 3, 2025 13:58
@BobbieGoede BobbieGoede requested a review from danielroe as a code owner April 3, 2025 13:58
@danielroe danielroe merged commit 3d15e91 into main Apr 3, 2025
11 checks passed
@danielroe danielroe deleted the docs/update-command-descriptions-defaults branch April 3, 2025 14:08
@github-actions github-actions bot mentioned this pull request Apr 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants