fs2-grpc
mdoc
Our great sponsors
fs2-grpc | mdoc | |
---|---|---|
1 | 4 | |
262 | 386 | |
1.9% | 0.8% | |
8.4 | 8.4 | |
4 days ago | 8 days ago | |
Scala | Scala | |
MIT License | 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.
fs2-grpc
-
Friction-less scala - Tell us what is causing friction in your day-to-day life with Scala
I've had great experience with ScalaPB and even better with fs2-grpc (which builds on top of ScalaPB).
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
What are some alternatives?
cats-effect - The pure asynchronous runtime for Scala
sbt-unidoc - sbt plugin to create a unified Scaladoc or Javadoc API document across multiple subprojects.
mules-http4s - Http4s Caching Implementation
sbt-mima-plugin - A tool for catching binary incompatibility in Scala
cats - Lightweight, modular, and extensible library for functional programming.
sbt-revolver - An SBT plugin for dangerously fast development turnaround in Scala
ScalaCheck - Property-based testing for Scala
sbt-pack - A sbt plugin for creating distributable Scala packages.
sbt-crossproject - Cross-platform compilation support for sbt.
coursier - Pure Scala Artifact Fetching
interop-cats - ZIO instances for cats-effect type classes
sbt-updates - sbt plugin that can check Maven and Ivy repositories for dependency updates