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

Standardize package file name exports #4700

Merged
merged 11 commits into from
Jan 17, 2025
Merged

Standardize package file name exports #4700

merged 11 commits into from
Jan 17, 2025

Conversation

taysea
Copy link
Collaborator

@taysea taysea commented Jan 16, 2025

Deploy Preview

What does this PR do?

This PR adjusts file name exports to:

  • Rename default mode of "primitives" from "base" --> "default" (base is a category of token). Also updates the filename exports from "base.js" --> "primitives.js", etc.
  • Removes "default" from CJS/ESM component token exports ("components.default.cjs" --> "components.js")
  • Remove light/dark, medium/small modes from ESM/CommonJS exports. Now that these just return CSS variable refs, we don't need separate mode exports. "color.light.js --> color.js"

TO DO:

  • Determine if we want "primitives" and "components" export to be plural or singular

Where should the reviewer start?

What testing has been done on this PR?

In addition to the feature you are implementing, have you checked the following:

General UX Checks

  • Small, medium, and large screen sizes
  • Cross-browsers (FireFox, Chrome, and Safari)
  • Light & dark modes
  • All hyperlinks route properly

Accessibility Checks

  • Keyboard interactions
  • Screen reader experience
  • Run WAVE accessibility plugin (Chrome)

Code Quality Checks

  • Console is free of warnings and errors
  • Passes E2E commit checks
  • Visual snapshots are reasonable

How should this be manually tested?

Any background context you want to provide?

Closes #4665

What are the relevant issues?

Screenshots (if appropriate)

Should this PR be mentioned in Design System updates?

Is this change backwards compatible or is it a breaking change?

Copy link

changeset-bot bot commented Jan 16, 2025

🦋 Changeset detected

Latest commit: 2f5f7b2

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

This PR includes changesets to release 1 package
Name Type
hpe-design-tokens Minor

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

@taysea taysea requested a review from halocline January 16, 2025 19:35
Base automatically changed from update-color-names to master January 16, 2025 21:25
Copy link

netlify bot commented Jan 16, 2025

Deploy Preview for unrivaled-bublanina-3a9bae ready!

Name Link
🔨 Latest commit 2f5f7b2
🔍 Latest deploy log https://app.netlify.com/sites/unrivaled-bublanina-3a9bae/deploys/67899ae0215b7d0008c42d52
😎 Deploy Preview https://deploy-preview-4700--unrivaled-bublanina-3a9bae.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@taysea taysea merged commit 66ca9da into master Jan 17, 2025
10 of 12 checks passed
@taysea taysea deleted the standardize-file-names branch January 17, 2025 22:07
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.

Simplify and standardize package output file names
2 participants