Ruby formatters
0 likes393 views
The document discusses various Ruby code formatters, including their history, strengths, and weaknesses, focusing on tools like RuboCop, Rufo, and Prettier-Ruby. It highlights the performance of each formatter in terms of speed and configuration options while suggesting a balanced approach to code style enforcement. The author promotes using a linter and recommends trying Prettier-Ruby for formatting tasks while maintaining flexibility in coding styles.
![Rubocop
heavy, but very good advanced configuration
parameters to use as formatter:
-a --auto-correct Auto-correct offenses.
--safe-auto-correct Run auto-correct only when it's safe.
-x, --fix-layout
Run only layout cops, with auto-correct on.
(currently 81 cops)
--only-guide-cops
Run only cops for rules that link to a style
guide.
--only [COP1,COP2,...] Run only the given cop(s).](https://image.slidesharecdn.com/rubyformatters-190416075325/85/Ruby-formatters-6-320.jpg)
Ruby formatters
- 1. prettier-ruby? ruby formatters overview "Good programmers" are those who aleady have learned a set of rules that ensures good style; (…) The Elements of Programming Style 1974 Piotr Wasiak
- 2. Ruby programming style history At the beginning there was chaos We got some ruby styling guides CodeReview focused sometimes more on style than the logic We got linters (PR services, overcommit, text-editor plugins) Should we now follow e.g. JS world with using automatic formatters?
- 3. Code formatter It enforces a consistent style by parsing your code and re-printing it with its own rules
- 4. ✴ Rubocop ✴ Rufo ✴ Prettifier ✴ Rubyfmt RIP ✤ Ruby Script Beautifier (2008) ✤ eden (2011) ✤ ruby-beautify2 (fork: 01. 2018) Formatters ruby
- 5. Parsers Ripper to STD LIB - written in C so faster ruby-parse to CLI do gem parser: production-ready written in pure Ruby. It recognises as much or more code than Ripper, Melbourne, JRubyParser or ruby_parser, and is
- 6. Rubocop heavy, but very good advanced configuration parameters to use as formatter: -a --auto-correct Auto-correct offenses. --safe-auto-correct Run auto-correct only when it's safe. -x, --fix-layout Run only layout cops, with auto-correct on. (currently 81 cops) --only-guide-cops Run only cops for rules that link to a style guide. --only [COP1,COP2,...] Run only the given cop(s).
- 8. RuFo Not a simple find and replace one, very fast Was implemented in a similar fashion to Crystal's formatter. Started 2 years ago, but currently is getting less updates / issues than prettier There are some problems with chained heredocs, (…) config options: trailing_commas, parens_in_def
- 10. “uglifier” part
- 11. Rufo is fast Less strict than prettier, but it seems that it formats less
- 12. Rubyfmt Fast, integrated with shell (no ruby gem) Project development started 5 months ago no config options. No max chars/line, removes additional enters Broke on some files (also especially @ rspec specs) Fast per file - 175 ms many files at once is not a case
- 14. Rubyfmt problems user_context&.role&.in? %w(Admin Company) AddActivityService.new(candidate: candidate, **keywords).call expect(email.body).to match 'His/her search can be shown'
- 15. Prettier-ruby Fast and opinionated in many languages as plugin to text editors Ruby plugin development started 7 months ago config options: printWidth, tabWidth, addTrailingCommas, inlineConditionals, inlineLoops, preferHashLabels, preferSingleQuotes Fast per file - 170 ms many files at once is not a case
- 16. Ruby test by Prettier *designed by them : )
- 17. “uglifier” part
- 19. Speed command User time System time Total time rufo ruby.rb 0.14s 0.05s 0.202s ./node_modules/.bin/ prettier 0.38s 0.08s 0.462s Rubocop -a 1.09s 0.25s 1.349s command User time System time Total time rufo **/*.rb 1.16s 0.20s 1.379s Rubocop -a 3.18s 0.41s 3.635s Rubocop -a —cache false 14.34s 0.64s 15.174s ./node_modules/.bin/ prettier 36.23s 13.51s 51.606s Format rails api project LOC: 2644 Format 1 file (ruby test) Rubyfmt - total time 30.s with some errors during parsing
- 20. Formatter triggers ✓ On file save ✓ On code paste ✓ On demand
- 21. Sum up: How to live? Use still linter Chillout with code style wars Try prettier formatter on demand/paste and report issues on GitHub