You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
Make tasks/process-spectrum more robust to changes in CSS theme overrides. This is needed for the upcoming component icon and component CSS dependency updates, to make sure we don't leave stale files behind!
Motivation and context
The CSS pulled from the latest s2-foundations-redux branch no longer defined several theme-specific variables that had been present in earlier released versions of the CSS components used by SWC (likely because they were no longer necessary - great!).
The logic in SWC’s tasks/process-spectrum script was not designed to handle cases where previously existing CSS theme files were removed. Specifically, process-spectrum skipped writing *-overrides.css files for missing or empty theme files. While this seems logical, it created issues by leaving behind outdated (or “stale”) *-overrides.css files when corresponding theme files were removed.
To fix this, I updated the logic in process-spectrum to always write *-overrides.css files, even for empty or removed theme files, which successfully resolved the issue.
If my change required a change to the documentation, I have updated the documentation in this pull request.
I have read the CONTRIBUTING document.
I have added tests to cover my changes.
All new and existing tests passed.
I have reviewed at the Accessibility Practices for this feature, see: Aria Practices
Best practices
This repository uses conventional commit syntax for each commit message; note that the GitHub UI does not use this by default so be cautious when accepting suggested changes. Avoid the "Update branch" button on the pull request and opt instead for rebasing your branch against main.
Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.
If the changes are expected, update the current_golden_images_cache hash in the circleci config to accept the new images. Instructions are included in that file.
If the changes are unexpected, you can investigate the cause of the differences and update the code accordingly.
Lighthouse scores comparing the documentation site built from the PR ("Branch") to that of the production documentation site ("Latest") and the build currently on main ("Main"). Higher scores are better, but note that the SEO scores on Netlify URLs are artifically constrained to 0.92.
rubencarvalho
changed the title
Ruben/improve process spectrum
chore(tooling): make process-spectrum more robust
Feb 6, 2025
rubencarvalho
changed the title
chore(tooling): make process-spectrum more robust
chore(tooling): make process-spectrum more robust and always generate overrides
Feb 6, 2025
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.
rubencarvalho
force-pushed
the
ruben/improve-process-spectrum
branch
from
Description
Make
tasks/process-spectrummore robust to changes in CSS theme overrides. This is needed for the upcoming component icon and component CSS dependency updates, to make sure we don't leave stale files behind!Motivation and context
s2-foundations-reduxbranch no longer defined several theme-specific variables that had been present in earlier released versions of the CSS components used by SWC (likely because they were no longer necessary - great!).tasks/process-spectrumscript was not designed to handle cases where previously existing CSS theme files were removed. Specifically,process-spectrumskipped writing*-overrides.cssfiles for missing or empty theme files. While this seems logical, it created issues by leaving behind outdated (or “stale”)*-overrides.cssfiles when corresponding theme files were removed.To fix this, I updated the logic in
process-spectrumto always write*-overrides.css files, even for empty or removed theme files, which successfully resolved the issue.Picked up from #4999 draft.
How has this been tested?
Types of changes
Checklist
Best practices
This repository uses conventional commit syntax for each commit message; note that the GitHub UI does not use this by default so be cautious when accepting suggested changes. Avoid the "Update branch" button on the pull request and opt instead for rebasing your branch against
main.