rubydoc.info
rubocop
rubydoc.info | rubocop | |
---|---|---|
6 | 40 | |
132 | 12,506 | |
0.0% | 0.2% | |
5.3 | 9.8 | |
9 months ago | 3 days ago | |
Ruby | Ruby | |
MIT License | MIT License |
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.
rubydoc.info
-
What's the Difference Between `ruby-doc.org` and `docs.ruby-lang.org`?
Yes, I use rubydoc.info to refer to the docs for gems, didn't realize until now that it also includes documentation for Ruby itself. Thanks!
-
Xeme: I'd value your opinion on my new Ruby gem
GitHub will render markdown (and other formats), but I don't believe it supports parsing and rendering YARD or RDoc. Both tools ship with tools that generate documentation websites that you can use for your project. YARD also has https://rubydoc.info
-
Is anybody aware that rubydoc.info is down?
Right now, gemdocs.org is very similar to rubydoc.info as it both uses YARD, with rubydoc.info supporting custom YARD plugins for gems (which might make some gem output look better if they specify said plugins). I have some ideas for improving Ruby documentation in general, so I've been trying to not add too much functionality to YARD as I might be trying to pivot back to RDoc.
-
What's the skinny re: rubydoc.info?
The experiment is: can I pre-generate and store the docs forever? Everyone is probably going to say sure, stick them on S3 and forget about it. But how does that get funded? Who is going to pay for that? rubydoc.info is hosted via sponsorship.
-
What's up with rubydoc.info?
rubydoc.info is supported by one person and is open-source. Care to report the problems here: https://github.com/docmeta/rubydoc.info ?
rubocop
-
Utilities for refactoring and upgrading Ruby code based on ASTs
https://github.com/rubocop/rubocop/issues/8091#issuecomment-...
perhaps they are biased against the tool from participating in a campaign to police the name in the past.
-
Must-have gems for mature Rails
gem "rubocop" - https://github.com/rubocop/rubocop | Set up code guidelines for your dev team, I recommend using whatever Standard recommends.
-
I Love Ruby
I believe if you use the `||` operator instead of `or`, then things just work out fine. I agree it is really annoying. But I am pretty sure if you use a tool like RuboCop https://github.com/rubocop/rubocop (a static code analysis tool) then it will catch bugs like this. Note that I am not recommending Ruby. But in my experience if you want to work with a language and it has a community style guide and a linter that enforces it, it will save me some heartache.
- Mastering Linters : A Code Quality Assurance Comprehensive Guide using Ruby on Rails
-
code review / feedback for improvement
Adopt some sort of consistent formatting. Your top-level module starts off indented, seems like wasted space. May I suggest RuboCop?
-
An Introduction to RuboCop for Ruby on Rails
By default, out of the box, RuboCop comes with a default set of pre-configured rules. The documentation will tell you Rubocop's default rules.
- I live and work in the US where protests against police brutality have been ongoing for days, and coming to work this week the word "cop" has an uncomfortable feeling about it.
-
Code Reviewing a Ruby on Rails application.
RuboCop is a Ruby static code analyzer (a.k.a. linter) and code formatter. Out of the box it will enforce many of the guidelines outlined in the community Ruby Style Guide. Apart from reporting the problems discovered in your code, RuboCop can also automatically fix many of them for you.
-
Xeme: I'd value your opinion on my new Ruby gem
But I will encourage you to adopt Rubocop to enforce the style you want, so that if others want to contribute, they can write with spaces and then run rubocop -a and end up with the styling you prefer. Tabs indentation support was added a couple of years back: https://github.com/rubocop/rubocop/pull/7867
-
Welcome to Rails Cheat Sheet
In my last job I encountered my first Rails codebase ever (mostly REST APIs but a few server-rendered views as well). After the initial chaotic impression of the codebase (it was a startup after all) with all the Rails magic on top, I really fell in love with the framework after a more experienced Rails dev introduced a few key conventions and helpful libraries to the codebase.
Out of those, I’d at least add the RuboCop [1] linter and the BetterSpecs [2] guidelines to this list. Both helped tremendously in eliminating bikeshedding in the team and freeing up brainpower to solve actual problems. The first one helped me learn intricacies of Ruby bit by bit right in my IDE and the latter guided us to write tests in a style that’s easy to maintain and trust.
[1] https://github.com/rubocop/rubocop
[2] https://www.betterspecs.org/
What are some alternatives?
chunky_png - Read/write access to PNG images in pure Ruby.
sorbet - A fast, powerful type checker designed for Ruby
sord - Convert YARD docs to Sorbet RBI and Ruby 3/Steep RBS files
Rubycritic - A Ruby code quality reporter
YARD - YARD is a Ruby Documentation tool. The Y stands for "Yay!"
coc-solargraph - Solargraph extension for coc.nvim
rdoc-markdown - RDoc to Markdown generator
bullet - help to kill N+1 queries and unused eager loading
RDoc - RDoc produces HTML and online documentation for Ruby projects.
Reek - Code smell detector for Ruby
zeal - Offline documentation browser inspired by Dash
Ruby style guide - A community-driven Ruby coding style guide