fix: Changed type for design token print-page-size #3388

PKulkoRaccoonGang · 2025-01-23T06:50:41Z

Description

This PR provides changes to correct the correct building of the token design.

Changed type for design token print-page-size from dimension to text.
Improved logging of Paragon CLI command errors.

More details: #3389

Merge Checklist

If your update includes visual changes, have they been reviewed by a designer? Send them a link to the Netlify deploy preview, if applicable.
Does your change adhere to the documented style conventions?
Do any prop types have missing descriptions in the Props API tables in the documentation site (check deploy preview)?
Were your changes tested using all available themes (see theme switcher in the header of the deploy preview, under the "Settings" icon)?
Were your changes tested in the example app?
Is there adequate test coverage for your changes?
Consider whether this change needs to reviewed/QA'ed for accessibility (a11y). If so, please request an a11y review for the PR in the #wg-paragon Open edX Slack channel.

Post-merge Checklist

Verify your changes were released to NPM at the expected version.
If you'd like, share your contribution in #show-and-tell.
🎉 🙌 Celebrate! Thanks for your contribution.

openedx-webhooks · 2025-01-23T06:50:47Z

Thanks for the pull request, @PKulkoRaccoonGang!

This repository is currently maintained by @openedx/paragon-working-group.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
- This process (including the steps you'll need to take) is documented here.
If it doesn't, simply proceed with the next step.

🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

Dependencies

This PR must be merged before / after / at the same time as ...
Blockers

This PR is waiting for OEP-1234 to be accepted.
Timeline information

This PR must be merged by XX date because ...
Partner information

This is for a course on edx.org.
Supporting documentation
Relevant Open edX discussion forum threads

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

The size and impact of the changes that it introduces
The need for product review
Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

netlify · 2025-01-23T06:50:59Z

✅ Deploy Preview for paragon-openedx-v23 ready!

Name	Link
🔨 Latest commit	`f99960d`
🔍 Latest deploy log	https://app.netlify.com/sites/paragon-openedx-v23/deploys/67935ff99fb0980008fd5a19
😎 Deploy Preview	https://deploy-preview-3388--paragon-openedx-v23.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

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

PKulkoRaccoonGang · 2025-01-23T06:52:23Z

bin/paragon-scripts.js

@@ -218,7 +218,7 @@ const COMMANDS = {
    sendTrackInfo('openedx.paragon.cli-command.used', { command, status: 'success' });
  } catch (error) {
    // eslint-disable-next-line no-console
-    console.error(chalk.red.bold('An error occurred:', error.message));
+    console.error(chalk.red.bold('An error occurred:', error));


Before

After

codecov · 2025-01-23T07:06:58Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.88%. Comparing base (81a0abf) to head (f99960d).
Report is 3 commits behind head on release-23.x.

Additional details and impacted files

@@              Coverage Diff              @@
##           release-23.x    #3388   +/-   ##
=============================================
  Coverage         93.87%   93.88%           
=============================================
  Files               232      232           
  Lines              3937     3943    +6     
  Branches            933      901   -32     
=============================================
+ Hits               3696     3702    +6     
  Misses              237      237           
  Partials              4        4

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

PKulkoRaccoonGang · 2025-01-23T07:41:03Z

tokens/src/core/global/other.json

+  "print-page-size": {
+    "source": "$print-page-size",
+    "$value": "a3",
+    "$type": "text"


I agree with the previous use of the dimension type for the print-page-size design token. However, I believe this type contradicts the documented description of the dimension type provided by the DTCG.

brian-smith-tcril · 2025-01-23T14:34:18Z

After reading through #3389

After some research, I discovered that when packages are installed in Paragon, Style Dictionary version 4.0.1 is used. However, if Paragon is installed as an NPM package, the latest published minor version of Style Dictionary (4.3.2) is added to the dependencies.

stood out to me. If nothing else we should update package-lock.json to get style-dictionary to use 4.3.2 (I'd think dependabot would pick that up but I haven't seen a dependabot PR updating the style-dictionary version) but we can definitely update package.json to have ^4.3.2 instead of ^4.0.1 and run npm install.

The more concerning thing is that it sounds like the minor version bump in style-dictionary included a breaking change. It may be worth considering setting the version in package.json to ~4.3.2 so MFEs only get patch version updates.

PKulkoRaccoonGang · 2025-01-24T10:27:39Z

we can definitely update package.json to have ^4.3.2 instead of ^4.0.1 and run npm install.

I chose this option, if in the future we have similar problems we can always upgrade to the latest patch version (~4.3.x)

PKulkoRaccoonGang · 2025-01-24T10:30:06Z

styles/css/themes/light/variables.css

After the update, the order of the variables in the files with the CSS has changed and units of measurement for 0 have been added (in sizes where necessary)

PKulkoRaccoonGang self-assigned this Jan 23, 2025

openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Jan 23, 2025

PKulkoRaccoonGang commented Jan 23, 2025

View reviewed changes

PKulkoRaccoonGang marked this pull request as ready for review January 23, 2025 07:46

PKulkoRaccoonGang requested review from adamstankiewicz, ihor-romaniuk and brian-smith-tcril January 23, 2025 07:51

PKulkoRaccoonGang changed the title ~~fix: fixed design tokens build~~ fix: Changed type for design token print-page-size Jan 23, 2025

brian-smith-tcril approved these changes Jan 23, 2025

View reviewed changes

fix: fixed design tokens build

c21d231

PKulkoRaccoonGang commented Jan 24, 2025

View reviewed changes

PKulkoRaccoonGang requested a review from brian-smith-tcril January 24, 2025 10:30

refactor: updated style-dictionary version

f99960d

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: Changed type for design token print-page-size #3388

fix: Changed type for design token print-page-size #3388

PKulkoRaccoonGang commented Jan 23, 2025 •

edited

Loading

openedx-webhooks commented Jan 23, 2025 •

edited

Loading

🔘 Get product approval

🔘 Provide context

🔘 Get a green build

Where can I find more information?

When can I expect my changes to be merged?

netlify bot commented Jan 23, 2025 •

edited

Loading

PKulkoRaccoonGang Jan 23, 2025

codecov bot commented Jan 23, 2025 •

edited

Loading

PKulkoRaccoonGang Jan 23, 2025

brian-smith-tcril commented Jan 23, 2025

PKulkoRaccoonGang commented Jan 24, 2025 •

edited

Loading

PKulkoRaccoonGang Jan 24, 2025

fix: Changed type for design token print-page-size #3388

Are you sure you want to change the base?

fix: Changed type for design token print-page-size #3388

Conversation

PKulkoRaccoonGang commented Jan 23, 2025 • edited Loading

Description

Merge Checklist

Post-merge Checklist

openedx-webhooks commented Jan 23, 2025 • edited Loading

🔘 Get product approval

🔘 Provide context

🔘 Get a green build

Where can I find more information?

When can I expect my changes to be merged?

netlify bot commented Jan 23, 2025 • edited Loading

✅ Deploy Preview for paragon-openedx-v23 ready!

PKulkoRaccoonGang Jan 23, 2025

Choose a reason for hiding this comment

codecov bot commented Jan 23, 2025 • edited Loading

Codecov Report

PKulkoRaccoonGang Jan 23, 2025

Choose a reason for hiding this comment

brian-smith-tcril commented Jan 23, 2025

PKulkoRaccoonGang commented Jan 24, 2025 • edited Loading

PKulkoRaccoonGang Jan 24, 2025

Choose a reason for hiding this comment

PKulkoRaccoonGang commented Jan 23, 2025 •

edited

Loading

openedx-webhooks commented Jan 23, 2025 •

edited

Loading

netlify bot commented Jan 23, 2025 •

edited

Loading

codecov bot commented Jan 23, 2025 •

edited

Loading

PKulkoRaccoonGang commented Jan 24, 2025 •

edited

Loading