Bump typedoc from 0.25.4 to 0.27.4 and add better CI integration

[dependabot]

Bumps typedoc from 0.25.4 to 0.27.2.

Release notes

Sourced from typedoc's releases.

v0.27.2

Bug Fixes

• Fix crash with TypeScript 5.5.x, #2789.

v0.27.1

Bug Fixes

• Include classes which inherit from another package in class hierarchy in packages mode, #2467.
• Fixed handling of @categoryDescription and @groupDescription on module pages, #2787.
• Fixed automatic discovery of entry points in packages mode.
• Reverted accidental style change for hierarchy page introduced in 0.27.0
• The hierarchy Expand/Collapse link will now only appear if the hierarchies are different.

v0.27.0 (2024-11-27)

Breaking Changes

• Convert to ESM to enable easier use of ESM-only dependencies.
• Drop support for TypeScript <5.0, no longer supported by DefinitelyTyped
• Relaxed requirements for file names and generated url fragments. This may result in a different file name structure, #2714.
• Anchors to document headings and reflections within a HTML generated pages have changed. They can be partially restored to the previous format by setting --sluggerConfiguration.lowercase false. This change was made to more closely match the default behavior of GitHub's markdown rendering and VSCode's autocomplete when creating a relative link to an external markdown file.
• Removed the hideParameterTypesInTitle option, this was originally added as a workaround for many signatures overflowing the available horizontal space in rendered pages. TypeDoc now has logic to wrap types/signatures smartly, so this option is no longer necessary.
• Changed the default kindSortOrder to put references last.
• Changed the default sort order to use alphabetical-ignoring-documents instead of alphabetical.
• Changed default of suppressCommentWarningsInDeclarationFiles to true
• API: Constructor signatures now use the parent class name as their name (e.g. X, not new X)
• API: @group, @category, @groupDescription and @categoryDescription will no longer be removed from the reflections they are present on. They are skipped during rendering with the notRenderedTags option.

Features

• Add support for TypeScript 5.7
• TypeDoc will now discover entry points from package.json exports if they are not provided manually, #1937.
• Relative links to markdown files may now include #anchor links to

... (truncated)

Changelog

Sourced from typedoc's changelog.

v0.27.2 (2024-11-29)

Bug Fixes

• Fix crash with TypeScript 5.5.x, #2789.

v0.27.1 (2024-11-28)

Bug Fixes

• Include classes which inherit from another package in class hierarchy in packages mode, #2467.
• Fixed handling of @categoryDescription and @groupDescription on module pages, #2787.
• Fixed automatic discovery of entry points in packages mode.
• Reverted accidental style change for hierarchy page introduced in 0.27.0
• The hierarchy Expand/Collapse link will now only appear if the hierarchies are different.

v0.27.0 (2024-11-27)

Breaking Changes

• Convert to ESM to enable easier use of ESM-only dependencies.
• Drop support for TypeScript <5.0, no longer supported by DefinitelyTyped
• Relaxed requirements for file names and generated url fragments. This may result in a different file name structure, #2714.
• Anchors to document headings and reflections within a HTML generated pages have changed. They can be partially restored to the previous format by setting --sluggerConfiguration.lowercase false. This change was made to more closely match the default behavior of GitHub's markdown rendering and VSCode's autocomplete when creating a relative link to an external markdown file.
• Removed the hideParameterTypesInTitle option, this was originally added as a workaround for many signatures overflowing the available horizontal space in rendered pages. TypeDoc now has logic to wrap types/signatures smartly, so this option is no longer necessary.
• Changed the default kindSortOrder to put references last.
• Changed the default sort order to use alphabetical-ignoring-documents instead of alphabetical.
• Changed default of suppressCommentWarningsInDeclarationFiles to true
• API: Constructor signatures now use the parent class name as their name (e.g. X, not new X)
• API: @group, @category, @groupDescription and @categoryDescription will no longer be removed from the reflections they are present on. They are skipped during rendering with the notRenderedTags option.

Features

• Add support for TypeScript 5.7
• TypeDoc will now discover entry points from package.json exports if they are not provided manually, #1937.
• Relative links to markdown files may now include #anchor links to

... (truncated)

Commits

• 23e2c99 Update changelog for release
• b6b9b01 Bump version to 0.27.2
• ea631e0 Fix external.d.ts unit test
• 7d38048 Fix crash with TS 5.5.x
• c3842c1 Minor improvements to API docs
• 663ce54 Add maintenance status to site
• 193b02e Simplify plugin/theme list generation on site
• 9a520d7 Simpler handling of changelog in site
• 6142a5e Update changelog for release
• 1ce36a4 Bump version to 0.27.1
• Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

---

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

• @dependabot rebase will rebase this PR
• @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
• @dependabot merge will merge this PR after your CI passes on it
• @dependabot squash and merge will squash and merge this PR after your CI passes on it
• @dependabot cancel merge will cancel a previously requested merge and block automerging
• @dependabot reopen will reopen this PR if it is closed
• @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
• @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
• @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
• @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
• @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
universalviewer	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Dec 10, 2024 5:20pm

[demiankatz]

This PR breaks documentation building. We'll need to figure out why and fix compatibility.

dkatz@dkatz-VirtualBox:~/universalviewer$ npm run docs

> [email protected] docs
> typedoc --plugin typedoc-plugin-missing-exports

[error] The plugin typedoc-plugin-missing-exports could not be loaded
[error] Error [ERR_REQUIRE_ESM]: require() of ES Module /home/dkatz/universalviewer/node_modules/typedoc/dist/index.js from /home/dkatz/universalviewer/node_modules/typedoc-plugin-missing-exports/index.js not supported.
Instead change the require of /home/dkatz/universalviewer/node_modules/typedoc/dist/index.js in /home/dkatz/universalviewer/node_modules/typedoc-plugin-missing-exports/index.js to a dynamic import() which is available in all CommonJS modules.
    at Object.<anonymous> (/home/dkatz/universalviewer/node_modules/typedoc-plugin-missing-exports/index.js:5:19)
[error] Found 2 errors and 0 warnings

[demiankatz]

I was able to get this to build by updating the plugin dependency to a compatible version. I then rebuilt the docs, which changed a large number of files. At a glance, the documentation still looks correct, but I'm not sure what needs to be validated in detail. I'd appreciate more input from others before merging this.

[dependabot]

A newer version of typedoc exists, but since this PR has been edited by someone other than Dependabot I haven't updated it. You'll get a PR for the updated version as normal once this PR is merged.

[demiankatz]

I've made a few further adjustments here:

1.) I've added a GitHub Actions rule which automatically builds the documentation; this will keep things up to date for us automatically.

2.) Part of the GitHub Actions rule includes the regeneration of the docs/CNAME file (which I assume is needed for our deployment workflow); this gets destroyed every time typedoc runs otherwise.

3.) I discovered that every time you run typedoc, it links to the most recent commit ID on GitHub in every file... this means that literally every time you commit anything, all of the documentation changes. I changed this to instead pin links to the dev branch, so users will see the most recent code. This has some downsides, but I think it's preferable to adding hundreds of file changes to every pull request. Since documentation updates will be automatic going forward, I think it makes sense for the published documentation to point to the bleeding edge code. I'm open to discussing other options, though!