Skip to content

Commit 9024373

Browse files
Update dependency typedoc to ^0.28.0 (#1195)
This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [typedoc](https://typedoc.org) ([source](https://redirect.github.com/TypeStrong/TypeDoc)) | [`^0.27.1` -> `^0.28.0`](https://renovatebot.com/diffs/npm/typedoc/0.27.9/0.28.0) | [![age](https://developer.mend.io/api/mc/badges/age/npm/typedoc/0.28.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/typedoc/0.28.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/typedoc/0.27.9/0.28.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/typedoc/0.27.9/0.28.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>TypeStrong/TypeDoc (typedoc)</summary> ### [`v0.28.0`](https://redirect.github.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0280-2025-03-15) [Compare Source](https://redirect.github.com/TypeStrong/TypeDoc/compare/v0.27.9...v0.28.0) ##### Breaking Changes - TypeDoc now expects all input globs paths to be specified with `/` path separators, [#&#8203;2825](https://redirect.github.com/TypeStrong/TypeDoc/issues/2825). - TypeDoc's `--entryPointStrategy merge` mode now requires JSON from at least version 0.28.0. - Removed `jp` translations from `lang`, to migrate switch to `ja`. - File name references in `intentionallyNotExported` now use a package name/package relative path instead of an absolute path for matching. - The `source-order` sort ordering now considers package names / package relative paths instead of using the absolute paths to a file. - TypeDoc will only check for a project README file next to the discovered `package.json` file if `--readme` is not set this change improves handling of monorepo setups where some packages have readme files and others do not, [#&#8203;2875](https://redirect.github.com/TypeStrong/TypeDoc/issues/2875). - Function-like variable exports will now only be automatically converted as function types if they are initialized with a function expression. TypeDoc can be instructed to convert them as functions with the `@function` tag, [#&#8203;2881](https://redirect.github.com/TypeStrong/TypeDoc/issues/2881). - Object literal type alias types will now be converted in a way which causes them to be rendered more similarly to how interfaces are rendered, [#&#8203;2817](https://redirect.github.com/TypeStrong/TypeDoc/issues/2817). ##### API Breaking Changes - `ProjectReflection.getReflectionFromSymbol` and `ProjectReflection.getSymbolFromReflection` have been moved to `Context` - `Path` and `PathArray` parameter types now always contain normalized paths. - Introduced a `Router` which is used for URL creation. `Reflection.url`, `Reflection.anchor`, and `Reflection.hasOwnDocument` have been removed. - `Deserializer.reviveProject(s)` no longer accepts an option to add project documents. - `Deserializer.reviveProjects` now requires an `alwaysCreateEntryPointModule` option. - `Comment.serializeDisplayParts` no longer requires a serializer argument. - `ReflectionSymbolId.fileName` is now optional, TypeDoc now stores a combination of a package name and package relative path instead. The `fileName` property will be present when initially created, but is not serialized. - Removed `DeclarationReflection.relevanceBoost` attribute which was added for plugins, but never used. - `i18n` proxy is no longer passed to many functions, instead, reference `i18n` exported from the module directly. - `ReflectionKind.singularString` and `ReflectionKind.pluralString` now returns translated strings. The methods on `Internationalization` to do this previously have been removed. - The HTML output structure for the search box has changed to support the new modal. - `DefaultThemeRenderContext`'s `typeDeclaration` and `typeDetailsIfUseful` methods now require both a reflection and a type in order to support `@expandType` ##### Features - Add support for TypeScript 5.8.x - The search modal in the HTML output has been rewritten to provide better mobile support - Added a `--router` option which can be used to modify TypeDoc's output folder structure. This can be extended with plugins, [#&#8203;2111](https://redirect.github.com/TypeStrong/TypeDoc/issues/2111). - Introduced the `@primaryExport` modifier tag to provide more fine grained control over export conversion order, [#&#8203;2856](https://redirect.github.com/TypeStrong/TypeDoc/issues/2856) - Introduced `packagesRequiringDocumentation` option for `validation.notDocumented`, TypeDoc will expect comments to be present for symbols in the specified packages. - TypeDoc now exports a `typedoc/browser` entrypoint for parsing and using serialized JSON files, [#&#8203;2528](https://redirect.github.com/TypeStrong/TypeDoc/issues/2528). - Type `packageOptions` as `Partial<TypeDocOptions>`, [#&#8203;2878](https://redirect.github.com/TypeStrong/TypeDoc/issues/2878). - TypeDoc will now warn if an option which should only be set at the root level is set in `packageOptions`, [#&#8203;2878](https://redirect.github.com/TypeStrong/TypeDoc/issues/2878). - Introduced `@function` tag to force TypeDoc to convert variable declarations with a type annotation as functions, [#&#8203;2881](https://redirect.github.com/TypeStrong/TypeDoc/issues/2881). - Exposed a `TypeDoc` global object in the HTML theme which can be used to prevent TypeDoc from using `localStorage`, [#&#8203;2872](https://redirect.github.com/TypeStrong/TypeDoc/issues/2872). - Introduced `@preventInline` and `@inlineType` tags for further control extending the `@inline` tag, [#&#8203;2862](https://redirect.github.com/TypeStrong/TypeDoc/issues/2862). - Introduced `@preventExpand` and `@expandType` tags for further control extending the `@expand` tag, [#&#8203;2862](https://redirect.github.com/TypeStrong/TypeDoc/issues/2862). - API: Introduced `DefaultThemeRenderContext.reflectionIcon` for more granular control over displayed reflection icons. ##### Bug Fixes - TypeDoc will now only create references for symbols re-exported from modules. - Variable-functions will now prefer placing the comment on the signature if there is only one signature present, [#&#8203;2824](https://redirect.github.com/TypeStrong/TypeDoc/issues/2824). - User filter settings will no longer sometimes cause the search to have fewer visible results than expected. - Fixed handling of expando functions which were also merged with a namespace, [#&#8203;2876](https://redirect.github.com/TypeStrong/TypeDoc/issues/2876). - Fixed rendering of function types within arrays and union types, [#&#8203;2892](https://redirect.github.com/TypeStrong/TypeDoc/issues/2892). - Fixed an issue where if the theme JS didn't load, the page wouldn't be shown, [#&#8203;2894](https://redirect.github.com/TypeStrong/TypeDoc/issues/2894). ##### Thanks! - [@&#8203;crimx](https://redirect.github.com/crimx) - [@&#8203;jsmith2-coveo](https://redirect.github.com/jsmith2-coveo) - [@&#8203;phoneticallySAARTHaK](https://redirect.github.com/phoneticallySAARTHaK) - [@&#8203;XeroAlpha](https://redirect.github.com/XeroAlpha) </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR was generated by [Mend Renovate](https://mend.io/renovate/). View the [repository job log](https://developer.mend.io/github/line/line-bot-sdk-nodejs). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzOS4yMDAuMCIsInVwZGF0ZWRJblZlciI6IjM5LjIwMC4wIiwidGFyZ2V0QnJhbmNoIjoibWFzdGVyIiwibGFiZWxzIjpbImRlcGVuZGVuY3kgdXBncmFkZSJdfQ==--> --------- Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: habara keigo <[email protected]>
1 parent af4a889 commit 9024373

File tree

2 files changed

+1465
-1409
lines changed

2 files changed

+1465
-1409
lines changed

0 commit comments

Comments
 (0)