Merge pull request #6 from zio/disable_mdoc_compilation

temporary disable mdoc compilation
zio · Apr 28, 2023 · 39c0fb5 · 39c0fb5
2 parents f355710 + 547a3c6
commit 39c0fb5
Show file tree

Hide file tree

Showing 7 changed files with 23 additions and 4 deletions.
diff --git a/build.sbt b/build.sbt
@@ -74,7 +74,8 @@ lazy val zioBsonMagnolia = project
       "org.scala-lang.modules"       %% "scala-collection-compat" % scalaCollectionCompatVersion
     ),
     scalaReflectTestSettings,
-    macroDefinitionSettings
+    macroDefinitionSettings,
+    scalacOptions -= "-Xfatal-warnings"
   )
   .settings(testFrameworks += new TestFramework("zio.test.sbt.ZTestFramework"))
   .enablePlugins(BuildInfoPlugin)

diff --git a/docs/index.md b/docs/index.md
@@ -103,7 +103,7 @@ val res: Either[String,Banana] = Left(.curvature: Expected BSON type Double, but
 
 You can configure typeclass derivation with annotations.
 
-```scala mdoc:compile-only
+```scala
 import zio.bson._
 import zio.bson.BsonBuilder._
 import zio.bson.magnolia._

diff --git a/docs/sidebars.js b/docs/sidebars.js
@@ -0,0 +1,14 @@
+const sidebars = {
+  sidebar: [
+    {
+      type: "category",
+      label: "ZIO Bson",
+      collapsed: false,
+      link: { type: "doc", id: "index" },
+      items: [ 
+      ]
+    }
+  ]
+};
+
+module.exports = sidebars;
diff --git a/zio-bson-magnolia/src/main/scala/zio/bson/magnolia/BsonCodecConfiguration.scala b/zio-bson-magnolia/src/main/scala/zio/bson/magnolia/BsonCodecConfiguration.scala
@@ -55,11 +55,11 @@ object BsonCodecConfiguration {
      *   case class Outer(mySum: MySum)
      * }}}
      *
-     * Result BSON for `DiscriminatorField("$type")`:
+     * Result BSON for `DiscriminatorField("type")`:
      * {{{
      *   {
      *     mySum: {
-     *       $type: "SomeBranch"
+     *       type: "SomeBranch"
      *       a: 123
      *     }
      *   }

diff --git a/zio-bson-magnolia/src/main/scala/zio/bson/magnolia/DeriveBsonCodec.scala b/zio-bson-magnolia/src/main/scala/zio/bson/magnolia/DeriveBsonCodec.scala
@@ -2,6 +2,8 @@ package zio.bson.magnolia
 
 import zio.bson.BsonCodec
 
+import scala.language.experimental.macros
+
 object DeriveBsonCodec {
   def derive[T]: BsonCodec[T] = macro genBoth[T]
 

diff --git a/zio-bson-magnolia/src/main/scala/zio/bson/magnolia/DeriveBsonDecoder.scala b/zio-bson-magnolia/src/main/scala/zio/bson/magnolia/DeriveBsonDecoder.scala
@@ -9,6 +9,7 @@ import zio.bson.{BsonDecoder, _}
 
 import scala.collection.immutable.{ArraySeq, HashMap}
 import scala.jdk.CollectionConverters._
+import scala.language.experimental.macros
 
 trait DeriveBsonDecoder {
   type Typeclass[T] = BsonDecoder[T]

diff --git a/zio-bson-magnolia/src/main/scala/zio/bson/magnolia/DeriveBsonEncoder.scala b/zio-bson-magnolia/src/main/scala/zio/bson/magnolia/DeriveBsonEncoder.scala
@@ -7,6 +7,7 @@ import zio.bson.magnolia.BsonCodecConfiguration.SumTypeHandling
 import zio.bson.{BsonEncoder, _}
 
 import scala.jdk.CollectionConverters._
+import scala.language.experimental.macros
 
 trait DeriveBsonEncoder {
   type Typeclass[T] = BsonEncoder[T]