Merge pull request #16 from dwickern/mdoc

Fix non-compiling code in docs

Author: dwickern

.github/workflows/build.yml

@@ -29,4 +29,4 @@ jobs:
           key: ${{ runner.os }}-sbt-${{ hashFiles('**/build.sbt', '**/plugins.sbt') }}
 
       - name: Run tests
-        run: sbt test
+        run: sbt test mdoc

README.md

@@ -14,85 +14,81 @@ Usage
 =====
 
 Add the library as "provided", because it's only needed during compilation and not at runtime:
-
 ```sbt
 libraryDependencies += "com.github.dwickern" %% "scala-nameof" % "3.0.0" % "provided"
 ```
 
-Now you can use `nameOf` to get the name of a variable or class member:
-```scala
-  import com.github.dwickern.macros.NameOf._
-
-  case class Person(name: String, age: Int)
+And import the package:
+```scala mdoc
+import com.github.dwickern.macros.NameOf._
+```
 
-  def toMap(person: Person) = Map(
-    nameOf(person.name) -> person.name,
-    nameOf(person.age) -> person.age
-  )
+Now you can use `nameOf` to get the name of a variable or class member:
+```scala mdoc:nest
+case class Person(name: String, age: Int)
 
-  // compiles to:
+def toMap(person: Person) = Map(
+  nameOf(person.name) -> person.name,
+  nameOf(person.age) -> person.age
+)
+```
+```scala mdoc:nest
+// compiles to:
 
-  def toMap(person: Person) = Map(
-    "name" -> person.name,
-    "age" -> person.age
-  )
+def toMap(person: Person) = Map(
+  "name" -> person.name,
+  "age" -> person.age
+)
 ```
 
 To get the name of a function:
-```scala
-  import com.github.dwickern.macros.NameOf._
-
-  def startCalculation(value: Int): Unit = {
-    println(s"Entered ${nameOf(startCalculation _)}")
-  }
-
-  // compiles to:
+```scala mdoc:nest
+def startCalculation(value: Int): Unit = {
+  println("Entered " + nameOf(startCalculation _))
+}
+```
+```scala mdoc:nest
+// compiles to:
 
-  def startCalculation(value: Int): Unit = {
-    println(s"Entered startCalculation")
-  }
+def startCalculation(value: Int): Unit = {
+  println("Entered startCalculation")
+}
 ```
 
 Without having an instance of the type:
-```scala
-  import com.github.dwickern.macros.NameOf._
+```scala mdoc:nest
+case class Person(name: String, age: Int) {
+  def sayHello(other: Person) = s"Hello ${other.name}!"
+}
 
-  case class Person(name: String, age: Int) {
-    def sayHello(other: Person) = s"Hello ${other.name}!"
-  }
-  
-  println(nameOf[Person](_.age))
-
-  // compiles to:
-
-  println("age")
+println(nameOf[Person](_.age))
+println(nameOf[Person](_.sayHello(???)))
+```
+```scala mdoc:nest
+// compiles to:
 
-  println(nameOf[Person](_.sayHello(???))
-  
-  //compiles to: 
-  println("sayHello")
+println("age")
+println("sayHello")
 ```
 
 You can also use `nameOfType` to get the unqualified name of a type:
-```scala
-  import com.github.dwickern.macros.NameOf._
-
-  println(nameOf[java.lang.String])
-
-  // compiles to:
+```scala mdoc:nest
+println(nameOfType[java.lang.String])
+```
+```scala mdoc:nest
+// compiles to:
 
-  println("String")
+println("String")
 ```
 
 And `qualifiedNameOfType` to get the qualified name:
-```scala
-  import com.github.dwickern.macros.NameOf._
-
-  println(qualifiedNameOfType[java.lang.String])
-
-  // compiles to:
+```scala mdoc:nest
+println(qualifiedNameOfType[java.lang.String])
+```
+```scala mdoc:nest
+// compiles to:
 
-  println("java.lang.String")
+println("java.lang.String")
 ```
 
 

build.sbt

@@ -8,13 +8,14 @@ lazy val scala211 = "2.11.12"
 
 lazy val root = project.in(file("."))
   .aggregate(nameof.projectRefs: _*)
+  .enablePlugins(MdocPlugin)
   .settings(
     // for IntelliJ import: pick one project from the matrix to use
     nameof.jvm(scala213).settings,
     target := baseDirectory.value / "target",
     ideSkipProject := false,
-    compile / skip := true,
     publish / skip := true,
+    mdocIn := baseDirectory.value / "README.md",
   )
 
 lazy val nameof = (projectMatrix in file("."))

project/plugins.sbt

@@ -6,3 +6,4 @@ addSbtPlugin("com.jsuereth" % "sbt-pgp" % "2.0.2")
 addSbtPlugin("com.github.gseitz" % "sbt-release" % "1.0.13")
 addSbtPlugin("com.eed3si9n" % "sbt-projectmatrix" % "0.7.0")
 addSbtPlugin("org.jetbrains" % "sbt-ide-settings" % "1.1.0")
+addSbtPlugin("org.scalameta" % "sbt-mdoc" % "2.2.17" )