Skip to content
This repository has been archived by the owner on Oct 6, 2021. It is now read-only.

Bump typedoc from 0.21.9 to 0.22.5 #20

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Bump typedoc from 0.21.9 to 0.22.5 #20

wants to merge 1 commit into from

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Oct 4, 2021

Bumps typedoc from 0.21.9 to 0.22.5.

Release notes

Sourced from typedoc's releases.

v0.22.5

Features

  • TypeDoc will now recognize @param comments for destructured parameters and rename __namedParameters to the name specified in the @param comment if the number of @param comments match the number of parameters, resolves #1703.
  • The intentionallyNotExported option may now include file names/paths to limit its scope, for example, the following will suppress warnings from Foo in src/foo.ts not being exported, but will not suppress warnings if another Foo declared in src/utils/foo.ts is not exported. 
    {
    "intentionallyNotExported": ["src/foo.ts:Foo"]
}
  • The --emit option can now be used to more finely control what TypeDoc will emit.
    Value Behavior
    both Emit both documentation and JS.
    docs Emit documentation, but not JS (default).
    none Emit nothing, just convert and run validation.
    true Alias for both, for backwards compatibility. Will be removed in 0.23.
    false Alias for docs, for backwards compatibility. Will be removed in 0.23.

Bug Fixes

  • TypeDoc will now only create one highlighter for rendering code, saving ~200-500ms for rendering time.
  • For compatibility with JSDoc, TypeDoc will now strip <caption> elements from @example tags, resolves #1679.
  • TypeScript's emitDeclarationOnly compiler option is now supported, resolves #1716.
  • Fixed discovery of tsconfig.json when the provided path ends in .json, resolves #1712.
  • Fixed a crash when converting the globalThis namespace, could only be caused by a plugin.

Thanks!

v0.22.4

Features

  • Flag option types like validation can now be set to true/false to enable/disable all flags within them.
  • Source code links now work with Bitbucket repositories, resolves #1615.
  • Added githubPages option (default: true), which will create a .nojekyll page in the generated output, resolves #1680.
  • MarkdownEvent is now exported, resolves #1696.

Bug Fixes

  • Fixed the hamburger menu not being visible on mobile devices, fixes #1699.

... (truncated)

Changelog

Sourced from typedoc's changelog.

v0.22.5 (2021-09-02)

Features

  • TypeDoc will now recognize @param comments for destructured parameters and rename __namedParameters to the name specified in the @param comment if the number of @param comments match the number of parameters, resolves #1703.
  • The intentionallyNotExported option may now include file names/paths to limit its scope, for example, the following will suppress warnings from Foo in src/foo.ts not being exported, but will not suppress warnings if another Foo declared in src/utils/foo.ts is not exported. 
    {
    "intentionallyNotExported": ["src/foo.ts:Foo"]
}
  • The --emit option can now be used to more finely control what TypeDoc will emit.
    Value Behavior
    both Emit both documentation and JS.
    docs Emit documentation, but not JS (default).
    none Emit nothing, just convert and run validation.
    true Alias for both, for backwards compatibility. Will be removed in 0.23.
    false Alias for docs, for backwards compatibility. Will be removed in 0.23.

Bug Fixes

  • TypeDoc will now only create one highlighter for rendering code, saving ~200-500ms for rendering time.
  • For compatibility with JSDoc, TypeDoc will now strip <caption> elements from @example tags, resolves #1679.
  • TypeScript's emitDeclarationOnly compiler option is now supported, resolves #1716.
  • Fixed discovery of tsconfig.json when the provided path ends in .json, resolves #1712.
  • Fixed a crash when converting the globalThis namespace, could only be caused by a plugin.

Thanks!

v0.22.4 (2021-08-18)

Features

  • Flag option types like validation can now be set to true/false to enable/disable all flags within them.
  • Source code links now work with Bitbucket repositories, resolves #1615.
  • Added githubPages option (default: true), which will create a .nojekyll page in the generated output, resolves #1680.
  • MarkdownEvent is now exported, resolves #1696.

Bug Fixes

  • Fixed the hamburger menu not being visible on mobile devices, fixes #1699.

... (truncated)

Commits
  • 33df459 Update changelog for release
  • 5613a41 Bump version to 0.22.5
  • 218e0ce Update dependencies
  • 2062288 Fix discovery of tsconfig.json when provided folder ends with .json
  • 455b36b Add support for disabling emit
  • 042680c Add support for filenames in intentionallyNotExported
  • 9f9bc38 Rebuild specs
  • f3ff7cf Fix support for emitDeclarationOnly
  • ea0b3d7 Fix crash when converting globalThis namespace
  • 2a2f504 Update changelog for recently merged PRs
  • Additional commits viewable in compare view

Dependabot compatibility score

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 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)

@dependabot
Bump typedoc from 0.21.9 to 0.22.5
f64baa8 
Bumps [typedoc](https://github.com/TypeStrong/TypeDoc) from 0.21.9 to 0.22.5.
- [Release notes](https://github.com/TypeStrong/TypeDoc/releases)
- [Changelog](https://github.com/TypeStrong/typedoc/blob/master/CHANGELOG.md)
- [Commits](TypeStrong/typedoc@v0.21.9...v0.22.5)

---
updated-dependencies:
- dependency-name: typedoc
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot dependabot bot added the dependencies Pull requests that update a dependency file label Oct 4, 2021
@dependabot dependabot bot mentioned this pull request Oct 4, 2021
Closed
@vercel
Copy link

vercel bot commented Oct 4, 2021 •
edited
Loading

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployments, click below or on the icon next to each commit.

senutila-api-docs – ./

🔍 Inspect: https://vercel.com/edaz/senutila-api-docs/8Z55L6meCEuahkRN3wAGqcErHqx5
✅ Preview: Failed

senutila-docs – ./docs

🔍 Inspect: https://vercel.com/edaz/senutila-docs/4JNwjEunVfHDSKtbYdCLuvfSx8te
✅ Preview: https://senutila-docs-git-dependabot-npmandyarntypedoc-0225-edaz.vercel.app

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers
No reviews
Assignees
No one assigned
Labels
dependencies Pull requests that update a dependency file
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
0 participants