diff --git a/docs/_docs/reference/metaprogramming/tasty-inspect.md b/docs/_docs/reference/metaprogramming/tasty-inspect.md index e643775243e0..33fd8fc8c8df 100644 --- a/docs/_docs/reference/metaprogramming/tasty-inspect.md +++ b/docs/_docs/reference/metaprogramming/tasty-inspect.md @@ -4,17 +4,33 @@ title: "TASTy Inspection" nightlyOf: https://docs.scala-lang.org/scala3/reference/metaprogramming/tasty-inspect.html --- -```scala -libraryDependencies += "org.scala-lang" %% "scala3-tasty-inspector" % scalaVersion.value -``` - TASTy files contain the full typed tree of a class including source positions and documentation. This is ideal for tools that analyze or extract semantic -information from the code. To avoid the hassle of working directly with the TASTy +information from the code. + +To avoid the hassle of working directly with the TASTy file we provide the `Inspector` which loads the contents and exposes it through the TASTy reflect API. -## Inspecting TASTy files +We also showcase TASTyViz, a visualiser for tasty, useful for debugging and checking your understanding of TASTy + +## TASTyViz + + + +TASTyViz is a tool to inspect TASTy files visually. +At the time of writing, it is still in the early stages of developement, therefore you can expect missing functionality and less-than-ideal user experience, but it could still prove useful when debugging. +You can check it out [here](https://github.com/shardulc/tastyviz). + +## `Inspector` + +`Inspector` is a tool which provides API access to TASTy. + +You can add the depency to your sbt build like so: +```scala +libraryDependencies += "org.scala-lang" %% "scala3-tasty-inspector" % scalaVersion.value +``` + To inspect the trees of a TASTy file a consumer can be defined in the following way.