Refactor design system code#1318
Merged
Merged
Conversation
✅ Deploy Preview for antenna-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for antenna-ssec ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
|
Important Review skippedToo many files! This PR contains 288 files, which is 138 over the limit of 150. To get a review, narrow the scope: ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: ⛔ Files ignored due to path filters (12)
📒 Files selected for processing (288)
You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This is a big refactoring PR where we update the frontend code to make it easier to work with and for better consistency. All design system related code has been moved from an external repository and can now be found in
ui/nova-ui-kit. In this PR, we also streamline colors, text styles, breakpoints and UI primitive imports. Since we want to support using the design system from both TypeScript and SCSS, but avoid repeating constants, we are also including some updates to build scripts in this PR. We now finally have once source of truth for colors, etc.!For more information about the design system, see the updated README!
Why not an external module for the design system?
We had ambitions to handle the design system as an external module, to make it possible to use this code across projects, not only for Antenna. In theory it's a good idea to separate this code, however in practice, this has made updates more clunky to handle (we have to publish a new version of the module to NPM for each update) and code fragmented. Also, no other active project is currently using the design system code. To summarize, a lot of work for a small win! In future, when the design system is more stable and if the team has more capacity, we could revisit the idea. For now, let's keep things simple. All design system related code is now merged into this repository and can be found in
ui/nova-ui-kit.Archives
They can both be activated later, but this will mark them as deprecated for users.