Overcommit VS rubyfmt

A great way to ensure that all Ruby code in a project is linted and formatted properly before being checked into source control is by setting up a Git pre-commit hook that runs RuboCop on each staged file. This article will show you how to set it up with Overcommit, a tool for managing and configuring Git pre-commit hooks, but you can also integrate RuboCop with other tools if you already have an existing pre-commit workflow.

As a team we want to ensure that everybody commits our templates with classes rightly ordered. We use Overcommit to enforce consistency but any similar tool will do.

# Use this file to configure the Overcommit hooks you wish to use. This will # extend the default configuration defined in: # https://github.com/sds/overcommit/blob/master/config/default.yml # # At the topmost level of this YAML file is a key representing type of hook # being run (e.g. pre-commit, commit-msg, etc.). Within each type you can # customize each hook, such as whether to only run it on certain files (via # `include`), whether to only display output if it fails (via `quiet`), etc. # # For a complete list of hooks, see: # https://github.com/sds/overcommit/tree/master/lib/overcommit/hook # # For a complete list of options that you can use to customize hooks, see: # https://github.com/sds/overcommit#configuration # # Uncomment the following lines to make the configuration take effect. PreCommit: RuboCop: enabled: true on_warn: fail # Treat all warnings as failures problem_on_unmodified_line: ignore # run RuboCop only on modified code

Overcommit - run rustywind --write during git commit to update your files before you send them off to git

By the way, it’s nice that adding (or completely redefining) the scale system is so easy in Tailwind. On the other hand, care must be taken that modifying the defaults is not overused. In the end, we added an Overcommit rule banning further updates of the Tailwind configuration (of course, this can be temporarily disabled, when truly needed).

We're using rubyfmt along with a rubocop config which does its best to strip out any styling decisions.

Looked at https://github.com/penelopezone/rubyfmt and other options but none seem to actually work.

RubyFmt is a brand-new code formatter that's written in Rust and currently under active development. Like Prettier, it is intended to be a formatter and not a code analysis tool. It hasn't seen a stable release just yet, so you should probably hold off on adopting it right now, but it's definitely one to keep an eye on.

Another example: code formatters. You mention gofmt (which you incorrectly put next to Ruby even though it's for Go)... There are lots of code formatters for Ruby, even if you only consider ones directly inspired/influenced by gofmt. A quick google turned up at least three of those: https://github.com/pariz/rubo-format, https://github.com/penelopezone/rubyfmt, and https://github.com/ruby-formatter/rufo. I'm pretty sure rubocop is used in Ruby more than any of those, but rubocop is less directly influenced by gofmt. So what do you choose? The project(s) that's more closely analogous? Or the more popular formatter?