refactor(notifications): cleanup notification subpath exports #4650
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
Made it so that the critical subpaths are added (mocks and UI), the rest are inside the barrel file.
even thought this does not effect CI and testing, these errors were annoying and were fixed. These subpath package.json files do not require names
Prithpal-Sooriya
commented
Sep 3, 2024
| @@ -1,6 +1,6 @@ | |||
| { | |||
| "name": "@metamask/notification-services-controller", | |||
There was a problem hiding this comment.
Internal subpath exports are using a package.json so this "file path" exists. This is so JS projects are able to resolve the subpath export path (TS projects correctly use the root package.json exports). This pattern was copied from redux-toolkit.
See this comment for more details:
#4604 (comment)
Prithpal-Sooriya
commented
Sep 3, 2024
| "version": "1.0.0", | ||
| "private": true, |
There was a problem hiding this comment.
I've added this to explicitly set these internal subpath exports to be private.
This shouldn't cause issues with publishing as these are not specified on root of the workspaces file.
If this does cause issues with publishing, I can revert.
Prithpal-Sooriya
added
the
team-notifications
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 cleans up the notification team packages subpath exports (
@metamask/profile-sync-controller&@metamask/notification-services-controller).Packages will now only export:
/mocksfor accessing mock data (also available as a named export in root)/uifor some UI/framework files for specific platforms (web vs mobile). This is subject to change (we may have a clearer distinction for platforms, such as a React folder vs ReactNative folder).We also fix a
jest-haste-mapsilent error that was introduced due to subpath modules.**jest haste map silent error**
This was a silent error (CI still passes)
References
Changelog
@metamask/profile-sync-controllerjest-haste-maperrors.@metamask/notification-services-controllerjest-haste-maperrors./types,/processors,/constantssubpath exports. These are still accessible through root export.Checklist