Reorganize into multiple sbt projects #45
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
|
I'll take a look. It makes the project more complex, but I agree that bringing all Cats into the dependencies when you're not using it is an issue. |
+ tranzactio (core): Only depends on zio and zio-stream
+ tranzactio-anorm: Depends on core and play's anorm
+ tranzactio-doobie: Depends on core, zio-interop-cats, and doobie-core
+ examples: Contains the old src/samples/scala as the test sources.
+ Old test sources `integration.{AnormIT, DoobieIT}` also be moved to examples project because they depend on examples' classes.
+ (The only) break changes: Users of tranzactio have to change their libraryDependencies:
Before:
```
// Add this if they use doobie
libraryDependencies ++= Seq(
"io.github.gaelrenoux" %% "tranzactio" % version,
"org.tpolecat" %% "doobie-core" % doobieVersion,
)
// Add this if they use anorm
libraryDependencies ++= Seq(
"io.github.gaelrenoux" %% "tranzactio" % version,
"org.playframework.anorm" %% "anorm" % anormVersion,
)
```
Now:
```
// Add this if they use doobie
libraryDependencies += "io.github.gaelrenoux" %% "tranzactio-doobie" % version
// Add this if they use anorm
libraryDependencies += "io.github.gaelrenoux" %% "tranzactio-anorm" % version,
```
+ Users who use anorm now don't depend on zio-interop-cats and all its transitive dependencies, eg cats.
+ tranzactio now don't have optional dependencies.
It is dangerous to ensure that an optional dependency is actually optional.
For example, if we (in tranzactio's code) import a doobie's class in a class
in shared code and user use anorm (so they dont add doobie dependency because
its optional) - then there will be a RuntimeException.
gaelrenoux
force-pushed
the
multi-projects
branch
from
39498f7
to
4c0dc43
Compare
|
(Rebased on master) |
gaelrenoux
approved these changes
Jul 29, 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.
Pls see the commit messages for details.
Benefits
anormnow don't depend onzio-interop-catsand all its transitive dependencies, eg cats.tranzactionow don't have optional dependencies.It is dangerous to ensure that an optional dependency is actually optional.
For example, if we (in
tranzactio's code) import adoobie's class in a classin shared code and user use
anorm(so they don't adddoobiedependency becauseits optional) - then there will be a
RuntimeException.(The only) break change
Users of
tranzactiohave to change theirlibraryDependencies: