README.adoc in caliber-0.10.0 vs README.adoc in caliber-0.11.0
- old
+ new
@@ -12,10 +12,11 @@
== Features
* Provides a global configuration for the following code quality gems:
** link:https://docs.rubocop.org/rubocop[RuboCop]
** link:https://github.com/rubocop/rubocop-performance[RuboCop Performance]
+** link:https://github.com/rubocop/rubocop-thread_safety[RuboCop Thread Safety]
** link:https://github.com/rubocop/rubocop-rake[RuboCop Rake]
** link:https://github.com/rubocop/rubocop-rspec[RuboCop RSpec]
== Requirements
@@ -63,10 +64,11 @@
----
inherit_gem:
caliber:
- config/ruby.yml
- config/performance.yml
+ - config/thread.yml
- config/rake.yml
- config/rspec.yml
----
The above is what `config/all.yml` expands to but now you can mix and match how you like for your
@@ -86,10 +88,11 @@
----
The above will auto-require and load the configurations for following gems:
* RuboCop Performance
+* RuboCop Thread Safety
* RuboCop Rake
* RuboCop RSpec
When you don't use the default `all.yml` configuration, then behavior changes as follows:
@@ -114,10 +117,19 @@
[source,yaml]
----
inherit_gem:
caliber:
+ - config/thread.yml
+----
+
+The above will only require the RuboCop Thread Safety gem _and_ load the associated configuration.
+
+[source,yaml]
+----
+inherit_gem:
+ caliber:
- config/rake.yml
----
The above will only require the RuboCop Rake gem _and_ load the associated configuration.
@@ -153,10 +165,11 @@
[source,yaml]
----
inherit_from:
- https://raw.githubusercontent.com/bkuhlmann/caliber/main/config/ruby.yml
- https://raw.githubusercontent.com/bkuhlmann/caliber/main/config/performance.yml
+ - https://raw.githubusercontent.com/bkuhlmann/caliber/main/config/thread.yml
- https://raw.githubusercontent.com/bkuhlmann/caliber/main/config/rake.yml
- https://raw.githubusercontent.com/bkuhlmann/caliber/main/config/rspec.yml
----
You can also target a specific version of this gem by swapping out the `main` path in the YAML URLs
@@ -165,10 +178,11 @@
Lastly, when using this YAML import approach, you'll not benefit from having all gems you need
required and installed for you. So you'll need to manually require these gems in your `Gemfile`:
* link:https://docs.rubocop.org/rubocop[RuboCop]
* link:https://docs.rubocop.org/rubocop-performance[RuboCop Performance]
+* link:https://github.com/rubocop/rubocop-thread_safety[RuboCop Thread Safety]
* link:https://docs.rubocop.org/rubocop-rspec[RuboCop Rake]
* link:https://docs.rubocop.org/rubocop-rspec[RuboCop RSpec]
== Development
@@ -198,10 +212,11 @@
When both RuboCop and Caliber are in sync, the following will be output:
....
RUBY: ✓
PERFORMANCE: ✓
+THREAD: ✓
RAKE: ✓
RSPEC: ✓
....
When RuboCop has finally enabled cops that Caliber already has enabled, the following will display
@@ -210,9 +225,10 @@
....
RUBY:
* Lint/BinaryOperatorWithIdenticalOperands
* Lint/ConstantDefinitionInBlock
PERFORMANCE: ✓
+THREAD: ✓
RAKE: ✓
RSPEC:
* RSpec/StubbedMock
....