Forbid RBI outside of configurable AllowedPaths #83
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mutecipher
approved these changes
Nov 19, 2021
vinistock
approved these changes
Nov 19, 2021
| nil, | ||
| location: source_range(processed_source.buffer, 1, 0), | ||
| message: message | ||
| ) if allowed_paths.none? { |pattern| File.fnmatch(pattern, processed_source.file_path) } |
Morriar
approved these changes
Nov 19, 2021
lib/rubocop/cop/sorbet/rbi/forbid_rbi_outside_of_allowed_paths.rb
Outdated
Show resolved
Hide resolved
- Default to ["sorbet/rbi/**"] - Add offense on empty AllowedPaths Co-authored-by: Alexandre Terrasa <[email protected]>
RyanBrushett
force-pushed
the
ryanb-rbi-outside-of-sorbet-dir
branch
from
b84b371 to
ddd0e0d
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
#79
ForbidRBIOutsideOfSorbetDirmakes the assumption that RBI files will always be kept undersorbet/rbiwhich is not necessarily the case. See the sorbet docs on RBI files within gems for one example of this. Refactoring the cop a bit allows us to be flexible for these sorts of setups.AllowedPaths will default to
["sorbet/rbi/**"]to be consistent withForbidRBIOutsideOfSorbetDirThis cop makes no attempts to tell a user where to put things, but allows them to tailor the cop to their needs.
I decided that having AllowedPaths set explicitly to an empty list, nil value, or list containing nil meant it was broken.
See tests for a rundown.