Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Upgrade typedoc and TypeScript for TypeScript 3.2 support #81

Merged
merged 3 commits into from
Feb 13, 2019

Conversation

styu
Copy link
Contributor

@styu styu commented Feb 11, 2019

Release notes

Had to change the target as suggested by typedoc to es2015, not sure how that will affect downstream consumers

@styu styu requested a review from adidahiya February 11, 2019 20:24
@styu styu changed the title Upgrade typedoc to 0.14.x for TypeScript 3.2 support [wip] Upgrade typedoc to 0.14.x for TypeScript 3.2 support Feb 11, 2019
@styu styu changed the title [wip] Upgrade typedoc to 0.14.x for TypeScript 3.2 support Upgrade typedoc and TypeScript for TypeScript 3.2 support Feb 12, 2019
@blueprint-bot
Copy link

Upgrade typescript as well

Preview: docs

@blueprint-bot
Copy link

Update test snapshots

Preview: docs

@@ -20,7 +20,7 @@
"outDir": "dist/",
"sourceMap": false,
"strictNullChecks": true,
"target": "es5"
"target": "es2015"
Copy link
Contributor

Choose a reason for hiding this comment

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

I doubt this will work... AFAIK some es2015 syntax features emitted by tsc are still unsupported in the versions of Node where documentalist runs. I'll double check that this is still the case... if it is, I think another transpilation step is required (and we might ask them to revert the break).

for reference, this is the reasoning they provided for the change:

I changed the tsconfig target from es5 to es2015. This change was made in order to make the ReflectionFlags class act as a class. Since the lib property already includes es2015 libraries, and we only test on node 6+, I believe this is a justifiable change.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ok, let me know how/if I should test that or what I can do

Copy link
Contributor

Choose a reason for hiding this comment

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

actually, it looks like all non-deprecated versions of Node 6.5+ support the ES features used here. neat! we should probably make a mention in the "engines" block of package.json, but otherwise g2g

Copy link
Contributor

Choose a reason for hiding this comment

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

the exceptions I was thinking of all had to do with the ES module syntax, which is not widely supported in Node yet

Copy link
Contributor

Choose a reason for hiding this comment

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

actually this ended up causing a blueprint bug. filed #84, i'm looking into fixing it

@adidahiya adidahiya merged commit fa68605 into master Feb 13, 2019
@adidahiya adidahiya deleted the styu/upgrade-typedoc branch February 13, 2019 01:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants