-
-
Notifications
You must be signed in to change notification settings - Fork 94
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Stub sections of documentation to fill later
- Loading branch information
1 parent
e6c9619
commit 5714829
Showing
6 changed files
with
143 additions
and
2 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,25 @@ | ||
# Cookbook | ||
|
||
## Automatic, Semiautomatic and Inlined derivation | ||
|
||
TODO | ||
|
||
## Java collection integration | ||
|
||
TODO | ||
|
||
## Cats integration | ||
|
||
TODO | ||
|
||
## Protocol buffers integration | ||
|
||
TODO | ||
|
||
## Custom smart constructors | ||
|
||
TODO | ||
|
||
## Custom optional types | ||
|
||
TODO |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,24 @@ | ||
# Chimney | ||
|
||
TODO: welcome test | ||
|
||
```scala | ||
// TODO: domain to protobuf example | ||
|
||
import io.scalaland.chimney.dsl.* | ||
domain.transformInto[Protobuf] | ||
``` | ||
|
||
```scala | ||
// TODO: protobuf into domain example | ||
|
||
import io.scalaland.chimney.dsl.* | ||
domain.transformIntoPartial[Protobuf] | ||
``` | ||
|
||
```scala | ||
// TODO: patching domain | ||
|
||
import io.scalaland.chimney.dsl.* | ||
domain.patchUsing(patch) | ||
``` |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,25 @@ | ||
# Quickstart | ||
|
||
[![Chimney JVM versions](https://index.scala-lang.org/scalalandio/chimney/chimney/latest-by-scala-version.svg?platform=jvm)](https://search.maven.org/artifact/io.scalaland/chimney_2.13) <br> | ||
[![Chimney Scala.js 1.x versions](https://index.scala-lang.org/scalalandio/chimney/chimney/latest-by-scala-version.svg?platform=sjs1)](https://search.maven.org/artifact/io.scalaland/chimney_sjs1_2.13) <br> | ||
[![Chimney Scala.js 0.6 versions](https://index.scala-lang.org/scalalandio/chimney/chimney/latest-by-scala-version.svg?platform=sjs0.6)](https://search.maven.org/artifact/io.scalaland/chimney_sjs0.6_2.13) <br> | ||
[![Chimney Scala Native 0.4 versions](https://index.scala-lang.org/scalalandio/chimney/chimney/latest-by-scala-version.svg?platform=native0.4)](https://search.maven.org/artifact/io.scalaland/chimney_native0.4_2.13) <br> | ||
[![Chimney Scala Native 0.3 versions](https://index.scala-lang.org/scalalandio/chimney/chimney/latest-by-scala-version.svg?platform=native0.3)](https://search.maven.org/artifact/io.scalaland/chimney_native0.3_2.11) <br> | ||
|
||
```scala | ||
// if you use Scala on JVM-only | ||
libraryDependencies += "io.scalaland" %% "chimney" % chimneyVersion | ||
// if you cross-compile to Scala.js and/or Scala Native | ||
libraryDependencies += "io.scalaland" %%% "chimney" % chimneyVersion | ||
``` | ||
```scala | ||
import io.scalaland.chimney.dsl._ | ||
``` | ||
|
||
TODO: see semiauto vs auto | ||
|
||
TODO: cats-integration | ||
|
||
TODO: java-collections | ||
|
||
TODO: protobufs |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,5 @@ | ||
# Supported patching | ||
# Supported patching | ||
|
||
TODO | ||
|
||
TODO flags |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,55 @@ | ||
# Supported Transformations | ||
|
||
## Into `case class` | ||
|
||
TODO | ||
|
||
TODO java beans | ||
|
||
TODO flags | ||
|
||
TODO overrides | ||
|
||
## From/To `AnyVal` | ||
|
||
TODO | ||
|
||
## Between `sealed`/`enum`s | ||
|
||
TODO | ||
|
||
TODO java enums | ||
|
||
TODO flags | ||
|
||
TODO overrides | ||
|
||
TODO java enums limitations | ||
|
||
## From/To `Option` | ||
|
||
TODO | ||
|
||
TODO option unwrapping in partial | ||
|
||
TODO refer Optional support in java-collections | ||
|
||
TODO flags | ||
|
||
## Between `Either`s | ||
|
||
## Between Scala's collections | ||
|
||
TODO | ||
|
||
TODO mention Factory | ||
|
||
TODO mention java-collections | ||
|
||
## Custom transformations | ||
|
||
TODO | ||
|
||
TODO total -> partial | ||
|
||
TODO implicit conflict resolution |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,13 @@ | ||
# Troubleshooting | ||
# Troubleshooting | ||
|
||
## Migration 0.7.x to 0.8.0 | ||
|
||
TODO | ||
|
||
## sealed traits fail to recompile | ||
|
||
TODO | ||
|
||
## Debugging macros | ||
|
||
TODO |