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

Update to TypeScript 4.1.3 #9476

Merged
merged 9 commits into from Dec 17, 2020
Merged

Update to TypeScript 4.1.3 #9476

merged 9 commits into from Dec 17, 2020

Conversation

jasongrout
Copy link
Contributor

References

What's new: https://devblogs.microsoft.com/typescript/announcing-typescript-4-1/

Code changes

The update required changing two things in the code, plus fixing one actual bug that it caught.

Putting as 3.0, under the assumption that since TS upgrades are breaking, we won't be able to change the TS version until 4.0, so we should really try to have the latest when we ship 3.0. TS 4.1 has been out almost a month now, and brings some nice things.

User-facing changes

Backwards-incompatible changes

@jasongrout jasongrout added this to the 3.0 milestone Dec 15, 2020
@jupyterlab-dev-mode
Copy link

Thanks for making a pull request to JupyterLab!

To try out this branch on binder, follow this link: Binder

@jasongrout
Copy link
Contributor Author

jasongrout commented Dec 15, 2020

It looks like typedoc 0.20 beta now may support the library mode that was keeping us on 0.17.0-3: see TypeStrong/typedoc#1184 (comment). See also TypeStrong/typedoc#1364

It looks like typedoc 0.20 beta may now support the library mode that was keeping us on 0.17.0-3: see TypeStrong/typedoc#1184 (comment). See also TypeStrong/typedoc#1364
There still are some errors, which will hopefully at least partly be solved by judicious exclusion of unnecessary files in the typedoc compilation.
mode: 'library',
// excludeNotExported: true,
// ignoreCompilerErrors: false,
// mode: 'library',
Copy link
Member

Choose a reason for hiding this comment

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

you can delete this line, at least. From what I read I don't think the typedoc guy wants to keep the name "library mode" around in the new version

Copy link
Contributor Author

Choose a reason for hiding this comment

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

you can delete this line, at least. From what I read I don't think the typedoc guy wants to keep the name "library mode" around in the new version

From the issue linked above, I think all three of these options are not in 0.20 anymore. Thanks for the confirmation.

@telamonian
Copy link
Member

thanks for doing the typedoc upgrade. I've been following along with the progress, but I wasn't sure to what extent v0.20 would be a drop-in replacement for library mode from v0.17, so I hadn't gotten around to doing this update myself. Hopefully with all of the good work that @Gerrit0 has been doing there will still be more improvement to come for our API docs

@jasongrout
Copy link
Contributor Author

thanks for doing the typedoc upgrade

Thanks for jumping in here. The upgrade is certainly not done yet. It still is giving lots of errors. I spent a lot of time trying to wrangle the configuration to ignore testutils and other files that were having errors, but was not successful. I was planning to reach out to you tomorrow to see if you could help, since it seems you have more experience with typedoc these days. Do you want to take over getting typedoc to work from here? Or maybe we can merge this and get typedoc working better in another PR?

If we can't get typedoc working globally for all modules at once, it does appear that we can perhaps generate api docs for each package individually. I'm at the point where I'm giving up for now on getting it to work as a single all-encompassing build, but would rather at this point try to patch together individual package docs. If you can get the single all-encompassing build to work, that would be wonderful.

@jasongrout
Copy link
Contributor Author

The upgrade is certainly not done yet.

To be clear, I think the typescript upgrade is done and works great. The typedoc upgrade is not working yet.

@telamonian
Copy link
Member

ooo, I had taken all of your typedoc-related commits to mean that we were already living in the happy space-future, but I guess not yet. Does the current v0.17-based typedoc build still work, or did that fall over when you upgraded typescript?

For now, let's move all of your typedoc commits to a new PR. I can take over the typedoc upgrade, but I definitely can't promise to get it done quickly. From what I've read of TypeStrong/typedoc#1364 the current v0.20 beta should be able to produce a unified api doc for our whole monorepo, but since stuff is still in flight on the typedoc side I can't even really promise that

@jasongrout jasongrout mentioned this pull request Dec 16, 2020
@jasongrout
Copy link
Contributor Author

For now, let's move all of your typedoc commits to a new PR.

Sounds great. I've reverted this PR to just upgrading typescript, and opened #9483 for upgrading typedoc.

@jasongrout
Copy link
Contributor Author

jasongrout commented Dec 17, 2020

Note: @blink1073 requested that we not merge this until the api docs in #9483 are ready to go (so perhaps we should not have split it off to a different PR after all).

@jasongrout
Copy link
Contributor Author

This has an extra lint commit beyond #9483, so merging this to pick up the lint change.

@jasongrout jasongrout merged commit ff3708d into jupyterlab:master Dec 17, 2020
@github-actions github-actions bot added the status:resolved-locked Closed issues are locked after 30 days inactivity. Please open a new issue for related discussion. label Jun 16, 2021
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jun 16, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants