Support package exports #6125
Merged
Support package exports #6125
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
hardhatTotal size of the bundle: List of dependencies (sorted by size) |
antico5
force-pushed
the
support-package-exports
branch
from
fd95d70 to
58f0de7
Compare
alcuadrado
reviewed
Jan 10, 2025
v-next/hardhat-utils/src/package.ts
Outdated
Comment on lines
128
to
129
| await fs.promises.access(packageJsonPath, fs.constants.R_OK); | ||
| return await fs.promises.realpath(packageJsonPath); |
There was a problem hiding this comment.
This should use the utils' fs module
alcuadrado
reviewed
Jan 10, 2025
v-next/hardhat-utils/src/package.ts
Outdated
| * @param packageName the name of the package to find | ||
| * @returns the absolute real path (resolved symlinks) of the package.json | ||
| */ | ||
| export async function findPackageJson( |
There was a problem hiding this comment.
We should at at least one or two tests of this
alcuadrado
reviewed
Jan 10, 2025
| @@ -1,3 +1,5 @@ | |||
| import type { Exports } from "resolve.exports"; | |||
There was a problem hiding this comment.
We should duplicate this type to avoid re-exporting a dependency type
|
Note to self: Double check that this situation: where and throws that "foo/a.sol" doesn't exist, and not "foo/src/a.sol". |
alcuadrado
force-pushed
the
support-package-exports
branch
from
58f0de7 to
f9e48a6
Compare
kanej
added
status:ready
alcuadrado
force-pushed
the
support-package-exports
branch
from
f9e48a6 to
15df2d3
Compare
|
@antico5: my changes are ready to review |
alcuadrado
force-pushed
the
support-package-exports
branch
from
5f73110 to
2133592
Compare
alcuadrado
force-pushed
the
support-package-exports
branch
from
096846c to
9543f4e
Compare
alcuadrado
approved these changes
Jan 31, 2025
alcuadrado
force-pushed
the
support-package-exports
branch
from
9543f4e to
2980898
Compare
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 adds support for package.json#exports for packages that distribute solidity files.
Implementation details:
npm/[email protected]/Foo.solinstead ofnpm/[email protected]/src/Foo.sol, for an import of the kindimport 'mypkg/Foo.sol'. This is arbitraryrequire.resolveto manual lookup using the help ofrequire.resolve.paths, to support packages that don't export their package.jsonresolve.exportspackage. In this case we avoid usingrequire.resolvebecause it may resolve to different packages in the filesystem for a given package name and version.Known issues:
mypkg/TheContract.solresolves tomypkg/src/TheContract.sol. If user doesimport 'mypkg/thecontract.sol', I know that the correct resolved path issrc/TheContract.sol, but I'm not sure how to it back toTheContract.sol. Asking for suggestions on how to approach thisCloses #5992