mdoc
sbt-revolver
mdoc | sbt-revolver | |
---|---|---|
4 | 2 | |
395 | 846 | |
0.3% | 0.5% | |
8.5 | 3.1 | |
17 days ago | over 1 year ago | |
Scala | Scala | |
Apache License 2.0 | Apache License 2.0 |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
mdoc
- Optimal decision-making with examples built using scala
-
Friction-less scala - Tell us what is causing friction in your day-to-day life with Scala
Literally what scaladoc is, it comes with sbt. Although, it's better when enhanced with mdoc so that you get the standard microsite template like these. It would be nice to have an sbt serveDocs and if everyone would host their docs for external linking, but javadoc doesn't do that either.
-
A Scala rant
The good news is that scaladoc is produced by default by sbt and published by default. So you can often pull it from the same repository your library jar came from, extract it with zip, and read the docs. But that's also totally unnecessary - javadoc.io allows you to put in your module info and serves the docs for you, so if there's an older version you can access the documentation this way. Rely on the type signatures, since they can't lie, whilst comments (including scaladoc comments) can. Honestly, library authors should be using mdoc and including examples on every public method, and that type of documentation is something you can almost always contribute to a project for a quick pr kudos.
-
The future of Scaladoc
I know it's not new but the "Snippet validation and results (mdoc)" features in mdoc are so cool. Really takes some of the tedium out of working with documentation since you can know that as you evolve your code the compiler will make sure you keep the docs in sync. Whole new level of Readme-Driven Development
sbt-revolver
-
Tooling question
Another thing to look into is sbt-revolver, this will shorten the turnaround time on whatever machine is running sbt. I remember it being pretty helpful when I was working with scala.js. Good luck!
-
Friction-less scala - Tell us what is causing friction in your day-to-day life with Scala
SBT. It's not because of the pseudo-scala config language, that looks especially alien next to braceless Scala 3 code. Or the weird symbolic operators. The big problem is correctness; in almost every project I've had to use spray-resolver because I've encountered weird bugs because SBT reuses the same dirty JVM. I really thing Drip would help here. I'll keep using SBT because it has the best Scala ecosystem support and great plugins like sbt-crossproject. It would also be great to be able to write build.sbt files in modern, regular Scala.
What are some alternatives?
sbt-mima-plugin - A tool for catching binary incompatibility in Scala
coursier - Pure Scala Artifact Fetching
sbt-unidoc - sbt plugin to create a unified Scaladoc or Javadoc API document across multiple subprojects.
sbt-play-scalajs - SBT plugin to use Scala.js along with any sbt-web server.
sbt-updates - sbt plugin that can check Maven and Ivy repositories for dependency updates
sbt-dependency-graph - sbt plugin to create a dependency graph for your project
sbt-pack - A sbt plugin for creating distributable Scala packages.
xsbt-web-plugin - Servlet support for sbt
sbt-docker - Create Docker images directly from sbt
sbt-microsites - An sbt plugin to create awesome microsites for your project
scala-clippy - Good advice for Scala compiler errors