feat: tup-274 peerDeps not deps #46
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
rstijerina
approved these changes
Sep 6, 2022
|
Postponing resolution of this PR until TACC/tup-ui#51 is resolved. If the tup-ui core-styles PR is merged, merge this. If the tup-ui core-styles PR is closed, close this PR.
|
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.
Overview
Change dependencies to be
peerDependencies.Short Story
This change will prepare Core Styles for a future in a monorepo, but not break how TACC/Core-CMS currently uses this project.
Long Story
A separate repo, TACC/tup-ui is an NX-managed monorepo. Such repos are intended to have all their dependencies defined in the root directory
package.json, so every project within the monorepo can share those dependencies at matching versions. One of its projects iscore-styles, which is a living v0.7.x of this repo (because of a premature migration). TACC/tup-ui'score-stylesstill lists its dependencies within itspackage.json, because TACC/Core-CMS — which was dependent on TACC/tup-ui'score-stylesfor a short time — expects Core Styles to manage dependencies for building CSS.Though TACC/Core-CMS is no longer using TACC/tup-ui's
core-styles, TACC/tup-ui is the planned future home of Core Styles. So, architecture changes to it there must work here. And TACC/tup-ui#51 there moves the dependencies of TACC/tup-ui'score-stylesto TACC/tup-ui's rootpackage.json, so that change can also occur here (at least for testing, if this PR is not approved).TACC/tup-ui's
core-stylesis only retaining its list of dependencies aspeerDependenciesso that it's architecture remains compatible with TACC/Core-CMS (even though its styles are one minor version behind). Peer dependencies are automatically installed since NPM v7. So, when TACC/Core-CMS installs Core Styles (from whichever repo publishes it), NPM will automatically install all of its dependencies.Related
Changes
dependenciestopeerDependenciesTesting
See TACC/Core-CMS#552 "Testing".