Simple macro to generate a case class Enclosure(fullModuleName: String) data-type telling you in which module it was instantiated in. Think, log4s or log4cats logger names based on the class/object/trait they were created in, but generalized and useable outside of that context.
Honestly, the library should be pretty stable and will most likely change only to support new Scala versions. But what do I know?
This library is published for Scala 3, 2.13, 2.12, on JVM, JS, and Native platforms.
libraryDependencies ++= "com.lorandszakacs" %% "enclosure" % "1.1.0"When you are also cross-compiling on JS and Native platform. Don't forget an extra percentage sign:
libraryDependencies ++= "com.lorandszakacs" %%% "enclosure" % "1.1.0"This library provides one single type: com.lorandszakacs.enclosure.Enclosure which simply contains the fully qualified name of the enclosing module. Where module is either one of:
- class
- object
- package (object)
Simply add an implicit parameter to your methods/classes, and a macro will generate a value for Enclosure for you.
Similar in usage to munit.Location, or org.tpolecat.SourcePos.
package myapp
import com.lorandszakacs.enclosure.Enclosure
object Printer {
def locatedPrintln(s: String)(implicit enc: Enclosure): Unit = {
println(s"[${enc.fullModuleName}] $s")
}
}
// -------
package myapp.module
object Main extends App {
myapp.Printer.locatedPrintln("calling from main!")
// prints out:
// [myapp.module.Main] calling from main!
nestedMethod()
// prints out:
// [myapp.module.Main] calling from nestedMethod in main!
def nestedMethod(): Unit = {
myapp.Printer.locatedPrintln("calling from nestedMethod!")
}
}The library was created to generalize, and make available the often copy-pasted way of getting this name in logging libraries via macros. This was is composable, and data-type driven, while macros just make generating the data-type easier.