rubocop-rspec 2.22.0 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e786386e218833ac7f78af9ffcadadb6bf6c822a31b455cac1567152fd3bc9c0
-  data.tar.gz: 384170b4ae3a06c05b30855ae9361057c53226b40b924d4ec1d49c0d15195658
+  metadata.gz: 4a2433cc3212de48725bca4fa2f8216ef0742950d1b0ad0a52e0d717050ede4e
+  data.tar.gz: 3e43165a772275ece7344813b6dfc5196669763013c0bedc3b75107cf6fa0f30
 SHA512:
-  metadata.gz: 554345811f404b27a39fd522e0085022c39147e0487f04ea77ed7887002451af112e2ddc45ad94841c0a4201a76f37fbfb7a2e64aed3c7efa91cddf1a30843bc
-  data.tar.gz: 22882a56ddf03c55d6eaf299fb05197c835049054231e6d7798e2ca3eac5cbd9840eeada823a12431b00efd37289a8353792dfe3c8f653b2606f9ccda480615a
+  metadata.gz: 41a9171c098150e3349977cd08df5f369fe2d33c0bb4f1b29edcfb2633eae2c880ab1ff71a9c4a1ee5dc28645a6359ecd3e4ab99a822ac576523386e78364ee2
+  data.tar.gz: af1c164ac3d8c9e9ed61611fa9877c459656f695fd45c057c776af99304fcd8471fa00d958d7bf650ba46f82056ae96accd12cfeec17eb1a00129baffdb51768

data/CHANGELOG.md

@@ -2,6 +2,166 @@
 
 ## Master (Unreleased)
 
