Skip to content

Enable Typedoc excludeNotExported#7121

Merged
etimberg merged 1 commit intochartjs:masterfrom
benmccann:static-fields
Feb 20, 2020
Merged

Enable Typedoc excludeNotExported#7121
etimberg merged 1 commit intochartjs:masterfrom
benmccann:static-fields

Conversation

@benmccann
Copy link
Contributor

@benmccann benmccann commented Feb 19, 2020

This turns on excludeNotExported in typedoc

It also contains a lot of workarounds for TypeStrong/typedoc#393 to make it work

@benmccann
Copy link
Contributor Author

Sigh... This works locally, so I'm not sure why the tests are failing on the VMs

@kurkle
Copy link
Member

kurkle commented Feb 19, 2020

Probably need the exclude that was removed few days ago

@kurkle
Copy link
Member

kurkle commented Feb 19, 2020

Try if that one helps: #7099 (comment)

@kurkle
Copy link
Member

kurkle commented Feb 19, 2020

Ok, no other ideas to try.

@kurkle
Copy link
Member

kurkle commented Feb 19, 2020

Oh, I read somewhere that you need to put the export on separate line in some cases (ie, end of file), when exporting a class as default (and using properties)

@benmccann
Copy link
Contributor Author

Well that would defeat the entire purpose of this PR :-p

@benmccann
Copy link
Contributor Author

This isn't worth spending more time on to me. I'd rather just not use excludeNotExported

@benmccann benmccann closed this Feb 19, 2020
@kurkle
Copy link
Member

kurkle commented Feb 19, 2020

I was supposed to comment here about moving commonjs() lower in the plugins. But it was rollup-plugin-istanbul that is failing here. I think its using babel 6 still.

I think I got it working in #7125 (need to extract the chores from that)

@benmccann
Copy link
Contributor Author

That worked! Thank you so much!!

@benmccann benmccann force-pushed the static-fields branch 2 times, most recently from 8570314 to 503d332 Compare February 19, 2020 17:06
@benmccann benmccann changed the title Export classes directly Enable Typedoc excludeNotExported Feb 19, 2020
@benmccann benmccann force-pushed the static-fields branch 5 times, most recently from 2cfcd62 to bb76fd9 Compare February 19, 2020 21:06
@benmccann benmccann requested review from etimberg and kurkle February 20, 2020 00:46
Copy link
Member

@etimberg etimberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is quite particular about those exports :|

@benmccann
Copy link
Contributor Author

Yeah, hopefully they fix that bug in Typedoc, but I think it's generally better this way anyway

Copy link
Member

@kurkle kurkle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure about exporting the singleton classes. Maybe we should at least add a comment there that its only exported for typedocs?

@benmccann
Copy link
Contributor Author

Ok, I just added some comments, but am just as happy to remove the export if you think that's preferrable

For the Animator, I think that class will mostly just be used internally and probably isn't something users would interact with, so removing the export and removing from the docs would be fine

For the Defaults, there's only one method: set. I just noticed that #7074 removed the _ prefix, so I just went ahead and removed the @private. I don't think the docs show this being used at all though and use alternate ways of setting the default. If you want to consider this class as internal for now as well I'm also happy to remove the export

kurkle
kurkle previously approved these changes Feb 20, 2020
etimberg
etimberg previously approved these changes Feb 20, 2020
@benmccann benmccann dismissed stale reviews from etimberg and kurkle via c9ddcab February 20, 2020 16:25
@etimberg etimberg merged commit e2145e3 into chartjs:master Feb 20, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants