refactor: Clean up USWDS directory and imports #1592
Conversation
✅ Deploy Preview for veda-ui ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
for consistency and better overview
|
@AliceR This was not introduced in this PR, but I'm curious about why do we need to rename components from USWDS instead of just using the directly. In the |
There was a problem hiding this comment.
I'm fine with this and have no strong opinions on if we move the uswds dir outside of the common dir. But I did tag @hanbyul-here too in case she might have a stronger opinion.
|
@vgeorge - If I remember correctly (please correct me if I am wrong) , the initial intention of having mid-layer was that even if we change the library in the future again, the end component doesn't have to change import syntax. If we look at the current context, let's say we want to change Button (which is from ui library), if the Button was encapsulated in the separate file, we can do whatever prop change in that midlayer and pass it to the component from the new library. The initial thought is documented in this PR: #1031 (comment) @AliceR Since it is a PR that mainly changes the paths, I am guessing what you are looking for from review is an opinion . It seems a bit difficult to form an opinion on cleaning for me. Can you list more of the benefits we can get from this folder structure? What is the bigger initiative that we should foresee from this change? |
|
@hanbyul-here Thanks for the question! The reason for moving the uswds folder is to better organize our project and improve maintainability. Right now, it’s mixed with legacy files and newer components, making it harder to navigate and find the right pieces. By separating it out, we clarify the distinction between apples and oranges, which improves discoverability and reduces cognitive load. This is just a small first step—future changes will include auditing legacy files, refining the folder structure, and potentially documenting conventions for better consistency moving forward. Happy to discuss further if needed! |
Related Ticket: no ticket
Description of Changes
As part of a bigger cleanup initiative I would like to propose that we move the /uswds directory outside of the current components/common/... structure. This is essentially just a renaming of files, and updating the imports that were not previously referencing the $uswds alias. The reason bring just general cleanup and better separation.
Notes & Questions About Changes
There should be no changes to any rendering or build processes! It is just an organizational change.
💖 For easier review, please inspect the changes commit by commit!!
Validation / Testing