Update package helpers to support govuk-frontend@4
#3757
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
colinrotherham
changed the title
govuk-frontend@4govuk-frontend@4
colinrotherham
force-pushed
the
package-resolver
branch
from
72779c0 to
fd93e21
Compare
colinrotherham
changed the title
govuk-frontend@4govuk-frontend@4
colinrotherham
commented
Jun 6, 2023
shared/tasks/styles.mjs
Outdated
| @@ -81,8 +87,8 @@ export async function compileStylesheet ([modulePath, { configPath, srcPath, des | |||
|
|
|||
| // Resolve @imports via | |||
| loadPaths: [ | |||
| packageNameToPath('govuk-frontend', 'dist'), | |||
| join(paths.root, 'node_modules') | |||
| packageNameToPath('govuk-frontend', 'dist', { requirePaths }), | |||
There was a problem hiding this comment.
Should we need it, this line ensures govuk-frontend is resolved locally from the review app first
colinrotherham
force-pushed
the
package-resolver
branch
from
fd93e21 to
5eb1e82
Compare
colinrotherham
force-pushed
the
package-resolver
branch
from
5eb1e82 to
ffad4e3
Compare
colinrotherham
force-pushed
the
glob-syntax
branch
from
8f3e8c2 to
41f9c77
Compare
colinrotherham
force-pushed
the
package-resolver
branch
2 times, most recently
from
620a851 to
4071c94
Compare
There was a problem hiding this comment.
Nice to be able to pick our version of GOV.UK frontend and good path for resolving things like import.meta.resolve 🙌🏻 Just a couple of suggestions that I think would help us touch this area of the code more easily going forward (one for naming and one for the resolving)? No worries if they miss the mark completely though.
Preparation work to simplify how we call our package helpers, options param coming soon
Used to resolve a package’s main entry point path by name, or by resolving a full entry path using `require.resolve()` against the package’s exports
Whilst Node.js `import.meta.resolve()` is flagged experimental, this helper enables `module` field access for ES modules
Allows us to switch between `govuk-frontend@5` and `govuk-frontend@5` without issue
Node.js `require.resolve()` paths are optionally provided, for example: 1. Review app uses local `node_modules` before project level 2. Package stats uses local `node_modules` before project level This is necessary for workspace `govuk-frontend@4` installs to be found
colinrotherham
force-pushed
the
package-resolver
branch
from
4071c94 to
9278d1e
Compare
romaricpascal
approved these changes
Jun 9, 2023
Comment on lines
+81
to
+103
| /** | ||
| * Return path to package entry from any npm workspace, by type | ||
| * | ||
| * Wraps {@link packageResolveToPath} to allow the appended `modulePath` to | ||
| * include unresolvable paths, globs or files that are not yet built | ||
| * | ||
| * {@link https://github.com/alphagov/govuk-frontend/issues/3755} | ||
| * | ||
| * @example | ||
| * Resolving components relative to a default package entry | ||
| * | ||
| * - GOV.UK Frontend v4 './govuk/components/accordion/accordion.mjs' | ||
| * - GOV.UK Frontend v5 './dist/govuk/components/accordion/accordion.mjs' | ||
| * | ||
| * ```mjs | ||
| * const templatePath = packageResolveToPath('govuk-frontend', { | ||
| * modulePath: `components/accordion/accordion.mjs` | ||
| * }) | ||
| * ``` | ||
| * @param {string} packageName - Installed npm package name | ||
| * @param {PackageOptions} [options] - Package resolution options | ||
| * @returns {string} Path to installed npm package field | ||
| */ |
There was a problem hiding this comment.
Super neat and nice solution for the naming as well 😍
colinrotherham
added a commit
that referenced
this pull request
Jul 19, 2023
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 updates our
require.resolve()package resolution to work with GOV.UK Frontend v4As a workaround for #3755 packageTypeToPath() can resolve paths via the
mainormodulefields insteadRollup stats for old releases
Package stats can now be built for
govuk-frontend@4as shown on branchpackage-resolver-v4Note: It's necessary to bump our workspace
govuk-frontendto v5.0.0 to avoid conflict