Overcommit
Ruby style guide
Overcommit | Ruby style guide | |
---|---|---|
5 | 36 | |
3,873 | 16,386 | |
- | 0.1% | |
6.6 | 6.0 | |
20 days ago | 5 days ago | |
Ruby | ||
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.
Overcommit
-
Linting and Auto-formatting Ruby Code With RuboCop
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.
-
Tailwind CSS class sorter β the custom way
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.
-
Run RuboCop on git commit with Overcommit Gem
# 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
-
Automatically sorting your Tailwind CSS class names
Overcommit - run rustywind --write during git commit to update your files before you send them off to git
-
Migrating Tachyons to Tailwind CSS (III β learnings)
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).
Ruby style guide
-
An Introduction to RuboCop for Ruby on Rails
By default, RuboCop will enforce the style defined in the Ruby Community Style Guide. We can tailor it to our specific tastes and context, but let's rely on this basic set of rules to learn how to use RuboCop.
-
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.
- Naming conventions and style guides in programming"
-
Shine bright like a.. Ruby π
Read more about Ruby.
-
10 Best Practices for Ruby Programmers: Tips for Efficient, Maintainable, and Bug-Free Code
8. Use a consistent style: Consistency is key when it comes to writing readable code. Use a consistent style throughout your codebase, and follow common Ruby style guides like Ruby Style Guide.
-
It's Official: the Standard Ruby VS Code extension
The real standard is to use default rubocop configuration which is based on https://rubystyle.guide/.
-
Why I think we should adopt and use new Ruby features
It used to, before recently. It literally said, "The and and or keywords are banned."
-
Rubyme: My minimalist Ruby Handbook
rubocop/ruby-style-guide
-
Development guidelines
As you see - there are no reference to any technology or framework. There are a lot of best-practices for almost any framework, so you can choose an appropriate one. For example - if you're a rails developer, then you can check https://github.com/rubocop/ruby-style-guide and https://github.com/rubocop/rails-style-guide but if you're a golang developer - https://github.com/uber-go/guide/blob/master/style.md and https://developers.mattermost.com/contribute/more-info/server/style-guide/
- `and` and `or` control flow operators now allowed in Rubocop
What are some alternatives?
Rugged - ruby bindings to libgit2
Rails style guide - A community-driven Ruby on Rails style guide
git-up - NOT MAINTAINED
RSpec style guide - RSpec Best Practices
git-whence - Find the merge and pull request a commit came from + fuzzy search for cherry-picks
fast-ruby - :dash: Writing Fast Ruby :heart_eyes: -- Collect Common Ruby idioms.
git-spelunk - git-spelunk, an interactive git history tool
Fundamental Ruby - :books: Fundamental programming with ruby examples and references. It covers threads, SOLID principles, design patterns, data structures, algorithms. Books for reading. Repo for website https://github.com/khusnetdinov/betterdocs
git-auto-bisect - Find the first broken commit without having to learn git bisect
Best-Ruby - Ruby Tricks, Idiomatic Ruby, Refactoring and Best Practices
pre-commit - A framework for managing and maintaining multi-language pre-commit hooks.
contracts.ruby - Contracts for Ruby.