Create a corresponding .editorconfig for ruby code style

[dazza-codes]

The purpose of this issue is to identify a way that we can auto-format code in our IDEs so that it's consistent with rubocop style checks. The question is, how do we translate the rubop style settings from the dlss_baseline.yml into an .editorconfig file?

• https://github.com/sul-dlss/dlss_cops/blob/master/config/dlss_baseline.yml

Rubocop is a style checker that enforces style after the fact. It does not facilitate the creation or autoformatting of consistent code in an IDE. There are some rubocop plugins that enable warnings in IDEs that code is inconsistent with rubocop, but they have to constantly run rubocop in the background to check code (performance hit). Some IDEs do not provide enough configuration options to support developing code in a style that is consistent with rubocop settings. This is where http://editorconfig.org/ comes in. It can help to configure an IDE in a way that auto-formats code in a consistent way, across IDEs.

Initial suggestion from slack...

@mjgiarlo - investigating a possible connection, if any, between rubocop ruby style stuff and http://editorconfig.org/

• e.g.
  • https://github.com/bbatsov/rubocop/blob/master/.editorconfig
  • https://github.com/AtomLinter/linter-rubocop/blob/master/.editorconfig
• seems like each project can define it’s own style this way and various IDEs can use it for autoformatting
• atom support:
  • https://discuss.atom.io/t/editorconfig-support/327/2
  • https://github.com/sindresorhus/atom-editorconfig
• JetBrains support:
  • https://plugins.jetbrains.com/plugin/7294-editorconfig
• longer story - JetBrains IDEs (IntelliJ, RubyMine, etc.) have a plugin to support http://editorconfig.org/ to specify the code style details. Seems like editorconfig.org is something like a generic .vimrc or .emacs code style system that maybe many other IDEs support. I’m going to learn a little more about it, because I’m constantly getting tiny inconsistencies in the way RubyMine auto-formats my ruby code in a way that is slightly inconsistent with the rubocop settings for a project. Plus, the RubyMine code style settings just don’t have enough options to even enable some of the rubocop settings. I’m hoping to find a way that rubocop could create a .editorconfig file that the RubyMine-EditorConfig plugin can read. Then, presto, my IDE auto-formatting will conform to rubocop settings and I won’t always have to think about it or always check and correct with rubocop -a.

Curious to see if there is a way to create an .editorconfig that is consistent with https://github.com/sul-dlss/dlss_cops - would be great if rubocop can auto-gen an .editorconfig file, but manual creation might not be too tedious.

[dazza-codes]

Related issue on rubocop - https://github.com/bbatsov/rubocop/issues/3409

• requests a feature to go from .editorconfig to a .rubocop.yml file
• request denied, suggests a side-project to do that

[dazza-codes]

Related style guide project

• https://github.com/magnetis/styleguide#editorconfig
• https://github.com/magnetis/styleguide/blob/master/Ruby.md

Related style formatter that works with editorconfig for javascript

• https://github.com/jedmao/codepainter#recommended-use

[dazza-codes]

Most of the .editorconfig files seem to contain a very limited set of properties, that may not support all of the features that are checked by rubocop. Looking at some examples for ruby projects, I've got the following:

# EditorConfig helps developers define and maintain consistent
# coding styles between different editors and IDEs
# http://editorconfig.org/

root = true

[*]

# We recommend you to keep these unchanged
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

[*.rb]
# Change these settings to your own preference
indent_style = space
indent_size = 2

[*.md]
trim_trailing_whitespace = false

Note, for example, that this doesn't get specific about subsections of a ruby file; we want the private or protected sections of a ruby file to have methods indented by 4 spaces.

[dazza-codes]

I also want it to specify style for indentations on blocks of code and how wrapping occurs for multi-line hashes, arrays, class initialization, etc. For example, RubyMine formatter creates this:

    FactoryGirl.create(:author_identity,
                       author: author
    )

But rubocop wants this (fortunately rubocop -a can fix this, but not while I'm coding it):

    FactoryGirl.create(:author_identity,
                       author: author
                      )