Warn if importing core, overrides without dependencies #1807
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
govuk-design-system-ci
temporarily deployed
to
govuk-frontend-review-pr-1807
36degrees
force-pushed
the
warn-import-core-overrides-without-dependencies
branch
from
db88ee4 to
6c79763
Compare
govuk-design-system-ci
temporarily deployed
to
govuk-frontend-review-pr-1807
Add deprecation warnings if users import files from the core and overrides layers without first importing the settings, helpers and tools layers. We'll remove the imports of "base" from files in these layers in 4.0[1], so this will no longer work. [1]: #1800
36degrees
force-pushed
the
warn-import-core-overrides-without-dependencies
branch
from
6c79763 to
7557564
Compare
|
@m-green it'd be good to get your thoughts on the deprecation notice we're using:
|
hannalaakso
reviewed
May 13, 2020
There was a problem hiding this comment.
I noticed that I don't see a warning as long as I import just one of /tools/all or /helpers/all (and no warning if I neglect to import /settings/all). This is an edge case but you wouldn't see a warning if you were already doing
@import "govuk-frontend/govuk/helpers/all";
@import "govuk-frontend/govuk/core/global-styles";
|
I think that's probably OK as an edge case, as it should also be communicated in the release notes (which should probably be done as part of this PR) and in the release notes for 4.0 when it goes out? Thoughts? |
hannalaakso
approved these changes
May 13, 2020
There was a problem hiding this comment.
Thanks @36degrees yes I think that makes sense, just wanted to flag it as something to be aware of.
Nice work with getting this done 👍
36degrees
changed the title
36degrees
added a commit
that referenced
this pull request
May 20, 2020
Merged
36degrees
added a commit
that referenced
this pull request
Dec 2, 2021
Importing files from this layer without first importing the 'base' file was deprecated in #1807. Anyone who was relying on the import should already be seeing warnings. If this change affects them, they'll just need to ensure they're importing the base layer first. This is part of a change to the way that the base layers (settings, tools and helpers) are imported within different parts of GOV.UK Frontend’s Sass, designed to reduce the time it takes to compile the Sass to CSS. Remove the tests, which were only checking that the deprecation warning was emitted as expected.
36degrees
added a commit
that referenced
this pull request
Dec 2, 2021
Importing files from this layer without first importing the 'base' file was deprecated in #1807. Anyone who was relying on the import should already be seeing warnings. If this change affects them, they'll just need to ensure they're importing the base layer first. This is part of a change to the way that the base layers (settings, tools and helpers) are imported within different parts of GOV.UK Frontend’s Sass, designed to reduce the time it takes to compile the Sass to CSS. Remove the tests, which were only checking that the deprecation warning was emitted as expected.
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.
Add deprecation warnings if users import files from the core and overrides layers without first importing the settings, helpers and tools layers.
We'll remove the imports of "base" from files in these layers in 4.0, so this will no longer work.
Closes #1798