support default props via defaultProps or JSDoc

[brettjurgens]

fixes #37

i've extended the parser to get default values from Component.defaultProps or JSDoc (@default)

i've also added two tests for class & stateless components, let me know if there are any other cases I should get.

here's a screenshot from one of my projects with a, rather exhaustive and contrived, default value list:

[brettjurgens]

some comments

[brettjurgens]

found a typo

[brettjurgens]

i changed the return value of this from a string to this JSDoc interface I created above. allows us to pass more metadata through (in this case, the tags)

[brettjurgens]

i figured we can avoid adding the @default whatever to the description, as it's already represented by the defaultValue

[brettjurgens]

Identifier seems to be used for a variable or undefined. in the future, can probably grab literal values from the source doc but, while nice, seemed outside of the scope of this PR

[brettjurgens]

for an object literal, I'm just grabbing the raw text

[pvasek]

It's perfect. It's really nice feature and thanks to you will be included in next release :)
Thanks a lot!

[pvasek]

I am just thinking what it's the correct version for that new release.
The current version is 1.0.2. There is no breaking change from user perspective but maybe it would make sense to move it to 1.1.0. What do you think about it? Should we go with 1.0.3 or 1.1.0?

[JakeSidSmith]

Just went to have a look at adding this feature and discovered this. Thanks a lot @brettjurgens. 😄

@pvasek I'd release under 1.1.0 as it is a new feature: http://semver.org/

Any idea when you will release?

[pvasek]

@JakeSidSmith I agree, I will create it right now.

[pvasek]

Version v1.1.0 including this fix has just been created.

[brettjurgens]

Awesome! Thanks @pvasek!

[hipstersmoothie]

Does this work still?

[pjweisberg]

It does seem to work, but only under very specific circumstances. For instance, if you had this:

export default class MyClass<MyClassProps> {
   ...etc....
}
export const OtherName = MyClass;

The parser would say that MyClass and OtherName both have the same props, but MyClass has default values and OtherName doesn't.

And if you have export default withStyles(styles)(MyClass) the parser doesn't understand that at all. (It's not really reasonable to expect that last one to work, since it's only parsing one file and thus can't know what withStyles is. It's just too bad because most of my exports look like that.)

[okonet]

I know it's an old code but I'm wondering why is the defaultValue was made an object with value key and not the value itself?