README.adoc in caliber-0.40.0 vs README.adoc in caliber-0.41.0
- old
+ new
@@ -2,10 +2,11 @@
:toclevels: 5
:figure-caption!:
:rubocop_link: link:https://docs.rubocop.org/rubocop[RuboCop]
:rubocop_capybara_link: link:https://docs.rubocop.org/rubocop-capybara[RuboCop Capybara]
+:rubocop_disable_syntax_link: link:https://github.com/fatkodima/rubocop-disable_syntax[RuboCop Disable Syntax]
:rubocop_factory_bot_link: link:https://docs.rubocop.org/rubocop-factory_bot/[RuboCop FactoryBot]
:rubocop_packaging_link: link:https://docs.rubocop.org/rubocop-packaging[RuboCop Packaging]
:rubocop_performance_link: link:https://docs.rubocop.org/rubocop-performance[RuboCop Performance]
:rubocop_thread_safety_link: link:https://github.com/rubocop/rubocop-thread_safety[RuboCop Thread Safety]
:rubocop_rake_link: link:https://docs.rubocop.org/rubocop-rspec[RuboCop Rake]
@@ -23,10 +24,11 @@
== Features
* Provides a global configuration for the following code quality gems:
** {rubocop_link}
** {rubocop_capybara_link}
+** {rubocop_disable_syntax_link}
** {rubocop_factory_bot_link}
** {rubocop_packaging_link}
** {rubocop_performance_link}
** {rubocop_thread_safety_link}
** {rubocop_rake_link}
@@ -91,10 +93,11 @@
----
inherit_gem:
caliber:
- config/ruby.yml
- config/capybara.yml
+ - config/disable_syntax.yml
- config/factory_bot.yml
- config/packaging.yml
- config/performance.yml
- config/thread.yml
- config/rake.yml
@@ -116,10 +119,11 @@
The above will require and load the configurations for following gems:
* {rubocop_link}
* {rubocop_capybara_link}
+* {rubocop_disable_syntax_link}
* {rubocop_factory_bot_link}
* {rubocop_packaging_link}
* {rubocop_performance_link}
* {rubocop_thread_safety_link}
* {rubocop_rake_link}
@@ -149,10 +153,21 @@
The above will only require the {rubocop_capybara_link} gem _and_ load the associated configuration.
💡 This is a dependency of {rubocop_rspec_link} so doesn't need to be directly required if already requiring {rubocop_rspec_link}.
+*Disable Syntax*
+
+[source,yaml]
+----
+inherit_gem:
+ caliber:
+ - config/disable_syntax.yml
+----
+
+The above will only require the {rubocop_disable_syntax_link} gem _and_ load the associated configuration.
+
*FactoryBot*
[source,yaml]
----
inherit_gem:
@@ -236,10 +251,11 @@
[source,yaml]
----
inherit_from:
- https://raw.githubusercontent.com/bkuhlmann/caliber/main/config/ruby.yml
- https://raw.githubusercontent.com/bkuhlmann/caliber/main/config/capybara.yml
+ - https://raw.githubusercontent.com/bkuhlmann/caliber/main/config/disable_syntax.yml
- https://raw.githubusercontent.com/bkuhlmann/caliber/main/config/factory_bot.yml
- https://raw.githubusercontent.com/bkuhlmann/caliber/main/config/packaging.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
@@ -250,10 +266,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`:
* {rubocop_link}
* {rubocop_capybara_link}
+* {rubocop_disable_syntax_link}
* {rubocop_factory_bot_link}
* {rubocop_packaging_link}
* {rubocop_performance_link}
* {rubocop_thread_safety_link}
* {rubocop_rake_link}
@@ -302,10 +319,11 @@
When both RuboCop and Caliber are in sync, the following will be output:
....
RUBY: ✓
CAPYBARA: ✓
+DISABLE_SYNTAX: ✓
FACTORY_BOT: ✓
PACKAGING: ✓
PERFORMANCE: ✓
THREAD: ✓
RAKE: ✓
@@ -318,9 +336,10 @@
....
RUBY:
* Lint/BinaryOperatorWithIdenticalOperands
* Lint/ConstantDefinitionInBlock
CAPYBARA: ✓
+DISABLE_SYNTAX: ✓
FACTORY_BOT: ✓
PACKAGING: ✓
PERFORMANCE: ✓
THREAD: ✓
RAKE: ✓