+## 3.4.0 (2025-01-20)
+
+- Fix `RSpec/SortMetadata` cop to limit sorting to trailing metadata arguments. ([@cbliard])
+- Replace `RSpec/StringAsInstanceDoubleConstant` with `RSpec/VerifiedDoubleReference` configured to only support constant class references. ([@corsonknowles])
+- Fix `RSpec/EmptyExampleGroup` cop false positive when a simple conditional is used inside an iterator. ([@lovro-bikic])
+
+## 3.3.0 (2024-12-12)
+
+- Deprecate `top_level_group?` method from `TopLevelGroup` mixin as all of its callers were intentionally removed from `Rubocop/RSpec`. ([@corsonknowles])
+- Fix false positive for RSpec/EmptyMetadata for splat kwargs. ([@pirj])
+
+## 3.2.0 (2024-10-26)
+
+- Fix `RSpec/VoidExpect` to only operate inside an example block. ([@corsonknowles])
+- Change `RSpec/ContextWording` cop to always report an offense when both `Prefixes` and `AllowedPatterns` are empty. ([@ydah])
+- Add support for `and` and `or` compound matchers to `RSpec/ChangeByZero` cop. ([@ydah])
+
+## 3.1.0 (2024-10-01)
+
+- Add `RSpec/StringAsInstanceDoubleConstant` to check for and correct strings used as instance_doubles. ([@corsonknowles])
+- Fix false-positive for `RSpec/UnspecifiedException` when a method is literally named `raise_exception`. ([@aarestad])
+- Fix false-positive for `RSpec/UnspecifiedException` when `not_to raise_error` is used within a block. ([@aarestad], [@G-Rath])
+
+## 3.0.5 (2024-09-07)
+
+- Fix false-negative and error for `RSpec/MetadataStyle` when non-literal args are used in metadata in `EnforceStyle: hash`. ([@cbliard])
+- Improve offense message for `RSpec/IndexedLet`. ([@earlopain])
+
+## 3.0.4 (2024-08-05)
+
+- Fix false-negative for `UnspecifiedException` when matcher is chained. ([@r7kamura])
+
+## 3.0.3 (2024-07-12)
+
+- Add support for Unicode RIGHT SINGLE QUOTATION MARK in `RSpec/ExampleWording`. ([@jdufresne])
+- Suppress deprecation warning for `RSpec/MultipleExpectations`, `RSpec/MultipleMemoizedHelpers`, and `RSpec/NestedGroups` cops. ([@koic])
+
+## 3.0.2 (2024-07-02)
+
+- Fix wrong autocorrect for `RSpec/ScatteredSetup` when hook contains heredoc. ([@earlopain])
+- Fix false negative for `RSpec/PredicateMatcher` when expectation contains custom failure message. ([@earlopain])
+- Facilitate the 3.0 upgrade flow with proper extracted cop messages. ([@jeppester])
+
+## 3.0.1 (2024-06-11)
+
+- Bump RuboCop requirement to +1.61. ([@ydah])
+
+## 3.0.0 (2024-06-11)
+
+- Remove extracted cops in `Capybara`, `FactoryBot` and `Rails` departments. ([@ydah])
+- Remove `RuboCop::RSpec::Language::NodePattern`. ([@ydah])
+- Remove `RSpec/FilePath` cop. ([@ydah])
+- Remove `RSpec/Capybara/FeatureMethods` cop. If you are using this cop, change it to use `RSpec/Dialect`. ([@ydah])
+- Add new `RSpec/MissingExpectationTargetMethod` cop. ([@krororo])
+- Fix an error for `RSpec/ScatteredSetup` when one of the hooks is an empty block. ([@earlopain])
+
+These previously pending cops are now enabled by default: `RSpec/BeEmpty`, `RSpec/BeEq`, `RSpec/BeNil`, `RSpec/ChangeByZero`, `RSpec/ClassCheck`, `RSpec/ContainExactly`, `RSpec/DuplicatedMetadata`, `RSpec/EmptyMetadata`, `RSpec/EmptyOutput`, `RSpec/Eq`, `RSpec/ExcessiveDocstringSpacing`, `RSpec/ExpectInLet`, `RSpec/IdenticalEqualityAssertion`, `RSpec/IndexedLet`, `RSpec/IsExpectedSpecify`, `RSpec/MatchArray`, `RSpec/MetadataStyle`, `RSpec/NoExpectationExample`, `RSpec/PendingWithoutReason`, `RSpec/ReceiveMessages`, `RSpec/RedundantAround`, `RSpec/RedundantPredicateMatcher`, `RSpec/RemoveConst`, `RSpec/RepeatedSubjectCall`, `RSpec/SkipBlockInsideExample`, `RSpec/SortMetadata`, `RSpec/SpecFilePathFormat`, `RSpec/SpecFilePathSuffix`, `RSpec/SubjectDeclaration`, `RSpec/UndescriptiveLiteralsDescription`, and `RSpec/VerifiedDoubleReference`.
+
+Read more about how to upgrade in https://docs.rubocop.org/rubocop-rspec/upgrade_to_version_3.html
+
+## 2.31.0 (2024-06-07)
+
+- Support `AutoCorrect: contextual` option for LSP. ([@ydah])
+
+## 2.30.0 (2024-06-03)
+
+- Add new `RSpec/ExpectInLet` cop. ([@yasu551])
+
+## 2.29.2 (2024-05-02)
+
+- Fix beginless and endless range bug for RepeatedIncludeExample cop. ([@hasghari])
+- Fix a false positive for `RSpec/RepeatedSubjectCall` when subject is used as argument to function call. ([@K-S-A])
+
+## 2.29.1 (2024-04-05)
+
+- Fix an error in the default configuration. ([@ydah])
+
+## 2.29.0 (2024-04-04)
+
+- Fix an autocorrect error for `RSpec/ExpectActual`. ([@bquorning])
+- Add new `RSpec/UndescriptiveLiteralsDescription` cop. ([@ydah])
+- Add new `RSpec/EmptyOutput` cop. ([@bquorning])
+
+## 2.28.0 (2024-03-30)
+
+- Extract RSpec Rails cops to a separate repository, [`rubocop-rspec_rails`](https://github.com/rubocop/rubocop-rspec_rails). The `rubocop-rspec_rails` repository is a dependency of `rubocop-rspec` and the cops related to rspec-rails are aliased (`RSpec/Rails/Foo` == `RSpecRails/Foo`) until v3.0 is released, so the change will be invisible to users until then. ([@ydah])
+
+## 2.27.1 (2024-03-03)
+
+- Fix a false positive for `RSpec/RepeatedSubjectCall` when `subject.method_call`. ([@ydah])
+- Add configuration option `OnlyStaticConstants` to `RSpec/DescribedClass`. ([@ydah])
+
+## 2.27.0 (2024-03-01)
+
+- Add new `RSpec/IsExpectedSpecify` cop. ([@ydah])
+- Add new `RSpec/RepeatedSubjectCall` cop. ([@drcapulet])
+- Add support for `assert_true`, `assert_false`, `assert_not_equal`, `assert_not_nil`, `*_empty`, `*_predicate`, `*_kind_of`, `*_in_delta`, `*_match`, `*_instance_of` and `*_includes` assertions in `RSpec/Rails/MinitestAssertions`. ([@ydah], [@G-Rath])
+- Support asserts with messages in `RSpec/BeEmpty`. ([@G-Rath])
+- Fix a false positive for `RSpec/ExpectActual` when used with rspec-rails routing matchers. ([@naveg])
+- Add configuration option `ResponseMethods` to `RSpec/Rails/HaveHttpStatus`. ([@ydah])
+- Fix a false negative for `RSpec/DescribedClass` when class with constant. ([@ydah])
+- Fix a false positive for `RSpec/ExampleWithoutDescription` when `specify` with multi-line block and missing description. ([@ydah])
+- Fix an incorrect autocorrect for `RSpec/ChangeByZero` when compound expectations with line break before `.by(0)`. ([@ydah])
+
+## 2.26.1 (2024-01-05)
+
+- Fix an error for `RSpec/SharedExamples` when using examples without argument. ([@ydah])
+
+## 2.26.0 (2024-01-04)
+
+- Add new `RSpec/RedundantPredicateMatcher` cop. ([@ydah])
+- Add new `RSpec/RemoveConst` cop. ([@swelther])
+- Add support for correcting "it will" (future tense) for `RSpec/ExampleWording`. ([@jdufresne])
+- Add support for `symbol` style for `RSpec/SharedExamples`. ([@jessieay])
+- Ensure `PendingWithoutReason` can detect violations inside shared groups. ([@robinaugh])
+
+## 2.25.0 (2023-10-27)
+
+- Add support single quoted string and percent string and heredoc for `RSpec/Rails/HttpStatus`. ([@ydah])
+- Change to be inline disable for `RSpec/SpecFilePathFormat` like `RSpec/FilePath`. ([@ydah])
+- Fix a false positive for `RSpec/MetadataStyle` with example groups having multiple string arguments. ([@franzliedke])
+
+## 2.24.1 (2023-09-23)
+
+- Fix an error when using `RSpec/FilePath` and revert to enabled by default. If you have already moved to `RSpec/SpecFilePathSuffix` and `RSpec/SpecFilePathFormat`, disable `RSpec/FilePath` explicitly as `Enabled: false`. The `RSpec/FilePath` before migration and the `RSpec/SpecFilePathSuffix` and `RSpec/SpecFilePathFormat` as the target are available respectively. ([@ydah])
+
+## 2.24.0 (2023-09-08)
+
+- Split `RSpec/FilePath` into `RSpec/SpecFilePathSuffix` and `RSpec/SpecFilePathFormat`. `RSpec/FilePath` cop is disabled by default and the two new cops are pending and need to be enabled explicitly. ([@ydah])
+- Add new `RSpec/Eq` cop. ([@ydah])
+- Add `RSpec/MetadataStyle` and `RSpec/EmptyMetadata` cops. ([@r7kamura])
+- Add support `RSpec/Rails/HttpStatus` when `have_http_status` with string argument. ([@ydah])
+- Fix an infinite loop error when `RSpec/ExcessiveDocstringSpacing` finds a description with non-ASCII leading/trailing whitespace. ([@bcgraham])
+- Fix an incorrect autocorrect for `RSpec/ReceiveMessages` when return values declared between stubs. ([@marocchino])
+- Fix a false positive `RSpec/Focus` when chained method call and inside define method. ([@ydah])
+
+## 2.23.2 (2023-08-09)
+
+- Fix an incorrect autocorrect for `RSpec/ReceiveMessages` when method is only non-word character. ([@marocchino])
+- Fix a false positive for `RSpec/ReceiveMessages` when return with splat. ([@marocchino])
+
+## 2.23.1 (2023-08-07)
+
+- Mark to `Safe: false` for `RSpec/Rails/NegationBeValid` cop. ([@ydah])
+- Declare autocorrect as unsafe for `RSpec/ReceiveMessages`. ([@bquorning])
+
+## 2.23.0 (2023-07-30)
+
+- Add new `RSpec/Rails/NegationBeValid` cop. ([@ydah])
+- Fix a false negative for `RSpec/ExcessiveDocstringSpacing` when finds description with em space. ([@ydah])
+- Fix a false positive for `RSpec/EmptyExampleGroup` when example group with examples defined in `if` branch inside iterator. ([@ydah])
+- Update the message output of `RSpec/ExpectActual` to include the word 'value'. ([@corydiamand])
+- Fix a false negative for `RSpec/Pending` when `it` without body. ([@ydah])
+- Add new `RSpec/ReceiveMessages` cop. ([@ydah])
+- Change default.yml path to use `**/spec/*` instead of `spec/*`. ([@ydah])
+- Add `AllowedIdentifiers` and `AllowedPatterns` configuration option to `RSpec/IndexedLet`. ([@ydah])
+- Fix `RSpec/NamedSubject` when block has no body. ([@splattael])
+- Fix `RSpec/LetBeforeExamples` autocorrect incompatible with `RSpec/ScatteredLet` autocorrect. ([@ydah])
+- Update `RSpec/Focus` to support `shared_context` and `shared_examples`. ([@tmaier])
+
 ## 2.22.0 (2023-05-06)
 
 - Extract factory_bot cops to a separate repository, [`rubocop-factory_bot`](https://github.com/rubocop/rubocop-factory_bot). The `rubocop-factory_bot` repository is a dependency of `rubocop-rspec` and the factory_bot cops are aliased (`RSpec/FactoryBot/Foo` == `FactoryBot/Foo`) until v3.0 is released, so the change will be invisible to users until then. ([@ydah])
@@ -22,9 +182,9 @@
 - Add support `be_status` style for `RSpec/Rails/HttpStatus`. ([@ydah])
 - Add support for shared example groups to `RSpec/EmptyLineAfterExampleGroup`. ([@pirj])
 - Add support for `RSpec/HaveHttpStatus` when using `response.code`. ([@ydah])
-- Fix order of expected and actual in correction for `RSpec/Rails/MinitestAssertions` ([@mvz])
+- Fix order of expected and actual in correction for `RSpec/Rails/MinitestAssertions`. ([@mvz])
 - Fix a false positive for `RSpec/DescribedClassModuleWrapping` when RSpec.describe numblock is nested within a module. ([@ydah])
-- Fix a false positive for `RSpec/FactoryBot/ConsistentParenthesesStyle` inside `&&`, `||` and `:?` when `omit_parentheses` is on ([@dmitrytsepelev])
+- Fix a false positive for `RSpec/FactoryBot/ConsistentParenthesesStyle` inside `&&`, `||` and `:?` when `omit_parentheses` is on. ([@dmitrytsepelev])
 - Fix a false positive for `RSpec/PendingWithoutReason` when pending/skip has a reason inside an example group. ([@ydah])
 - Fix a false negative for `RSpec/RedundantAround` when redundant numblock `around`. ([@ydah])
 - Change `RSpec/ContainExactly` to ignore calls with no arguments, and change `RSpec/MatchArray` to ignore calls with an empty array literal argument. ([@ydah], [@bquorning])
@@ -77,7 +237,7 @@
 - Improved processing speed for `RSpec/Be`, `RSpec/ExpectActual`, `RSpec/ImplicitExpect`, `RSpec/MessageSpies`, `RSpec/PredicateMatcher` and `RSpec/Rails/HaveHttpStatus`. ([@ydah])
 - Fix wrong autocorrection in `n_times` style on `RSpec/FactoryBot/CreateList`. ([@r7kamura])
 - Fix a false positive for `RSpec/FactoryBot/ConsistentParenthesesStyle` when using `generate` with multiple arguments. ([@ydah])
-- Mark `RSpec/BeEq` as `Safe: false` ([@r7kamura])
+- Mark `RSpec/BeEq` as `Safe: false`. ([@r7kamura])
 - Add `RSpec/DuplicatedMetadata` cop. ([@r7kamura])
 - Mark `RSpec/BeEql` as `Safe: false`. ([@r7kamura])
 - Add `RSpec/PendingWithoutReason` cop. ([@r7kamura])
@@ -110,8 +270,8 @@
 - Fix a false positive for `RSpec/Capybara/SpecificMatcher` when `have_css("a")` without attribute. ([@ydah])
 - Update `RSpec/ExampleWording` cop to raise error for insufficient descriptions. ([@akrox58])
 - Add new `RSpec/Capybara/NegationMatcher` cop. ([@ydah])
-- Add `AllowedPatterns` configuration option to `RSpec/NoExpectationExample`.  ([@ydah])
-- Improve `RSpec/NoExpectationExample` cop to ignore examples skipped or pending via metadata.  ([@pirj])
+- Add `AllowedPatterns` configuration option to `RSpec/NoExpectationExample`. ([@ydah])
+- Improve `RSpec/NoExpectationExample` cop to ignore examples skipped or pending via metadata. ([@pirj])
 - Add `RSpec/FactoryBot/ConsistentParenthesesStyle` cop. ([@Liberatys])
 - Add `RSpec/Rails/InferredSpecType` cop. ([@r7kamura])
 - Add new `RSpec/Capybara/SpecificActions` cop. ([@ydah])
@@ -134,7 +294,7 @@
 ## 2.13.0 (2022-09-12)
 
 - Fix `RSpec/FilePath` cop missing mismatched expanded namespace. ([@sl4vr])
-- Add new `AllowConsecutiveOneLiners` (default true) option for `Rspec/EmptyLineAfterHook` cop. ([@ngouy])
+- Add new `AllowConsecutiveOneLiners` (default true) option for `RSpec/EmptyLineAfterHook` cop. ([@ngouy])
 - Add autocorrect support for `RSpec/EmptyExampleGroup`. ([@r7kamura])
 - Fix `RSpec/ChangeByZero` with compound expressions using `&` or `|` operators. ([@BrianHawley])
 - Add `RSpec/NoExpectationExample`. ([@r7kamura])
@@ -427,7 +587,7 @@
 - Add config to `RSpec/VerifiedDoubles` to enforcement of verification on unnamed doubles. ([@BrentWheeldon])
 - Fix `FactoryBot/AttributeDefinedStatically` not working when there is a non-symbol key. ([@vzvu3k6k])
 - Fix false positive in `RSpec/ImplicitSubject` when `is_expected` is used inside `its()` block. ([@Darhazer])
-- Add `single_statement_only` style to  `RSpec/ImplicitSubject` as a more relaxed alternative to `single_line_only`. ([@Darhazer])
+- Add `single_statement_only` style to `RSpec/ImplicitSubject` as a more relaxed alternative to `single_line_only`. ([@Darhazer])
 - Add `RSpec/UnspecifiedException` as a default cop to encourage more-specific `expect{}.to raise_error(ExceptionType)`, or `raise_exception` style handling of exceptions. ([@daveworth])
 
 ## 1.29.1 (2018-09-01)
@@ -462,14 +622,14 @@
 
 ## 1.26.0 (2018-06-06)
 
-- Fix false positive in `RSpec/EmptyExampleGroup` cop when methods named like a RSpec method are used.  ([@Darhazer])
+- Fix false positive in `RSpec/EmptyExampleGroup` cop when methods named like a RSpec method are used. ([@Darhazer])
 - Fix `Capybara/FeatureMethods` not working when there is require before the spec. ([@Darhazer])
 - Fix `RSpec/EmptyLineAfterFinalLet`: allow a comment to be placed after latest let, requiring empty line after the comment. ([@Darhazer])
 - Add `RSpec/ReceiveCounts` cop to enforce usage of :once and :twice matchers. ([@Darhazer])
 
 ## 1.25.1 (2018-04-10)
 
-- Fix false positive in `RSpec/Pending` cop when pending is used as a method name.  ([@Darhazer])
+- Fix false positive in `RSpec/Pending` cop when pending is used as a method name. ([@Darhazer])
 - Fix `FactoryBot/DynamicAttributeDefinedStatically` false positive when using symbol proc argument for a sequence. ([@tdeo])
 
 ## 1.25.0 (2018-04-07)
@@ -477,7 +637,7 @@
 - Add `RSpec/SharedExamples` cop to enforce consistent usage of string to titleize shared examples. ([@anthony-robin])
 - Add `RSpec/Be` cop to enforce passing argument to the generic `be` matcher. ([@Darhazer])
 - Fix false positives in `StaticAttributeDefinedDynamically` and `ReturnFromStub` when a const is used in an array or hash. ([@Darhazer])
-- Add `RSpec/Pending` cop to enforce no existing pending or skipped examples.  This is disabled by default. ([@patrickomatic])
+- Add `RSpec/Pending` cop to enforce no existing pending or skipped examples. This is disabled by default. ([@patrickomatic])
 - Fix `RSpec/NestedGroups` cop support --auto-gen-config. ([@walf443])
 - Fix false positives in `Capybara/FeatureMethods` when feature methods are used as property names in a factory. ([@Darhazer])
 - Allow configuring enabled methods in `Capybara/FeatureMethods`. ([@Darhazer])
@@ -591,7 +751,7 @@ Compatibility release so users can upgrade RuboCop to 0.51.0. No new features.
 ## 1.13.0 (2017-03-07)
 
 - Add repeated 'it' detection to `RSpec/ExampleWording` cop. ([@dgollahon])
-- Add \[observed_nesting/max_nesting\] info to `RSpec/NestedGroups` messages. ([@dgollahon])
+- Add [observed_nesting/max_nesting] info to `RSpec/NestedGroups` messages. ([@dgollahon])
 - Add `RSpec/ItBehavesLike` cop. ([@dgollahon])
 - Add `RSpec/SharedContext` cop. ([@Darhazer])
 - `RSpec/MultipleExpectations`: Count aggregate_failures block as single expectation. ([@Darhazer])
@@ -762,6 +922,7 @@ Compatibility release so users can upgrade RuboCop to 0.51.0. No new features.
 
 <!-- Contributors (alphabetically) -->
 
+[@aarestad]: https://github.com/aarestad
 [@abrom]: https://github.com/abrom
 [@ahukkanen]: https://github.com/ahukkanen
 [@akiomik]: https://github.com/akiomik
@@ -773,23 +934,29 @@ Compatibility release so users can upgrade RuboCop to 0.51.0. No new features.
 [@aried3r]: https://github.com/aried3r
 [@baberthal]: https://github.com/baberthal
 [@backus]: https://github.com/backus
+[@bcgraham]: https://github.com/bcgraham
 [@biinari]: https://github.com/biinari
 [@bmorrall]: https://github.com/bmorrall
 [@bquorning]: https://github.com/bquorning
 [@brentwheeldon]: https://github.com/BrentWheeldon
 [@brianhawley]: https://github.com/BrianHawley
+[@cbliard]: https://github.com/cbliard
 [@cfabianski]: https://github.com/cfabianski
 [@clupprich]: https://github.com/clupprich
 [@composerinteralia]: https://github.com/composerinteralia
+[@corsonknowles]: https://github.com/corsonknowles
+[@corydiamand]: https://github.com/corydiamand
 [@darhazer]: https://github.com/Darhazer
 [@daveworth]: https://github.com/daveworth
 [@dduugg]: https://github.com/dduugg
 [@deivid-rodriguez]: https://github.com/deivid-rodriguez
 [@dgollahon]: https://github.com/dgollahon
 [@dmitrytsepelev]: https://github.com/dmitrytsepelev
+[@drcapulet]: https://github.com/drcapulet
 [@drowze]: https://github.com/Drowze
 [@dswij]: https://github.com/dswij
 [@dvandersluis]: https://github.com/dvandersluis
+[@earlopain]: https://github.com/earlopain
 [@edgibbs]: https://github.com/edgibbs
 [@eikes]: https://github.com/eikes
 [@eitoball]: https://github.com/eitoball
@@ -799,30 +966,39 @@ Compatibility release so users can upgrade RuboCop to 0.51.0. No new features.
 [@faucct]: https://github.com/faucct
 [@foton]: https://github.com/foton
 [@francois-ferrandis]: https://github.com/francois-ferrandis
+[@franzliedke]: https://github.com/franzliedke
 [@g-rath]: https://github.com/G-Rath
 [@geniou]: https://github.com/geniou
 [@gsamokovarov]: https://github.com/gsamokovarov
 [@harry-graham]: https://github.com/harry-graham
 [@harrylewis]: https://github.com/harrylewis
+[@hasghari]: https://github.com/hasghari
 [@hosamaly]: https://github.com/hosamaly
 [@ignaciovillaverde]: https://github.com/ignaciovillaverde
 [@jaredbeck]: https://github.com/jaredbeck
 [@jaredmoody]: https://github.com/jaredmoody
+[@jdufresne]: https://github.com/jdufresne
 [@jeffreyc]: https://github.com/jeffreyc
+[@jeppester]: https://github.com/jeppester
+[@jessieay]: https://github.com/jessieay
 [@jfragoulis]: https://github.com/jfragoulis
 [@johnny-miyake]: https://github.com/johnny-miyake
 [@jojos003]: https://github.com/jojos003
 [@jonatas]: https://github.com/jonatas
 [@jtannas]: https://github.com/jtannas
+[@k-s-a]: https://github.com/K-S-A
 [@kellysutton]: https://github.com/kellysutton
 [@koic]: https://github.com/koic
+[@krororo]: https://github.com/krororo
 [@kuahyeow]: https://github.com/kuahyeow
 [@lazycoder9]: https://github.com/lazycoder9
 [@leoarnold]: https://github.com/leoarnold
 [@liberatys]: https://github.com/Liberatys
 [@lokhi]: https://github.com/lokhi
+[@lovro-bikic]: https://github.com/lovro-bikic
 [@luke-hill]: https://github.com/luke-hill
 [@m-yamashita01]: https://github.com/M-Yamashita01
+[@marocchino]: https://github.com/marocchino
 [@miguelfteixeira]: https://github.com/miguelfteixeira
 [@mkenyon]: https://github.com/mkenyon
 [@mkrawc]: https://github.com/mkrawc
@@ -830,6 +1006,7 @@ Compatibility release so users can upgrade RuboCop to 0.51.0. No new features.
 [@mockdeep]: https://github.com/mockdeep
 [@mothonmars]: https://github.com/MothOnMars
 [@mvz]: https://github.com/mvz
+[@naveg]: https://github.com/naveg
 [@nc-holodakg]: https://github.com/nc-holodakg
 [@nevir]: https://github.com/nevir
 [@ngouy]: https://github.com/ngouy
@@ -849,6 +1026,7 @@ Compatibility release so users can upgrade RuboCop to 0.51.0. No new features.
 [@rafix02]: https://github.com/Rafix02
 [@redross]: https://github.com/redross
 [@renanborgescampos]: https://github.com/renanborgescampos
+[@robinaugh]: https://github.com/robinaugh
 [@robotdana]: https://github.com/robotdana
 [@rolfschmidt]: https://github.com/rolfschmidt
 [@rrosenblum]: https://github.com/rrosenblum
@@ -859,17 +1037,21 @@ Compatibility release so users can upgrade RuboCop to 0.51.0. No new features.
 [@seanpdoyle]: https://github.com/seanpdoyle
 [@sl4vr]: https://github.com/sl4vr
 [@smcgivern]: https://github.com/smcgivern
+[@splattael]: https://github.com/splattael
 [@stephannv]: https://github.com/stephannv
+[@swelther]: https://github.com/swelther
 [@t3h2mas]: https://github.com/t3h2mas
 [@tdeo]: https://github.com/tdeo
 [@tejasbubane]: https://github.com/tejasbubane
 [@telmofcosta]: https://github.com/telmofcosta
 [@tietew]: https://github.com/Tietew
 [@timrogers]: https://github.com/timrogers
+[@tmaier]: https://github.com/tmaier
 [@topalovic]: https://github.com/topalovic
 [@twalpole]: https://github.com/twalpole
 [@vzvu3k6k]: https://github.com/vzvu3k6k
 [@walf443]: https://github.com/walf443
+[@yasu551]: https://github.com/yasu551
 [@ybiquitous]: https://github.com/ybiquitous
 [@ydah]: https://github.com/ydah
 [@yevhene]: https://github.com/yevhene

data/README.md

@@ -7,6 +7,15 @@
 [RSpec](https://rspec.info/)-specific analysis for your projects, as an extension to
 [RuboCop](https://github.com/rubocop/rubocop).
 
+- [Installation](#installation)
+  - [Upgrading to RuboCop RSpec v3.x](#upgrading-to-rubocop-rspec-v3x)
+  - [Upgrading to RuboCop RSpec v2.x](#upgrading-to-rubocop-rspec-v2x)
+- [Usage](#usage)
+- [Documentation](#documentation)
+- [The Cops](#the-cops)
+- [Contributing](#contributing)
+- [License](#license)
+
 ## Installation
 
 Just install the `rubocop-rspec` gem
@@ -17,10 +26,14 @@ gem install rubocop-rspec
 
 or if you use bundler put this in your `Gemfile`
 
-```
+```ruby
 gem 'rubocop-rspec', require: false
 ```
 
+### Upgrading to RuboCop RSpec v3.x
+
+Read all the details in our [Upgrade to Version 3.x](https://docs.rubocop.org/rubocop-rspec/3.0/upgrade_to_version_3.html) document.
+
 ### Upgrading to RuboCop RSpec v2.x
 
 Read all the details in our [Upgrade to Version 2.x](https://docs.rubocop.org/rubocop-rspec/2.0/upgrade_to_version_2.html) document.
@@ -81,7 +94,7 @@ In your `.rubocop.yml`, you may treat the RSpec cops just like any other
 cop. For example:
 
 ```yaml
-RSpec/FilePath:
+RSpec/SpecFilePathFormat:
   Exclude:
     - spec/my_poorly_named_spec_file.rb
 ```