Skip to content

Cleanup: Package descriptions and keywords#32284

Merged
shilman merged 2 commits into
nextfrom
shilman/package-json-keywords
Aug 19, 2025
Merged

Cleanup: Package descriptions and keywords#32284
shilman merged 2 commits into
nextfrom
shilman/package-json-keywords

Conversation

@shilman
Copy link
Copy Markdown
Member

@shilman shilman commented Aug 17, 2025

Closes N/A

What I did

Clean up package descriptions & keywords across all packages in the monorepo

🦋 Canary release

This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

core team members can create a canary release here or locally with gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>

Greptile Summary

This PR systematically cleans up package metadata across 33 packages in the Storybook monorepo by standardizing descriptions and expanding keywords for better npm discoverability. The changes establish consistent patterns:

Description standardization: Most packages now follow the format "Storybook [Package Type]: [Action/Purpose]" (e.g., "Storybook CLI: Develop, document, and test UI components in isolation"). Framework packages use "Storybook for [Framework]: Develop, document, and test UI components in isolation" while addons use "Storybook [Addon Name]: [Specific functionality]".

Keyword expansion: Keywords are expanded from minimal sets (often just "storybook") to comprehensive arrays that include:

  • Package type identifiers (storybook-framework, storybook-addon, storybook-renderer, storybook-builder)
  • Technology-specific terms (framework names, build tools)
  • Generic discovery terms (component, components, cli, test)

The changes affect core packages (CLI tools, builders, renderers), framework integrations (React, Vue, Angular, Svelte, Next.js, etc.), and addons (a11y, docs, themes, etc.). All modifications are purely metadata improvements - no functional code, dependencies, or exports are changed, maintaining backward compatibility while improving package discoverability in npm searches.

Confidence score: 5/5

  • This PR is extremely safe to merge with no risk of breaking functionality
  • Score reflects that these are purely metadata changes with no code modifications, dependency updates, or API changes
  • No files require special attention as all changes follow consistent, low-risk patterns across the monorepo

@shilman shilman added documentation patch:yes Bugfix & documentation PR that need to be picked to main branch ci:docs Run the CI jobs for documentation checks only. labels Aug 17, 2025
Copy link
Copy Markdown
Contributor

@greptile-apps greptile-apps Bot left a comment

Choose a reason for hiding this comment

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

35 files reviewed, 1 comment

Edit Code Review Bot Settings | Greptile

Comment thread code/renderers/web-components/package.json Outdated
@nx-cloud
Copy link
Copy Markdown

nx-cloud Bot commented Aug 17, 2025

View your CI Pipeline Execution ↗ for commit 8b34b0a

Command Status Duration Result
nx run-many -t build --parallel=3 ✅ Succeeded 45s View ↗

☁️ Nx Cloud last updated this comment at 2025-08-19 02:28:53 UTC

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@shilman, I have a quick question about one item. The "Docs" addon (and probably others) still have the "essentials" keyword, and I was wondering if you'd be okay with removing it, as the "Essentials" addon is now technically part of core. Let me know, and we'll go from there.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I didn't remove that since I think it's still used by the addon catalog somehow

Comment thread code/renderers/vue3/package.json
Comment thread code/core/package.json
Comment thread code/addons/pseudo-states/package.json Outdated
Copy link
Copy Markdown
Contributor

@jonniebigodes jonniebigodes left a comment

Choose a reason for hiding this comment

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

@shilman took a pass at this and left some items for you to look into when you can; nothing is blocking.

Base automatically changed from shilman/readme-utm-params to next August 19, 2025 01:50
@shilman shilman force-pushed the shilman/package-json-keywords branch from 3646021 to 8b34b0a Compare August 19, 2025 02:05
@shilman shilman merged commit a24b910 into next Aug 19, 2025
9 checks passed
@shilman shilman deleted the shilman/package-json-keywords branch August 19, 2025 03:27
@ndelangen ndelangen changed the title Documentation: Clean up package descriptions and keywords Cleanup: Package descriptions and keywords Aug 20, 2025
ndelangen pushed a commit that referenced this pull request Aug 20, 2025
Documentation: Clean up package descriptions and keywords
(cherry picked from commit a24b910)
ndelangen pushed a commit that referenced this pull request Aug 20, 2025
Documentation: Clean up package descriptions and keywords
(cherry picked from commit a24b910)
ndelangen pushed a commit that referenced this pull request Aug 21, 2025
Documentation: Clean up package descriptions and keywords
(cherry picked from commit a24b910)
@github-actions github-actions Bot added the patch:done Patch/release PRs already cherry-picked to main/release branch label Aug 21, 2025
@ndelangen ndelangen removed the patch:yes Bugfix & documentation PR that need to be picked to main branch label Oct 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci:docs Run the CI jobs for documentation checks only. documentation patch:done Patch/release PRs already cherry-picked to main/release branch

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants