sord
Convert YARD docs to Sorbet RBI and Ruby 3/Steep RBS files (by AaronC81)
yard-doctest
Doctests from YARD examples (by p0deje)
sord | yard-doctest | |
---|---|---|
8 | 1 | |
285 | 105 | |
- | - | |
4.6 | 1.9 | |
9 months ago | about 1 year ago | |
Ruby | Gherkin | |
MIT License | MIT License |
The number of mentions indicates the total number of mentions that we've tracked plus the number of user suggested alternatives.
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.
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.
sord
Posts with mentions or reviews of sord.
We have used some of these posts to build our list of alternatives
and similar projects. The last one was on 2023-01-17.
-
How do you document your code?
I tend to follow along using the YardDoc comment style. It has many small things I love about it; an example is when yardoc is followed it can be used to generate RBS/Sorbet type files with the sord gem, you can also generate application documents similar to rdoc/sdoc.
-
Ruby compiler is now 22–170% faster than Ruby's default implementation for Stripe's production API traffic
You may be interesting in checking out the Sord gem. If you do YARDOC based comments and documentation in your code not only does it make your code pretty easy to understand. But you can also generate Sorbet RBI and Ruby RBS files based off of your documentation. It's pretty much a require in any new project I start working with.
-
Do people use type signatures for ruby actively?
I love using yard as well and if you use it you can use sord and based on you yard annotates it'll build sorbet types for your code. I've used it on my last few projects and it's helped building your types setup amazingly easy.
-
Static Typing in Ruby 3 Gives Me a Headache (But I Could Grow to Like It)
Sord was originally developed to generate Sorbet type signature files from YARD comments. Sorbet is a type checking system developed by Stripe, and it does not use anything specific to Ruby 3 but is instead a custom DSL for defining types. However, Sord has recently been upgraded to support generation of RBS files (Ru*by **Signature*). This means that instead of having to write all your Ruby 3 type signature files by hand (which are standalone—Ruby 3 doesn't support inline typing in Ruby code itself), you can write YARD comments—just like with Solargraph—and autogenerate the signature files.
-
Ruby: How Can Something So Beautiful Become So Ugly
Why isn't anyone talking about Sord?? I see that as being a great solution. https://github.com/AaronC81/sord#example
-
Differences between Sorbet and RBS
Go for both until things evolve : https://github.com/AaronC81/sord
- the 'sord' gem can automatically generate .rbi and .rbs type signature files from YARD doc
yard-doctest
Posts with mentions or reviews of yard-doctest.
We have used some of these posts to build our list of alternatives
and similar projects. The last one was on 2023-05-08.
-
Programming types and mindsets
I never used these, but is it like Python's doctests? If so it exists for YARD: https://github.com/p0deje/yard-doctest
What are some alternatives?
When comparing sord and yard-doctest you can also consider the following projects:
tapioca - The swiss army knife of RBI generation
syntax_suggest - Searching for unexpected `end` syntax errors takes a lot of time. Let this gem do it for you!
YARD - YARD is a Ruby Documentation tool. The Y stands for "Yay!"
ScrapYard - A common part inventory addon for Kerbal Space Program.
steep - Static type checker for Ruby
rubydoc.info - Next generation rdoc.info site
crystal - The Crystal Programming Language
yard-markdown - yard plugin to generate markdown documentation
value-object-in-ruby-benchmarks - A series of micro benchmarks about Data.define vs Struct vs OpenStruct in #Ruby