Fix shared task styles.compile() when loadPaths don’t exist yet
#4516
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
Internally we use `require.resolve()` to find GOV.UK Frontend but Node.js throws “Cannot find module” when the package hasn’t been built yet We can use `packageTypeToPath()` instead
colinrotherham
added
the
🐛 bug
govuk-design-system-ci
temporarily deployed
to
govuk-frontend-pr-4516
📋 StatsFile sizes
Modules
View stats and visualisations on the review app Action run for 66080dc |
Prettier didn’t make the best choices here
govuk-design-system-ci
temporarily deployed
to
govuk-frontend-pr-4516
romaricpascal
approved these changes
Dec 1, 2023
| function packageTypeToPath(packageName, options = {}) { | ||
| const { modulePath, moduleRoot, type = 'commonjs' } = options | ||
|
|
||
| // Assume package.json is always resolvable |
There was a problem hiding this comment.
question Can a package prevent access to its package.json? If not, can we drop the "Assume", please, to avoid confusion when we read back this code in the future.
There was a problem hiding this comment.
Yeah sadly it can, so this is the correct comment 😔
With package exports you can quite easily lock yourself out from package.json access
So you'll often see it as a separate entry point:
https://github.com/isaacs/tshy?tab=readme-ov-file#exports
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.
This PR fixes a bug where a newly cloned repo can't run:
I've tweaked a bit of awful Prettier formatting and added some better comments too
Problem
For our Sass
loadPathswe userequire.resolve()viapackageResolveToPath()to locategovuk-frontendBut Node.js throws “Cannot find module” since
npm run build:packagehasn't been run yetSolution
We can use the
packageResolveToPath()packageTypeToPath()helper insteadThis helper was added when Node.js v17 couldn't use
require.resolve()in #3755