Switch to modern Sass api #595
Merged
Conversation
This file contains 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
We were previously using the 'legacy' Sass API, which is deprecated. This commit switches to the modern version This will cause some assets not to build properly - this is [a known issue](https://trello.com/c/pfzCTVnB/2066-investigate-asset-building-issue-with-modern-sass-api) which we'll solve in an upcoming commit.
There's a bug in the way Vite's inbuilt sass importing works that means some of our assets don't build properly if we import the govuk-frontend styles using the @GOVUK alias. We can get around this by using Sass's builtin NodEpackageImporter to import the govuk-frontend styles. This bypasses the Vite import code that causes the issue. It's also better for a couple of other reasons. It makes it clear that this import is coming from an npm package (which was obscured slightly when we were using the alias). It also makes us resilient to structure changes in the govuk-frontend package (NodePackageImporter uses the 'sass' field in govuk-frontend's package.json to determine the file to import, so we no longer need to point to a specific file which could change).
These files were being imported twice unnecessarily - this commit removes the duplicates.
We were configuring both $govuk-fonts-path and $govuk-images-path. This was overly verbose, since for our folder structure we can configure $govuk-assets-path and it will generate values for $govuk-fonts-path and $govuk-images-path identical to those we were passing in.
DavidBiddle
force-pushed
the
switch-to-modern-sass-api
branch
from
7c54090 to
319986d
Compare
thomasiles
reviewed
Jan 13, 2025
thomasiles
approved these changes
Jan 13, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What problem does this pull request solve?
Trello card: https://trello.com/c/pfzCTVnB/2066-investigate-asset-building-issue-with-modern-sass-api
We were seeing an issue with assets failing to build properly using the 'modern' Sass API. After investigating this appears to be caused by a bug in the Vite internal sass importer (vitejs/vite#19196).
This PR:
Things to consider when reviewing