README.adoc in caliber-0.35.0 vs README.adoc in caliber-0.36.0
- old
+ new
@@ -3,10 +3,11 @@
:figure-caption!:
:rubocop_link: link:https://docs.rubocop.org/rubocop[RuboCop]
:rubocop_capybara_link: link:https://docs.rubocop.org/rubocop-capybara[RuboCop Capybara]
: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]
:rubocop_rspec_link: link:https://docs.rubocop.org/rubocop-rspec[RuboCop RSpec]
@@ -23,20 +24,19 @@
* Provides a global configuration for the following code quality gems:
** {rubocop_link}
** {rubocop_capybara_link}
** {rubocop_factory_bot_link}
+** {rubocop_packaging_link}
** {rubocop_performance_link}
** {rubocop_thread_safety_link}
** {rubocop_rake_link}
** {rubocop_rspec_link}
== Requirements
* link:https://www.ruby-lang.org[Ruby]
-* link:https://github.com/ruby/rake[Rake]
-* link:https://rspec.info[RSpec]
== Setup
To install _with_ security, run:
@@ -92,10 +92,11 @@
inherit_gem:
caliber:
- config/ruby.yml
- config/capybara.yml
- config/factory_bot.yml
+ - config/packaging.yml
- config/performance.yml
- config/thread.yml
- config/rake.yml
- config/rspec.yml
----
@@ -116,10 +117,11 @@
The above will require and load the configurations for following gems:
* {rubocop_link}
* {rubocop_capybara_link}
* {rubocop_factory_bot_link}
+* {rubocop_packaging_link}
* {rubocop_performance_link}
* {rubocop_thread_safety_link}
* {rubocop_rake_link}
* {rubocop_rspec_link}
@@ -160,10 +162,21 @@
The above will only require the {rubocop_factory_bot_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}.
+*Packaging*
+
+[source,yaml]
+----
+inherit_gem:
+ caliber:
+ - config/packaging.yml
+----
+
+The above will only require the {rubocop_packaging_link} gem _and_ load the associated configuration.
+
*Performance*
[source,yaml]
----
inherit_gem:
@@ -224,10 +237,11 @@
----
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/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
- https://raw.githubusercontent.com/bkuhlmann/caliber/main/config/rspec.yml
----
@@ -237,10 +251,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_factory_bot_link}
+* {rubocop_packaging_link}
* {rubocop_performance_link}
* {rubocop_thread_safety_link}
* {rubocop_rake_link}
* {rubocop_rspec_link}
@@ -288,10 +303,11 @@
....
RUBY: ✓
CAPYBARA: ✓
FACTORY_BOT: ✓
+PACKAGING: ✓
PERFORMANCE: ✓
THREAD: ✓
RAKE: ✓
RSPEC: ✓
....
@@ -303,9 +319,10 @@
RUBY:
* Lint/BinaryOperatorWithIdenticalOperands
* Lint/ConstantDefinitionInBlock
CAPYBARA: ✓
FACTORY_BOT: ✓
+PACKAGING: ✓
PERFORMANCE: ✓
THREAD: ✓
RAKE: ✓
RSPEC:
* RSpec/StubbedMock