Update looksLikeFlowFileAnnotation regex to match only @flow
#233
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
The `looksLikeFlowFileAnnotation` regex was too broad and would catch jsdoc comments like `@fixable` and `@function`, causing eslint errors in projects that don't use flow (in my case). I updated the regex to only check for anything beginning with `@flo`. Is there any reason not to full on match `@flow`? I'm not familiar with how flow works. This should fix gajus#165.
|
can we get this merged? |
|
I am reluctant to, as I've never run into this situation working on large projects. I'd rather recommend disabling the rule in effected files. Alternatively, regex could be provided as an option. |
|
Thankfully this rule was (temporarily) disabled from create react app, so it might make it easier to ignore this. I ran into this immediately since I had JSdocs that included |
|
👍 for merging this |
|
Thanks! 😃 |
|
@danharper Dan has veto rights here. :-) |
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.
The
looksLikeFlowFileAnnotationregex was too broad and would catchjsdoc comments like
@fixableand@function, causing eslint errorsin projects that don't use flow (in my case).
I updated the regex to only check for anything beginning with
@flo. Is there any reason not to full on match@flow? I'm notfamiliar with how flow works.
This should fix #165.