Read command line options from ./.rubocop file and RUBOCOP_OPTS environment variable #3003

bolshakov · 2016-04-04T20:54:26Z

This may be useful when running rubocop using another tool, for example pronto or on CI server.

Place one option per line:

$ cat .rubocop
--no-color
--fail-fast

Configuration options are loaded from .rubocop, command line switches, and the RUBOCOP_OPTS environment variable (listed in
lowest to highest precedence; for example, an option in .rubocop can be overridden by an option in RUBOCOP_OPTS).

I borrowed idea from the similar rspec feature.

bbatsov · 2016-04-05T05:49:14Z

Thanks for working on this. We were discussing such a feature a while back, but didn't introduce it as we thought it might be a bit confusing to have an extra config file. @jonas054 @alexdowad What do you think about this?

P.S. Everyone else is welcome to share their opinion as well - useful or confusing?

alexdowad · 2016-04-05T06:22:04Z

I like it.

bolshakov · 2016-04-05T06:22:09Z

For me this is not confusing if it is done explicitly, like in Rspec.

But it may be confusing when it's done implicitly like in bundler (running bundler with some options may produce hidden bundle config file.

I propose to make it explicitly, so you can fully control command line options.

bbatsov · 2016-04-06T15:11:03Z

README.md

@@ -200,6 +200,9 @@ Command flag              | Description
 `-s/--stdin`              | Pipe source from STDIN. This is useful for editor integration.
 `--[no-]color`            | Force color output on or off.

+Configuration options are loaded from `.rubocop`, command line switches, and the `RUBOCOP_OPTS` environment variable (listed in


Configuration or Command-line? :-)

Configuration options may be taken from .rubocop file, command line options or environment variable.

How can I rephrase it to be more clear?

I'd use a wording like "Default command-line options are loaded from .rubocop and RUBOCOP_OPTS and are combined with command-line options that are explicitly passed to rubocop.". You should probably mention that explicitly passed params are going to have higher precedence.

bbatsov · 2016-04-09T17:01:04Z

spec/rubocop/options_spec.rb

+
+    subject { options.parse(command_line_options).first }
+
+    it 'ENV options have priority over command line options' do


Nothing should have a higher priority than command line options IMO.

It breaks the whole idea. You can put .rubocop file in the repository, so every one in the team will get reasonable set of default options. If one need additional options, she can pass command line options and override .rubocop settings.

Another example, I have a Makefile for running various tasks in docker. So I can run specs, rubocop, etc. in isolated and reproducible environment. Its very helpful to pass special options in some environments.

When I run RSpec on CI server, I prefer to use JUnit formatter and redirect output to file, so CI server can read this file and generate pretty output. This is done by configuring CI server, to set environment variable SPEC_OPTS="--format RspecJunitFormatter --out rspec.xml".

Thus, I can decouple my build script from knowledge about specific CI servers.

So, the purpose of .rubocop file is to provide good defaults, but the purpose of RUBOCOP_OPTS is to externally override options.

For instance, .rubocop file may contains -D option, and RUBOCOP_OPTS may be set to --require rubocop/formatter/checkstyle_formatter --format RuboCop::Formatter::CheckstyleFormatter --no-color -out rubocop.xml

So I think that order of precedence should:

1.RUBOCOP_OPTS (Highest)
2. Command line options
3. .rubocop file (lowest)

I see your point, but this seems super confusing to me and I definitely don't like it. Is anything besides rspec behaving like this?

I did some research, and have not found any other examples. I also found a commit that adds such behaviour to RSpec. And the author just says "I suppose both ways are reasonable. SPEC_OPTS priority is better for patching default rspec behaviour."

It doesn't look like this order of precedence is a common practice. So I'd be happy to implement parsing options from environment variables in any order. Having this option is much more flexible when not having it at all.

"The Art of UNIX Programming" by Raymond recommends:

CLI switches and arguments > Environment variables > Run-control files in home directory > Configuration files under /etc.

bolshakov · 2016-04-11T08:34:20Z

I updated PR to change order of precedence to the following:

Explicit command-line options
Options from RUBOCOP_OPTS environment variable
Options from .rubocop file.

I also squashed commits into one and rebased branch on top of master.

…ariable. This may be useful when running rubocop using another tool, for example [pronto](https://github.com/mmozuras/pronto). Default command-line options are loaded from `.rubocop` and `RUBOCOP_OPTS` and are combined with command-line options that are explicitly passed to `rubocop`. Thus, the options have the following order of precedence (from highest to lowest): 1. Explicit command-line options 2. Options from `RUBOCOP_OPTS` environment variable 3. Options from `.rubocop` file.

bbatsov · 2016-04-13T17:42:27Z

👍

…ariable. (rubocop#3003) This may be useful when running rubocop using another tool, for example [pronto](https://github.com/mmozuras/pronto). Default command-line options are loaded from `.rubocop` and `RUBOCOP_OPTS` and are combined with command-line options that are explicitly passed to `rubocop`. Thus, the options have the following order of precedence (from highest to lowest): 1. Explicit command-line options 2. Options from `RUBOCOP_OPTS` environment variable 3. Options from `.rubocop` file.

bolshakov force-pushed the feature/read-options-from-files branch 2 times, most recently from f05045d to f8f3de7 Compare April 4, 2016 21:06

bolshakov changed the title ~~Read command line options from ./.rubocop file.~~ Read command line options from ./.rubocop file and RUBOCOP_OPTS environment variable Apr 4, 2016

bolshakov force-pushed the feature/read-options-from-files branch from bd267cd to db199c4 Compare April 5, 2016 06:36

bbatsov reviewed Apr 6, 2016
View reviewed changes

bolshakov force-pushed the feature/read-options-from-files branch from db199c4 to a533204 Compare April 6, 2016 15:36

bbatsov reviewed Apr 9, 2016
View reviewed changes

bolshakov force-pushed the feature/read-options-from-files branch from 8fb8a79 to 20c82df Compare April 11, 2016 08:32

bolshakov force-pushed the feature/read-options-from-files branch from 20c82df to d6eed8f Compare April 11, 2016 19:45

bbatsov merged commit 092cb8a into rubocop:master Apr 13, 2016

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Read command line options from ./.rubocop file and RUBOCOP_OPTS environment variable #3003

Read command line options from ./.rubocop file and RUBOCOP_OPTS environment variable #3003

bolshakov commented Apr 4, 2016

bbatsov commented Apr 5, 2016

alexdowad commented Apr 5, 2016

bolshakov commented Apr 5, 2016

bbatsov Apr 6, 2016

bolshakov Apr 6, 2016

bbatsov Apr 9, 2016

bbatsov Apr 9, 2016

bolshakov Apr 10, 2016

bbatsov Apr 10, 2016

bolshakov Apr 11, 2016

alexdowad Apr 11, 2016

bolshakov commented Apr 11, 2016

bbatsov commented Apr 13, 2016


		subject { options.parse(command_line_options).first }

		it 'ENV options have priority over command line options' do

Read command line options from ./.rubocop file and RUBOCOP_OPTS environment variable #3003

Read command line options from ./.rubocop file and RUBOCOP_OPTS environment variable #3003

Conversation

bolshakov commented Apr 4, 2016

bbatsov commented Apr 5, 2016

alexdowad commented Apr 5, 2016

bolshakov commented Apr 5, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bolshakov commented Apr 11, 2016

bbatsov commented Apr 13, 2016