Adding @extends React.Component support to isReactComponentClass
#269
Conversation
This file contains hidden or 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
added 3 commits
May 24, 2018 15:17
decompil3d
suggested changes
May 24, 2018
src/utils/isReactComponentClass.js
Outdated
| @@ -44,6 +44,26 @@ export default function isReactComponentClass( | |||
| return true; | |||
| } | |||
|
|
|||
| // check for @extends React.Component in docblock | |||
| if (path.parentPath.value && path.parentPath.value) { | |||
There was a problem hiding this comment.
Whoops, should've been (path.parentPath&& path.parentPath.value)
src/utils/isReactComponentClass.js
Outdated
| classDeclaration = path.parentPath.value; | ||
| } | ||
|
|
||
| if (classDeclaration.leadingComments && classDeclaration.leadingComments.length > 0) { |
There was a problem hiding this comment.
Be more defensive and add a check for whether classDeclaration is truthy:
if (classDeclaration && classDeclaration.leadingComments && classDeclaration.leadingComments.length) {(Note that checking the truthiness of length is sufficient rather than doing the explicit > 0)
src/utils/isReactComponentClass.js
Outdated
| } | ||
|
|
||
| if (classDeclaration.leadingComments && classDeclaration.leadingComments.length > 0) { | ||
| var matchedComments = classDeclaration.leadingComments.filter(function(comment) { return comment.value.match(/(@extends React.Component)/) }); |
There was a problem hiding this comment.
A few issues:
- No need to wrap the inside of the
RegExpwith parentheses, since you're not using the capture for anything - The
.character in yourRegExpwill match anything -- you need to escape it to check for a literal period. Also, some people might indent the JSDoc field and value differently, so best to be lenient for that:
/@extends\s+React\.Component/- No need to check through all of the comment lines -- you just need to find one that matches. So you can use
Array.prototype.someto your advantage:
if (classDeclaration.leadingComments.some(function (comment) {
return /@extends\s+React\.Component/.test(comment.value);
})) {
return true;
}There was a problem hiding this comment.
Excellent points, getting all of that integrated.
decompil3d
suggested changes
May 25, 2018
src/utils/isReactComponentClass.js
Outdated
| } | ||
| if (classDeclaration && | ||
| classDeclaration.leadingComments && | ||
| classDeclaration.leadingComments.length && |
There was a problem hiding this comment.
No need for the length check, since some will handle an empty array just fine.
src/utils/isReactComponentClass.js
Outdated
| classDeclaration.leadingComments && | ||
| classDeclaration.leadingComments.length && | ||
| classDeclaration.leadingComments.some(function (comment) { | ||
| return /@extends\s+React\.Component/.test(comment.value); |
decompil3d
approved these changes
May 25, 2018
indexzero
reviewed
May 25, 2018
src/utils/isReactComponentClass.js
Outdated
| if (path.parentPath && path.parentPath.value) { | ||
| var classDeclaration; | ||
| if (Array.isArray(path.parentPath.value)) { | ||
| var matches = path.parentPath.value.filter(function(declaration) { return declaration.type === 'ClassDeclaration' }); |
There was a problem hiding this comment.
Could use .find here fwiw, which would let you make this a one liner
var classDeclaration = Array.isArray(path.parentPath.value)
? path.parentPath.value.find(function(declaration) { return declaration.type === 'ClassDeclaration' });
: path.parentPath.value
indexzero
reviewed
May 25, 2018
src/utils/isReactComponentClass.js
Outdated
| classDeclaration = path.parentPath.value; | ||
| } | ||
|
|
||
| if (classDeclaration && |
There was a problem hiding this comment.
Could tighten this up a bit more:
if (!classDeclaration || !classDeclaration.leadingComments) {
return false;
}
return classDeclaration.leadingComments.some(function (comment) {
return /@extends\s+React\.Component/.test(comment.value);
});There was a problem hiding this comment.
I don't think we could do this.
if (!classDeclaration || !classDeclaration.leadingComments) {
return false;
}
^ This would cause an early return. We still need to check to see if the component directly extends from React.Component.
indexzero
approved these changes
Jun 5, 2018
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Certain react components may have multiple layers of inheritance and don't necessarily have a render function if it has a base class that handles rendering. In that case,
react-docgenwould fail to parse the file.This PR:
@extends React.Componentin the class-level JSDoc block