Skip to content

Conversation

@dependabot
Copy link
Contributor

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

Bumps typedoc from 0.22.4 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!

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!

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)

Bumps [typedoc](https://github.com/TypeStrong/TypeDoc) from 0.22.4 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.22.4...v0.22.5)

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

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot dependabot bot added the dependencies Pull requests that update a dependency file label Oct 4, 2021
Copy link

@autoapproval autoapproval bot left a comment

Choose a reason for hiding this comment

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

Approved 👍

@google-cla google-cla bot added the cla: yes This human has signed the Contributor License Agreement. label Oct 4, 2021
@autoapproval autoapproval bot added the merge label Oct 4, 2021
@codecov
Copy link

codecov bot commented Oct 4, 2021

Codecov Report

Merging #411 (3d7992d) into main (ba82120) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##              main      #411   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            1         1           
  Lines          123       123           
  Branches        25        25           
=========================================
  Hits           123       123           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ba82120...3d7992d. Read the comment docs.

@probot-auto-merge probot-auto-merge bot merged commit 8fc999a into main Oct 4, 2021
@probot-auto-merge probot-auto-merge bot deleted the dependabot/npm_and_yarn/typedoc-0.22.5 branch October 4, 2021 06:16
github-actions bot pushed a commit that referenced this pull request Oct 4, 2021
Bumps [typedoc](https://github.com/TypeStrong/TypeDoc) from 0.22.4 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.22.4...v0.22.5)

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

Signed-off-by: dependabot[bot] <[email protected]>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> 8fc999a
github-actions bot pushed a commit that referenced this pull request Oct 6, 2021
### [1.12.5](v1.12.4...v1.12.5) (2021-10-06)

### Miscellaneous Chores

* Created local 'SECURITY.md' from remote 'SECURITY.md' ([#408](#408)) ([22a56d7](22a56d7))
* Synced local '.eslintrc.json' with remote 'sync-files/js/.eslintrc.json' ([#403](#403)) ([6a1431f](6a1431f))
* Synced local '.github/' with remote 'sync-files/js/.github/' ([#406](#406)) ([ab85e07](ab85e07))
* Synced local '.github/' with remote 'sync-files/js/.github/' ([#407](#407)) ([a65e667](a65e667))

### Build System

* **deps-dev:** bump chromedriver from 93.0.1 to 94.0.0 ([#402](#402)) ([696068b](696068b))
* **deps-dev:** bump core-js from 3.18.1 to 3.18.2 ([#413](#413)) ([e60caee](e60caee))
* **deps-dev:** bump eslint-plugin-jest from 24.4.2 to 24.4.3 ([#404](#404)) ([9efa2f7](9efa2f7))
* **deps-dev:** bump eslint-plugin-jest from 24.4.3 to 24.5.0 ([#405](#405)) ([0221256](0221256))
* **deps-dev:** bump eslint-plugin-jest from 24.5.0 to 24.5.2 ([#410](#410)) ([da66905](da66905))
* **deps-dev:** bump rollup from 2.57.0 to 2.58.0 ([#412](#412)) ([4f54ff7](4f54ff7))
* **deps-dev:** bump selenium-webdriver from 4.0.0-rc-1 to 4.0.0-rc-2 ([#409](#409)) ([ba82120](ba82120))
* **deps-dev:** bump typedoc from 0.22.4 to 0.22.5 ([#411](#411)) ([8fc999a](8fc999a))
@github-actions
Copy link

github-actions bot commented Oct 6, 2021

🎉 This PR is included in version 1.12.5 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cla: yes This human has signed the Contributor License Agreement. dependencies Pull requests that update a dependency file merge released

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants