-
-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update docs and test package names to nrktkt.ninny to reflect migrati…
…on (#55) * update docs and test packages * update urls in userguide * Update USERGUIDE.md --------- Co-authored-by: Nathan Fischer <[email protected]>
- Loading branch information
Showing
21 changed files
with
80 additions
and
79 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 |
---|---|---|
|
@@ -6,4 +6,5 @@ out/ | |
target/ | ||
.vscode | ||
.ammonite | ||
.bsp | ||
.bsp | ||
*.iml |
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
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 |
---|---|---|
|
@@ -5,5 +5,5 @@ | |
|
||
# Run Example | ||
```shell script | ||
./mill ninny.test.run | ||
./mill __.test | ||
``` |
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
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,8 +1,8 @@ | ||
|
||
[![Maven Central](https://img.shields.io/maven-central/v/tk.nrktkt/ninny_2.13?style=for-the-badge&logo=apache-maven)](https://mvnrepository.com/artifact/tk.nrktkt/ninny) | ||
[![coverage](https://img.shields.io/badge/test%20coverage-%3E%2090%25-brightgreen?style=for-the-badge)](https://kag0.github.io/ninny-json/coverage) | ||
[![Gitter](https://img.shields.io/gitter/room/kag0/ninny-json?style=for-the-badge&logo=gitter)](https://gitter.im/kag0/ninny-json?utm_source=share-link&utm_medium=link&utm_campaign=share-link) | ||
[![Matrix](https://img.shields.io/badge/chat-on%20matrix-%230dbd8b?style=for-the-badge&logo=matrix)](https://matrix.to/#/#kag0_ninny-json:gitter.im?via=gitter.im&via=matrix.org) | ||
[![coverage](https://img.shields.io/badge/test%20coverage-%3E%2090%25-brightgreen?style=for-the-badge)](https://nrktkt.github.io/ninny-json/coverage) | ||
[![Gitter](https://img.shields.io/gitter/room/nrktkt/ninny-json?style=for-the-badge&logo=gitter)](https://gitter.im/kag0/ninny-json?utm_source=share-link&utm_medium=link&utm_campaign=share-link) | ||
[![Matrix](https://img.shields.io/badge/chat-on%20matrix-%230dbd8b?style=for-the-badge&logo=matrix)](https://matrix.to/#/#nrktkt_ninny-json:gitter.im?via=gitter.im&via=matrix.org) | ||
|
||
|
||
# Integrations | ||
|
@@ -12,43 +12,43 @@ | |
* [mercury JSON-RPC](https://github.com/lightform-oss/mercury/tree/master/ninny) | ||
* [Play JSON](play-compat) (if you find something with Play support, it will work with ninny too!) | ||
|
||
<script type='module' src="https://cdn.jsdelivr.net/gh/kag0/[email protected]/sauce.js"> | ||
<h1>If you're reading this, you should go to the userguide website at https://kag0.github.io/ninny-json/USERGUIDE </h1> | ||
<script type='module' src="https://cdn.jsdelivr.net/gh/nrktkt/[email protected]/sauce.js"> | ||
<h1>If you're reading this, you should go to the userguide website at https://nrktkt.github.io/ninny-json/USERGUIDE </h1> | ||
</script> | ||
# Reading values from JSON | ||
<sauce-code | ||
repo='kag0/ninny-json' | ||
repo='nrktkt/ninny-json' | ||
lang='scala' | ||
file='ninny/test/src-2/io/github/kag0/ninny/userguide/Reading.scala' | ||
file='ninny/test/src-2/nrktkt/ninny/userguide/Reading.scala' | ||
lines='8:63' | ||
></sauce-code> | ||
# Writing values to JSON | ||
<sauce-code | ||
repo='kag0/ninny-json' | ||
repo='nrktkt/ninny-json' | ||
lang='scala' | ||
file='ninny/test/src-2/io/github/kag0/ninny/userguide/Writing.scala' | ||
file='ninny/test/src-2/nrktkt/ninny/userguide/Writing.scala' | ||
lines='9:23' | ||
></sauce-code> | ||
`obj` and `arr` build JSON structures | ||
<sauce-code | ||
repo='kag0/ninny-json' | ||
repo='nrktkt/ninny-json' | ||
lang='scala' | ||
file='ninny/test/src-2/io/github/kag0/ninny/userguide/Writing.scala' | ||
file='ninny/test/src-2/nrktkt/ninny/userguide/Writing.scala' | ||
lines='25:47' | ||
></sauce-code> | ||
> **note:** The above example uses magnets to produce an object building syntax similar to how you'd build a `scala.collection.Map`. This is intuitive, but can produce unhelpful compiler errors. Instead, you can use a "long arrow" `-->` or "squiggly arrow" `~>` to get better compiler errors for debugging, or just because you don't like magnets. | ||
> See below for an example | ||
<sauce-code | ||
repo='kag0/ninny-json' | ||
repo='nrktkt/ninny-json' | ||
lang='scala' | ||
file='ninny/test/src-2/io/github/kag0/ninny/userguide/Writing.scala' | ||
file='ninny/test/src-2/nrktkt/ninny/userguide/Writing.scala' | ||
lines='52:74' | ||
></sauce-code> | ||
|
@@ -58,27 +58,27 @@ With immutable ASTs it can be a pain to update values deep inside the tree. | |
You can use ninny's dynamic update syntax easly to replace values way down in there. | ||
|
||
<sauce-code | ||
repo='kag0/ninny-json' | ||
repo='nrktkt/ninny-json' | ||
lang='scala' | ||
file='ninny/test/src-2/io/github/kag0/ninny/userguide/Updating.scala' | ||
file='ninny/test/src-2/nrktkt/ninny/userguide/Updating.scala' | ||
lines='5:18' | ||
></sauce-code> | ||
|
||
# Converting domain objects to JSON | ||
|
||
<sauce-code | ||
repo='kag0/ninny-json' | ||
repo='nrktkt/ninny-json' | ||
lang='scala' | ||
file='ninny/test/src-2/io/github/kag0/ninny/userguide/DomainTo.scala' | ||
file='ninny/test/src-2/nrktkt/ninny/userguide/DomainTo.scala' | ||
lines='7:51' | ||
></sauce-code> | ||
|
||
# Converting JSON to domain objects | ||
|
||
<sauce-code | ||
repo='kag0/ninny-json' | ||
repo='nrktkt/ninny-json' | ||
lang='scala' | ||
file='ninny/test/src-2/io/github/kag0/ninny/userguide/DomainFrom.scala' | ||
file='ninny/test/src-2/nrktkt/ninny/userguide/DomainFrom.scala' | ||
lines='22:49' | ||
></sauce-code> | ||
|
||
|
@@ -88,9 +88,9 @@ Rather than implementing `ToJson` and `FromJson` by hand, you can generate them | |
automatically using | ||
|
||
<sauce-code | ||
repo='kag0/ninny-json' | ||
repo='nrktkt/ninny-json' | ||
lang='scala' | ||
file='ninny/test/src-2/io/github/kag0/ninny/userguide/SemiAuto.scala' | ||
file='ninny/test/src-2/nrktkt/ninny/userguide/SemiAuto.scala' | ||
lines='11:16' | ||
></sauce-code> | ||
|
||
|
@@ -101,8 +101,8 @@ See more on configuring automatic derivation [here](AUTOCONFIG.md). | |
Often you want to have different names in a case class than what's in the JSON, but you don't need to change the types at all. `forProductN` methods are perfect for this, just specify what the JSON field name should be and provide the case class `apply`/`unapply` method to generate a `ToJson`, `FromJson`, or both together. | ||
|
||
<sauce-code | ||
repo='kag0/ninny-json' | ||
repo='nrktkt/ninny-json' | ||
lang='scala' | ||
file='ninny/test/src-2/io/github/kag0/ninny/userguide/ForProductN.scala' | ||
file='ninny/test/src-2/nrktkt/ninny/userguide/ForProductN.scala' | ||
lines='8:24' | ||
></sauce-code> |
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
6 changes: 3 additions & 3 deletions
6
...o/github/kag0/ninny/example/Example.scala → .../src-2/nrktkt/ninny/example/Example.scala
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
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
6 changes: 3 additions & 3 deletions
6
...ub/kag0/ninny/userguide/Annotations.scala → .../nrktkt/ninny/userguide/Annotations.scala
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
6 changes: 3 additions & 3 deletions
6
.../kag0/ninny/userguide/DefaultValues.scala → ...rktkt/ninny/userguide/DefaultValues.scala
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
2 changes: 1 addition & 1 deletion
2
...hub/kag0/ninny/userguide/DomainFrom.scala → ...2/nrktkt/ninny/userguide/DomainFrom.scala
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
4 changes: 2 additions & 2 deletions
4
...ithub/kag0/ninny/userguide/DomainTo.scala → ...c-2/nrktkt/ninny/userguide/DomainTo.scala
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
4 changes: 2 additions & 2 deletions
4
...ub/kag0/ninny/userguide/ForProductN.scala → .../nrktkt/ninny/userguide/ForProductN.scala
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
6 changes: 3 additions & 3 deletions
6
...ithub/kag0/ninny/userguide/FullAuto.scala → ...c-2/nrktkt/ninny/userguide/FullAuto.scala
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
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
6 changes: 3 additions & 3 deletions
6
...ithub/kag0/ninny/userguide/SemiAuto.scala → ...c-2/nrktkt/ninny/userguide/SemiAuto.scala
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
2 changes: 1 addition & 1 deletion
2
...ithub/kag0/ninny/userguide/Updating.scala → ...c-2/nrktkt/ninny/userguide/Updating.scala
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,4 +1,4 @@ | ||
package io.github.kag0.ninny.userguide | ||
package nrktkt.ninny.userguide | ||
|
||
object Updating { | ||
// format: off | ||
|
Oops, something went wrong.