refactor: [BD-46] Component generator refactoring #3076
Conversation
|
Thanks for the pull request, @PKulkoRaccoonGang! When this pull request is ready, tag your edX technical lead. |
openedx-webhooks
added
the
blended
✅ Deploy Preview for paragon-openedx ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## alpha #3076 +/- ##
=======================================
Coverage 93.68% 93.68%
=======================================
Files 229 229
Lines 3740 3740
Branches 876 905 +29
=======================================
Hits 3504 3504
+ Misses 232 231 -1
- Partials 4 5 +1 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
This is looking great! I left a couple suggestions about linking to the tokens readme instead of having tokens information outside of there. Those are just suggestions, if you feel it makes more sense to keep the information where it is now I'm not opposed to that idea.
README.md
Outdated
| If you wish to use CSS variables (which is the preferred way of styling the components since values can be | ||
| easily overridden and customized by the consumers of Paragon), create specific design tokens in `tokens` directory (in the `core` and `themes` directories) and then generate (`npm run build-tokens`) CSS variables for your component. |
There was a problem hiding this comment.
I think it'd be nice to keep the design token documentation in the tokens directory and link to it instead.
| If you wish to use CSS variables (which is the preferred way of styling the components since values can be | |
| easily overridden and customized by the consumers of Paragon), create specific design tokens in `tokens` directory (in the `core` and `themes` directories) and then generate (`npm run build-tokens`) CSS variables for your component. | |
| If you wish to use CSS variables (which is the preferred way of styling the components since values can be | |
| easily overridden and customized by the consumers of Paragon), you can do so by utilizing [design tokens](/tokens). |
this way we can keep the documentation in one place and we don't need to remember all the places it needs to be updated if it is changed.
There was a problem hiding this comment.
I edited it, thanks! Your proposal looks more concise 💯
| If you wish to use CSS variables (which is the preferred way of styling the components since values can be | ||
| easily overridden and customized by the consumers of Paragon), create specific design tokens in `tokens` directory (in the `core` and `themes` directories) and then generate (`npm run build-tokens`) CSS variables for your component. |
There was a problem hiding this comment.
| If you wish to use CSS variables (which is the preferred way of styling the components since values can be | |
| easily overridden and customized by the consumers of Paragon), create specific design tokens in `tokens` directory (in the `core` and `themes` directories) and then generate (`npm run build-tokens`) CSS variables for your component. | |
| If you wish to use CSS variables (which is the preferred way of styling the components since values can be | |
| easily overridden and customized by the consumers of Paragon), you can do so by utilizing [design tokens](/tokens). |
same suggestion as before
There was a problem hiding this comment.
Same, thanks
|
🎉 This PR is included in version 23.0.0-alpha.2 🎉 The release is available on: Your semantic-release bot 📦🚀 |
|
🎉 This PR is included in version 23.0.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Description
Since the file structure of Paragon components has changed, the component generator was refactored
_variables.scsshas been removed from the templatecomponent-generatordirectory was excluded fromstylelintcheckingMerge Checklist
exampleapp?Post-merge Checklist