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 dependencies, build with Node 16 #144

Merged
merged 13 commits into from
Apr 5, 2022
Merged

Upgrade dependencies, build with Node 16 #144

merged 13 commits into from
Apr 5, 2022

Conversation

adidahiya
Copy link
Contributor

@adidahiya adidahiya commented Apr 4, 2022

Changes proposed

  • Build with Node 16 in CI, using new modern CircleCI images
  • Fix preview comment script (borrowing from chore: fix PR preview comment artifact links blueprint#5208)
  • Upgrade dependencies
    • TypeScript -> v4.6
    • ts-node -> v10.0 (changelog)
    • typedoc -> v0.22 (changelog)
      • decided to postpone this upgrade, dealing with the breaking changes related to loading TS projects took too long... we should probably start using the new workspaces feature in TypeDoc anyway
    • marked -> v4.0 (changelog)
  • Add --tsconfigPath CLI option to documentalist compiler, to make working with the new TypeDoc API easier
  • The NPM plugin is now a bit simpler as a synchronous compilation process (replaced spawn with spawnSync)
  • TypeDoc's reflection flag isExported will be removed in a future version, and TypeDoc will only document exported members. Therefore, we're removing he includeNonExportedMembers option from the documentalist TS plugin.
    • N.B. we weren't using this in Blueprint anyway.

TypeDoc breaking changes that had to will have to be addressed in upgrading from v0.19 -> v0.22:

  • TypeDoc's handling of accessor documentation changed. It no longer includes combined JSDoc content for get+set accessors in the documentation field; the content is split into getDocumentation and setDocumentation fields (as it was previously). See updated test snapshots for the details.
  • ignoreCompilerErrors is being removed, and it seems like we were relying on this to get TS docs built. We'll have to implement a workaround, possibly using the snippet from Support for ignoreCompilerErrors TypeStrong/typedoc#1403 (comment)

@blueprint-bot
Copy link

Add changelog

Previews: documentation

@adidahiya adidahiya merged commit c871bd9 into develop Apr 5, 2022
@adidahiya adidahiya deleted the ad/node-16 branch April 5, 2022 14:24
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.

2 participants