From 6f58a12c1812573d4d8532be65c48320e68145f8 Mon Sep 17 00:00:00 2001
From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com>
Date: Mon, 11 Sep 2023 15:49:32 +0000
Subject: [PATCH] chore(deps): Bump typedoc from 0.25.0 to 0.25.1 (#256)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Bumps [typedoc](https://github.com/TypeStrong/TypeDoc) from 0.25.0 to 0.25.1.
Release notes
Sourced from typedoc's releases.
v0.25.1
Features
- Added
stripYamlFrontmatter config option to remove YAML frontmatter from README.md, #2381.
- Added
--excludeCategories config option to remove reflections present in any excluded category, #1407.
- If no tsconfig.json file is present, TypeDoc will now attempt to compile without setting any compiler options, #2304.
- Navigation is now written to a JS file and built dynamically, which significantly decreases document generation time
with large projects and also provides large space benefits. Themes may now override
DefaultTheme.buildNavigation
to customize the displayed navigation tree, #2287.
Note: This change renders navigation.fullTree obsolete. If you set it, TypeDoc will warn that it is being ignored.
It will be removed in v0.26.
- The search index is now compressed before writing, which reduces most search index sizes by ~5-10x.
- TypeDoc will now attempt to cache icons when
DefaultThemeRenderContext.icons is overwritten by a custom theme.
Note: To perform this optimization, TypeDoc relies on DefaultThemeRenderContext.iconCache being rendered within
each page. TypeDoc does it in the defaultLayout template.
- Cache URL derivation during generation, #2386.
Bug Fixes
@property now works as expected if used to override a method's documentation.- Deprecated functions/methods are now correctly rendered with a struck-out name.
--watch mode works again, #2378.- Improved support for optional names within JSDoc types, #2384.
- Fixed duplicate rendering of reflection flags on signature parameters, #2385.
- TypeDoc now handles the
intrinsic keyword if TS intrinsic types are included in documentation.
--exclude is now respected when expanding globs in entry points, #2376.
Thanks!
Changelog
Sourced from typedoc's changelog.
v0.25.1 (2023-09-04)
Features
- Added
stripYamlFrontmatter config option to remove YAML frontmatter from README.md, #2381.
- Added
--excludeCategories config option to remove reflections present in any excluded category, #1407.
- If no tsconfig.json file is present, TypeDoc will now attempt to compile without setting any compiler options, #2304.
- Navigation is now written to a JS file and built dynamically, which significantly decreases document generation time
with large projects and also provides large space benefits. Themes may now override
DefaultTheme.buildNavigation
to customize the displayed navigation tree, #2287.
Note: This change renders navigation.fullTree obsolete. If you set it, TypeDoc will warn that it is being ignored.
It will be removed in v0.26.
- The search index is now compressed before writing, which reduces most search index sizes by ~5-10x.
- TypeDoc will now attempt to cache icons when
DefaultThemeRenderContext.icons is overwritten by a custom theme.
Note: To perform this optimization, TypeDoc relies on DefaultThemeRenderContext.iconCache being rendered within
each page. TypeDoc does it in the defaultLayout template.
- Cache URL derivation during generation, #2386.
Bug Fixes
@property now works as expected if used to override a method's documentation.- Deprecated functions/methods are now correctly rendered with a struck-out name.
--watch mode works again, #2378.- Improved support for optional names within JSDoc types, #2384.
- Fixed duplicate rendering of reflection flags on signature parameters, #2385.
- TypeDoc now handles the
intrinsic keyword if TS intrinsic types are included in documentation.
--exclude is now respected when expanding globs in entry points, #2376.
Thanks!
Commits
5e4c79d Update changelog for release265bf49 Bump version to 0.25.10985616 Handle projects without tsconfig filesbcf3e04 Add excludeCategories option653b281 Respect --exclude when expanding globs in entry pointsa6823cf Cache URL derivation during generation1f88a1f Compress search index tood68ca2a Update changelogdc4a16d feat: stripYamlFrontmatter option (#2387)67ee6ac Dynamically load navigation- Additional commits viewable in compare view
[](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)
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-automerge-start)
[//]: # (dependabot-automerge-end)
---
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 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)
---
package-lock.json | 12 ++++++------
package.json | 2 +-
2 files changed, 7 insertions(+), 7 deletions(-)
diff --git a/package-lock.json b/package-lock.json
index a7f79c6..5f06241 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -7443,9 +7443,9 @@
"dev": true
},
"shiki": {
- "version": "0.14.3",
- "resolved": "https://registry.npmjs.org/shiki/-/shiki-0.14.3.tgz",
- "integrity": "sha512-U3S/a+b0KS+UkTyMjoNojvTgrBHjgp7L6ovhFVZsXmBGnVdQ4K4U9oK0z63w538S91ATngv1vXigHCSWOwnr+g==",
+ "version": "0.14.4",
+ "resolved": "https://registry.npmjs.org/shiki/-/shiki-0.14.4.tgz",
+ "integrity": "sha512-IXCRip2IQzKwxArNNq1S+On4KPML3Yyn8Zzs/xRgcgOWIr8ntIK3IKzjFPfjy/7kt9ZMjc+FItfqHRBg8b6tNQ==",
"dev": true,
"requires": {
"ansi-sequence-parser": "^1.1.0",
@@ -7956,9 +7956,9 @@
"dev": true
},
"typedoc": {
- "version": "0.25.0",
- "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.25.0.tgz",
- "integrity": "sha512-FvCYWhO1n5jACE0C32qg6b3dSfQ8f2VzExnnRboowHtqUD6ARzM2r8YJeZFYXhcm2hI4C2oCRDgNPk/yaQUN9g==",
+ "version": "0.25.1",
+ "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.25.1.tgz",
+ "integrity": "sha512-c2ye3YUtGIadxN2O6YwPEXgrZcvhlZ6HlhWZ8jQRNzwLPn2ylhdGqdR8HbyDRyALP8J6lmSANILCkkIdNPFxqA==",
"dev": true,
"requires": {
"lunr": "^2.3.9",
diff --git a/package.json b/package.json
index 9bb0d6e..699be20 100644
--- a/package.json
+++ b/package.json
@@ -61,7 +61,7 @@
"ts-jest": "^28.0.8",
"ts-node": "^10.9.1",
"tslint": "^6.1.3",
- "typedoc": "^0.25.0",
+ "typedoc": "^0.25.1",
"typescript": "^4.8.4"
},
"prettier": "@relaycorp/shared-config/.prettierrc.json",