refactor: add multiple file exports for notifications controllers #4604
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
Prithpal-Sooriya
force-pushed
the
notifications-multiple-exports
branch
from
4daa379
to
8a035a4
Compare
|
@metamaskbot publish-preview |
…node 18 we still can fallback to named exports
Prithpal-Sooriya
force-pushed
the
notifications-multiple-exports
branch
from
dff87e3
to
12fc043
Compare
|
@metamaskbot publish-preview |
|
Preview builds have been published. See these instructions for more information about preview builds. Expand for full list of packages and versions. |
There was a problem hiding this comment.
These package.json files are to help ensure that the subfolders are resolvable in JS projects & linters.
This pattern was inspired by how it is resolved through redux-toolkit.
https://github.com/reduxjs/redux-toolkit/blob/master/packages/toolkit/query/react/package.json
There was a problem hiding this comment.
TS projects are able to resolve this, as the root package.json describes all the exports. However linters and JS projects may find it difficult, especially if the export name is an alias (e.g. does not map 1:1 with the output directory)
There was a problem hiding this comment.
I'm open to change if there is another pattern we can utilise.
Prithpal-Sooriya
force-pushed
the
notifications-multiple-exports
branch
from
634a1bd
to
21d139e
Compare
this ensures that JS projects are able to find and resolve the paths to the module sub-files. E.g. "Unable to resolve path to module '@metamask-previews/profile-sync-controller/user-storage'. (eslintimport/no-unresolved)"
|
@metamaskbot publish-preview |
|
Preview builds have been published. See these instructions for more information about preview builds. Expand for full list of packages and versions. |
will need to discuss with the team how we can better handle workspace validation.
|
@metamaskbot publish-preview |
|
Preview builds have been published. See these instructions for more information about preview builds. Expand for full list of packages and versions. |
This was referenced Aug 27, 2024
…core into notifications-multiple-exports
Prithpal-Sooriya
added
the
team-notifications
|
@metamaskbot publish-preview |
|
Preview builds have been published. See these instructions for more information about preview builds. Expand for full list of packages and versions. |
3 tasks
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.
Explanation
This adds multiple exports to the
@metamask/profile-sync-controllerand@metamask/notification-services-controller.This will allow classes, functions, variables to be imported more naturally compared to the named exports. This will potentially help with tree shaking.
List of all imports:
NOTE - we will keep backwards compatibility with named exports. I think we'll also probably export all (e.g
export * ...) to flatten the named exports structure.References
N/A
Changelog
@metamask/profile-sync-controller@metamask/notification-services-controllerChecklist