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.

Sign up for GitHub

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

Jump to bottom

Fix Broken CSS Export in Design Tokens Package #609

Merged
merged 1 commit into from
Feb 2, 2024
Merged

Fix Broken CSS Export in Design Tokens Package #609

merged 1 commit into from
Feb 2, 2024

Conversation

georgewrmarshall
Copy link
Collaborator

@georgewrmarshall georgewrmarshall commented Feb 2, 2024 •
edited
Loading

Description

This PR addresses the issue of the broken CSS export in the design tokens package that occurred after the v2 release. The fix ensures that the CSS export functions correctly and can be used without issues in projects that depend on it.

Related issues

Fixes: #608

Manual testing steps

  1. Pull this branch
  2. In the root folder run npm pack this creates a tarball of the same format that would be sent to the registry
  3. Inspect the tarbal to see the CSS file included

Screenshots/Recordings

Before

Running npm pack before update

before.mov

After

Running npm pack after update and inspecting folder

after.mov

Pre-merge author checklist

  • I’ve followed MetaMask Coding Standards.
  • I've clearly explained what problem this PR is solving and how it is solved.
  • I've linked related issues
  • I've included manual testing steps
  • I've included screenshots/recordings if applicable
  • I’ve included tests if applicable
  • I’ve documented my code using JSDoc format if applicable
  • I’ve applied the right labels on the PR (see labeling guidelines). Not required for external contributors.
  • I’ve properly set the pull request status:
    • In case it's not yet "ready for review", I've set it to "draft".
    • In case it's "ready for review", I've changed it from "draft" to "non-draft".

Pre-merge reviewer checklist

  • I've manually tested the PR (e.g. pull and build branch, run the app, test code being changed).
  • I confirm that this PR addresses all acceptance criteria described in the ticket it closes and includes the necessary testing evidence such as recordings and or screenshots.

@georgewrmarshall georgewrmarshall self-assigned this Feb 2, 2024
@georgewrmarshall georgewrmarshall added the team-design-system All issues relating to design system label Feb 2, 2024
@georgewrmarshall georgewrmarshall marked this pull request as ready for review February 2, 2024 21:05
@georgewrmarshall georgewrmarshall requested a review from a team as a code owner February 2, 2024 21:05
georgewrmarshall
georgewrmarshall commented Feb 2, 2024
View reviewed changes
constraints.pro
@@ -81,7 +81,7 @@ gen_enforced_field(WorkspaceCwd, 'exports["./package.json"]', './package.json').

% The list of files included in the package must only include files generated
% during the build step.
gen_enforced_field(WorkspaceCwd, 'files', ['dist']).
gen_enforced_field(WorkspaceCwd, 'files', ['dist', 'src/css/']).

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This lints the package.json folder when running yarn lint

@georgewrmarshall georgewrmarshall mentioned this pull request Feb 2, 2024
Merged
georgewrmarshall
georgewrmarshall commented Feb 2, 2024
View reviewed changes
package.json
@@ -27,7 +27,8 @@
"module": "./dist/index.mjs",
"types": "./dist/types/index.d.ts",
"files": [
"dist"
"dist",
"src/css/"
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Originally how we had it before v2 update https://github.com/MetaMask/design-tokens/pull/601/files#r1476736756

@georgewrmarshall georgewrmarshall merged commit 78e8692 into main Feb 2, 2024
17 checks passed
@georgewrmarshall georgewrmarshall deleted the fix/608/css-exports branch February 2, 2024 21:14
This was referenced Feb 6, 2024
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@garrettbear garrettbear garrettbear approved these changes

@brianacnguyen brianacnguyen Awaiting requested review from brianacnguyen

Assignees

@georgewrmarshall georgewrmarshall

Labels
team-design-system All issues relating to design system
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Fix Broken CSS Export in Design Tokens Package
2 participants
@georgewrmarshall @garrettbear