You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
#215915cf592 Thanks @ingvaldlorentzen! - Fixed already-published version detection with npm 12, which always wraps successful npm info --json output in an array. The unwrapped output made changeset publish treat every package as unpublished and fail attempting to republish existing versions.
#188996ca062 Thanks @mixelburg! - Error on unsupported flags for individual CLI commands and print the matching command usage to make mistakes easier to spot.
#187342943b7 Thanks @mixelburg! - Respond to --help on all subcommands. Previously, --help was only handled when it was the sole argument; passing it alongside a subcommand (e.g. changeset version --help) would silently execute the command instead. Now --help always exits early and prints per-command usage when a known subcommand is provided, or the general help text otherwise.
Patch Changes
d2121dc Thanks @Andarist! - Fix npm auth for path-based registries during publish by preserving configured registry URLs instead of normalizing them.
#1888036fdd4 Thanks @mixelburg! - Fix several changeset version issues with workspace protocol dependencies. Valid explicit workspace: ranges and aliases are no longer rewritten unnecessarily, and workspace path references are handled correctly during versioning.
#19035c4731f Thanks @Andarist! - Gracefully handle stale npm info data leading to duplicate publish attempts.
#1867f61e716 Thanks @Andarist! - Improved detection for published state of prerelease-only packages without latest dist-tag on GitHub Packages registry.
The add command now supports a --since flag that allows you to specify which branch, tag, or git ref to use when detecting changed packages. This is useful for gitflow workflows where you have multiple target branches and the baseBranch config option doesn't cover all use cases.
Example: changeset add --since=develop
If not provided, the command falls back to the baseBranch value in your .changeset/config.json.
#18452b4a66a Thanks @Andarist! - Delegate OTP prompting to the package manager instead of handling it in-process. This allows Changesets to use the package manager's native web auth support.
#1774667fe5a Thanks @bluwy! - Support importing custom commit option ES module. Previously, it used require() which only worked for CJS modules, however now it uses import() which supports both CJS and ES modules.
#183973b1809 Thanks @leochiu-a! - Add a --message (-m) flag to changeset add (and default changeset) so the changeset summary can be provided from the command line. When --message is present, the summary prompt is skipped while the final confirmation step is kept.
#18060e8e01e Thanks @luisadame! - Changeset CLI can now be run from the nested directories in the project, where the .changeset directory has to be found in one of the parent directories
Patch Changes
#18499dc3230 Thanks @Andarist! - Compute the terminal's size lazily to avoid spurious stderr output in non-interactive mode
#18572a73025 Thanks @mixelburg! - Fix confusing prompt labels when entering changeset summary after external editor fallback
#18426df3a5e Thanks @RodrigoHamuy! - Allow private packages to depend on skipped packages without requiring them to also be skipped. Private packages are not published to npm, so it is safe for them to have dependencies on ignored or unversioned packages.
#1776503fcaa Thanks @bluwy! - Support absolute paths in changeset status --output <path>
#16936352819 Thanks @Andarist! - Fixed an issue with workspace:^ and workspace:~ dependency ranges not being semantically treated as, respectively, ^CURRENT_VERSION and ~CURRENT_VERSION. This led to dependent packages being, at times, bumped too often when their dependencies with those ranges were bumped.
Group/category section headings (<h2>) in the default theme now include an id attribute so they can be linked to via fragment identifiers (e.g. modules.html#classes), #3029.
Added a @reexport modifier tag to have TypeDoc convert variable/type references as a re-export instead of a new symbol, #3096.
API: Introduced generateOutputsBegin and generateOutputsEnd events on Application for plugin use.
Bug Fixes
When --emit none is used, TypeDoc will now report warnings about missing relative paths previously reported when rendering, #3078.
Improved performance via asynchronously performing git and file write operations, more performant JSX rendering, and source code bundling, #3103.
A @hidden tag on a constructor parameter-property will now only hide the property, not both the property and the parameter, #3111.
Custom @group and @category titles with the same sort weight are now ordered consistently with the alphabetical reflection sort, #3120.
Improved handling of comments for type aliases which have been declaration merged with functions, #3064.
Fixed anchor link generation to members named $, #3065.
Corrected typing of the plugin option to permit functions, #3066.
Warnings about unused @param tags will now be properly suppressed when they come from declaration files and
the suppressCommentWarningsInDeclarationFiles option is enabled, #3070.
Fixed conversion of types referencing type parameters on functions, #3071.
Fixed an issue causing TypeDoc to fail to generate documentation when implementing interfaces, #3052.
Fixed an issue preventing automatic entry point discovery on Windows, #3057.
Improved vertical positioning of text icons, #3056.
TypeDoc no longer includes source location information for type literal reflections. This could sometimes
cause TypeDoc to infer the wrong path when resolving base paths for display.
Adjusted markdown rendering to allow markdownItLoader to override more rendering #3055.
Features
Added support for regions for @include in .tsx, .cjs, and .mjs file references #3048.
Comments for TS-in-JS @typedef tags may now specify modifier tags with the inline tag syntax {@mod}.
This makes it possible to add modifier tags to these members, which previously was not possible as
TypeScript's parsing stops for these members at the next non-braced tag, #2916 and #3050.
A typedoc-config.schema.json is now included in the root of the package with a JSON schema for TypeDoc's
configuration file. The schema for the latest version is also published at https://typedoc.org/schema.json
and will automatically be picked up when writing typedoc.json files if you are using VSCode, #3054.
The gitRevision option now accepts the special value {branch}, which indicates source links should use
the current git branch for links, #3041.
Introduced validation.invalidPath for suppressing warnings caused by referencing relative paths which
do not exist when building the documentation, #3033.
API: Introduced Logger.validationWarning for validation which occurs during conversion rather than
during TypeDoc's normal validation step, #3033.
Introduced the preservedTypeAnnotationTags option to specify tags whose type annotations should
be copied to the output documentation, #3020.
API: Introduced typeAnnotation on CommentTag
Added excludePrivateClassFields option to hide #private members while allowing private members, #3017.
Added support for TypeScript's @this tag for JS files which describe this parameters, #3026.
The basePath option now also affects relative link resolution, TypeDoc will also check for
paths relative to the provided base path. If you instead want TypeDoc to only change the rendered
base path for sources, use the displayBasePath option, #3009.
Bug Fixes
Fixed bug introduced in 0.28.8 where TypeDoc could not render docs with some mixin classes, #3007.
@inheritDoc will now correctly overwrite @remarks and @returns blocks on the target comment, #3012.
The externalSymbolLinkMappings option now works properly on links pointing to inherited/overwritten signatures, #3014.
Variables marked with @enum now work for symbols imported from another module, #3003.
Improved magic introduced with #2999 to work with imported symbols, #3003.
Fixed relative link resolution to file names containing percent encoded URLs, #3006.
Linking to the project's README file with a relative link will now behave as expected, #3006.
Reduced unnecessary HTML element rendering in default theme.
API: Reflection.hasComment and Comment.hasVisibleComponent now accepts an optional notRenderedTags parameter.
References to type aliases defined as mapped types will now correctly create a reference to the type alias, #2954.
ignoredHighlightLanguages can now be used to prevent warnings for codeblocks containing languages
which are supported by Shiki but are not loaded, #2956.
TypeDoc's default theme now uses the same chevron for all collapsible elements, #2924
The chevronSmall helper is now deprecated and will be removed with v0.29.0.
Classes/interfaces marked with @hidden will no longer appear in the
"Hierarchy" section of the docs.
Introduced the preservedTypeAnnotationTags option to specify tags whose type annotations should
be copied to the output documentation, #3020.
API: Introduced typeAnnotation on CommentTag
Added excludePrivateClassFields option to hide #private members while allowing private members, #3017.
Added support for TypeScript's @this tag for JS files which describe this parameters, #3026.
TypeDoc now expects all input globs paths to be specified with / path separators, #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, #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, #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, #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, #2111.
Introduced the @primaryExport modifier tag to provide more fine grained
control over export conversion order, #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, #2528.
Type packageOptions as Partial<TypeDocOptions>, #2878.
TypeDoc will now warn if an option which should only be set at the root level is set in packageOptions, #2878.
Introduced @function tag to force TypeDoc to convert variable declarations with a type annotation as functions, #2881.
Exposed a TypeDoc global object in the HTML theme which can be used to prevent TypeDoc from using localStorage, #2872.
Introduced @preventInline and @inlineType tags for further control extending the @inline tag, #2862.
Introduced @preventExpand and @expandType tags for further control extending the @expand tag, #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, #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, #2876.
Fixed rendering of function types within arrays and union types, #2892.
Fixed an issue where if the theme JS didn't load, the page wouldn't be shown, #2894.
Next steps: Take a moment to review the security alert above. Review
the linked package source code to understand the potential risk. Ensure the
package is not malicious before proceeding. If you're unsure how to proceed,
reach out to your security team or ask the Socket team for help at
support@socket.dev.
Suggestion: Packages should avoid accessing the shell which can reduce portability, and make it easier for malicious shell access to be introduced.
Mark the package as acceptable risk. To ignore this alert only
in this pull request, reply with the comment
@SocketSecurity ignore npm/@inquirer/external-editor@1.0.3. You can
also ignore all packages with @SocketSecurity ignore-all.
To ignore an alert for all future pull requests, use Socket's Dashboard to
change the triage state of this alert.
8 tests failed due to APIError: Request validation failed and Internal Server Error responses during tests/leaderboard-roles.test.ts and tests/settings.test.ts.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR contains the following updates:
2.27.12→2.31.11.2.2→1.4.00.3.0→0.4.00.27.7→0.28.201.1.2→1.3.14.4.2→4.12.04.0.12→4.0.15Release Notes
changesets/changesets (@changesets/cli)
v2.31.1Compare Source
Patch Changes
15cf592Thanks @ingvaldlorentzen! - Fixed already-published version detection with npm 12, which always wraps successfulnpm info --jsonoutput in an array. The unwrapped output madechangeset publishtreat every package as unpublished and fail attempting to republish existing versions.v2.31.0Compare Source
Minor Changes
#1889
96ca062Thanks @mixelburg! - Error on unsupported flags for individual CLI commands and print the matching command usage to make mistakes easier to spot.#1873
42943b7Thanks @mixelburg! - Respond to--helpon all subcommands. Previously,--helpwas only handled when it was the sole argument; passing it alongside a subcommand (e.g.changeset version --help) would silently execute the command instead. Now--helpalways exits early and prints per-command usage when a known subcommand is provided, or the general help text otherwise.Patch Changes
d2121dcThanks @Andarist! - Fix npm auth for path-based registries during publish by preserving configured registry URLs instead of normalizing them.#1888
036fdd4Thanks @mixelburg! - Fix severalchangeset versionissues with workspace protocol dependencies. Valid explicitworkspace:ranges and aliases are no longer rewritten unnecessarily, and workspace path references are handled correctly during versioning.#1903
5c4731fThanks @Andarist! - Gracefully handle stalenpm infodata leading to duplicate publish attempts.#1867
f61e716Thanks @Andarist! - Improved detection forpublishedstate of prerelease-only packages withoutlatestdist-tag on GitHub Packages registry.Updated dependencies [
036fdd4,036fdd4,036fdd4]:v2.30.0Compare Source
Minor Changes
#1840
057cca2Thanks @wotan-allfather! - Add--sinceflag toaddcommandThe
addcommand now supports a--sinceflag that allows you to specify which branch, tag, or git ref to use when detecting changed packages. This is useful for gitflow workflows where you have multiple target branches and thebaseBranchconfig option doesn't cover all use cases.Example:
changeset add --since=developIf not provided, the command falls back to the
baseBranchvalue in your.changeset/config.json.#1845
2b4a66aThanks @Andarist! - Delegate OTP prompting to the package manager instead of handling it in-process. This allows Changesets to use the package manager's native web auth support.#1774
667fe5aThanks @bluwy! - Support importing customcommitoption ES module. Previously, it usedrequire()which only worked for CJS modules, however now it usesimport()which supports both CJS and ES modules.#1839
73b1809Thanks @leochiu-a! - Add a--message(-m) flag tochangeset add(and defaultchangeset) so the changeset summary can be provided from the command line. When--messageis present, the summary prompt is skipped while the final confirmation step is kept.#1806
0e8e01eThanks @luisadame! - Changeset CLI can now be run from the nested directories in the project, where the.changesetdirectory has to be found in one of the parent directoriesPatch Changes
#1849
9dc3230Thanks @Andarist! - Compute the terminal's size lazily to avoid spurious stderr output in non-interactive mode#1857
2a73025Thanks @mixelburg! - Fix confusing prompt labels when entering changeset summary after external editor fallback#1842
6df3a5eThanks @RodrigoHamuy! - Allow private packages to depend on skipped packages without requiring them to also be skipped. Private packages are not published to npm, so it is safe for them to have dependencies on ignored or unversioned packages.#1776
503fcaaThanks @bluwy! - Support absolute paths inchangeset status --output <path>Updated dependencies [
667fe5a,1772598,b6f4c74,6df3a5e,6df3a5e,27fd8f4]:v2.29.8Compare Source
Patch Changes
#1437
aa68d54Thanks @with-heart! - Tweaked a hint text printed when one confirms an empty set of packages to be releasedUpdated dependencies [
cc28222,e520bf5,13dace8]:v2.29.7Compare Source
Patch Changes
957f24e]:v2.29.6Compare Source
Patch Changes
a3563b0Thanks @benmccann! - Switch to maintained fork ofexternal-editorv2.29.5Compare Source
Patch Changes
#1693
6352819Thanks @Andarist! - Fixed an issue withworkspace:^andworkspace:~dependency ranges not being semantically treated as, respectively,^CURRENT_VERSIONand~CURRENT_VERSION. This led to dependent packages being, at times, bumped too often when their dependencies with those ranges were bumped.Updated dependencies [
6352819]:v2.29.4Compare Source
Patch Changes
#1668
65d6632Thanks @Andarist! - Fixed a crash in pre mode when trying to version private packages when tagging for private package is disabledUpdated dependencies [
65d6632]:v2.29.3Compare Source
Patch Changes
#1589
de8bebcThanks @remorses, @vzt7! - Fixed a crash in prerelease mode when a package misses the version field in itspackage.json#1619
c1e8a78Thanks @manucorporat! - Support../inpublishConfig.directorywhen publishing packagesUpdated dependencies [
de8bebc]:v2.29.2Compare Source
Patch Changes
#1636
f73f84aThanks @Netail! - Correctly resolve new changesets withsinceoption when the.changesetdirectory is not directly in the git rootUpdated dependencies [
f73f84a]:v2.29.1Compare Source
Patch Changes
#1620
b15e629Thanks @Netail! - Correctly fetch new changesets with since if the git option diff.relative has been set to trueUpdated dependencies [
b15e629]:v2.29.0Compare Source
Minor Changes
29f34a3Thanks @JounQin! - Support scoped registries configured usingpackage.json#publishConfigv2.28.1Compare Source
Patch Changes
b9df596]:v2.28.0Compare Source
Minor Changes
84a4a1bThanks @bennypowers! - Added a new config option to opt-out from formatting with Prettier usingprettier: false.Patch Changes
84a4a1b,84a4a1b]:wobsoriano/bun-plugin-dts (bun-plugin-dts)
v0.4.0Compare Source
TypeStrong/TypeDoc (typedoc)
v0.28.20Compare Source
Features
<h2>) in the default theme now include anidattribute so they can be linked to via fragment identifiers (e.g.modules.html#classes), #3029.@reexportmodifier tag to have TypeDoc convert variable/type references as a re-export instead of a new symbol, #3096.generateOutputsBeginandgenerateOutputsEndevents onApplicationfor plugin use.Bug Fixes
--emit noneis used, TypeDoc will now report warnings about missing relative paths previously reported when rendering, #3078.@hiddentag on a constructor parameter-property will now only hide the property, not both the property and the parameter, #3111.@groupand@categorytitles with the same sort weight are now ordered consistently with thealphabeticalreflection sort, #3120.Thanks!
v0.28.19Compare Source
Features
triple-slashcomment style, which requires exactly three slashes in the comment, #3089.Bug Fixes
Thanks!
v0.28.18Compare Source
Features
v0.28.17Compare Source
Bug Fixes
$, #3065.pluginoption to permit functions, #3066.@paramtags will now be properly suppressed when they come from declaration files andthe suppressCommentWarningsInDeclarationFiles option is enabled, #3070.
Thanks!
v0.28.16Compare Source
Bug Fixes
cause TypeDoc to infer the wrong path when resolving base paths for display.
markdownItLoaderto override more rendering #3055.Features
@includein.tsx,.cjs, and.mjsfile references #3048.@typedeftags may now specify modifier tags with the inline tag syntax{@mod}.This makes it possible to add modifier tags to these members, which previously was not possible as
TypeScript's parsing stops for these members at the next non-braced tag, #2916 and #3050.
typedoc-config.schema.jsonis now included in the root of the package with a JSON schema for TypeDoc'sconfiguration file. The schema for the latest version is also published at https://typedoc.org/schema.json
and will automatically be picked up when writing typedoc.json files if you are using VSCode, #3054.
Thanks!
v0.28.15Compare Source
Features
gitRevisionoption now accepts the special value{branch}, which indicates source links should usethe current git branch for links, #3041.
validation.invalidPathfor suppressing warnings caused by referencing relative paths whichdo not exist when building the documentation, #3033.
Logger.validationWarningfor validation which occurs during conversion rather thanduring TypeDoc's normal validation step, #3033.
v0.28.14Compare Source
Features
preservedTypeAnnotationTagsoption to specify tags whose type annotations shouldbe copied to the output documentation, #3020.
API: Introduced
typeAnnotationonCommentTagexcludePrivateClassFieldsoption to hide#privatemembers while allowingprivatemembers, #3017.@thistag for JS files which describethisparameters, #3026.v0.28.13Compare Source
Features
basePathoption now also affects relative link resolution, TypeDoc will also check forpaths relative to the provided base path. If you instead want TypeDoc to only change the rendered
base path for sources, use the
displayBasePathoption, #3009.Bug Fixes
@inheritDocwill now correctly overwrite@remarksand@returnsblocks on the target comment, #3012.externalSymbolLinkMappingsoption now works properly on links pointing to inherited/overwritten signatures, #3014.v0.28.12Compare Source
Bug Fixes
@enumnow work for symbols imported from another module, #3003.API:
Reflection.hasCommentandComment.hasVisibleComponentnow accepts an optionalnotRenderedTagsparameter.v0.28.11Compare Source
Features
if they do not have their own comment, #2999.
Bug Fixes
?in the reflection preview and signature, #2995.compilerOptionsoption now functions properly with non-boolean options, #3000.compilerOptionsoption are now handled gracefully, #3000.v0.28.10Compare Source
Bug Fixes
v0.28.9Compare Source
Features
Bug Fixes
v0.28.8Compare Source
Features
pluginfunction can now be given plugin functions to load.-within tag names to supporttypescript-json-schema's@TJS-typetag, #2972.Context.createSymbolIdfor use by plugins.Bug Fixes
<img srcset>will now be discovered by TypeDoc, #2975.<source src>and<source srcset>elements will now be discovered by TypeDoc, #2975.Thanks!
v0.28.7Compare Source
Features
@sortStrategytag to override thesortoption on a specific reflection, #2965.Bug Fixes
export { type X }are no longer missing comments, #2970.localeto an unknown value will now cause TypeDoc to operate in English instead of a debug locale.v0.28.6Compare Source
Features
Bug Fixes
export { type X }are now detected and converted as interfaces/type aliases, #2962.Thanks!
v0.28.5Compare Source
Bug Fixes
ignoredHighlightLanguagescan now be used to prevent warnings for codeblocks containing languageswhich are supported by Shiki but are not loaded, #2956.
v0.28.4Compare Source
Features
Bug Fixes
The
chevronSmallhelper is now deprecated and will be removed with v0.29.0.@hiddenwill no longer appear in the"Hierarchy" section of the docs.
Thanks!
v0.28.3Compare Source
Bug Fixes
@inlinenow functions when referencing tuple types, #2932.@linklinks to the current page are now rendered, #2934.@includeCodenow supports regions in TypeScript files with.mtsand.ctsfile extensions, #2935.v0.28.2Compare Source
Features
@group noneand@category nonewill now render their children without a sectionheading in the default theme, #2922.
@disableGroupstag to completely disable the grouping mechanism for agiven reflection, #2922.
Bug Fixes
@classnow correctly handle@category, #2914.@classnow include constructor parameters, #2914.@classwith a generic first constructor function now adoptthat function's type parameters as the class type parameters, #2914.
externalSymbolLinkMappingsoption when URL is set to#, #2921.@typedefnow correctly handle the constraint, #2929.toStringon types containing index signatures now behave correctly, #2917.@inlineTypeto the list of tags excluded by default.v0.28.1Compare Source
Features
preservedTypeAnnotationTagsoption to specify tags whose type annotations shouldbe copied to the output documentation, #3020.
API: Introduced
typeAnnotationonCommentTagexcludePrivateClassFieldsoption to hide#privatemembers while allowingprivatemembers, #3017.@thistag for JS files which describethisparameters, #3026.v0.28.0Compare Source
Breaking Changes
/path separators, #2825.--entryPointStrategy mergemode now requires JSON from at least version 0.28.0.jptranslations fromlang, to migrate switch toja.intentionallyNotExportednow use a package name/package relative path instead of an absolute path for matching.source-ordersort ordering now considers package names / package relative paths instead of using the absolute paths to a file.package.jsonfile if--readmeis not setthis change improves handling of monorepo setups where some packages have readme files and others do not, #2875.
they are initialized with a function expression. TypeDoc can be instructed to convert them as functions
with the
@functiontag, #2881.to how interfaces are rendered, #2817.
API Breaking Changes
ProjectReflection.getReflectionFromSymbolandProjectReflection.getSymbolFromReflectionhave been moved toContextPathandPathArrayparameter types now always contain normalized paths.Routerwhich is used for URL creation.Reflection.url,Reflection.anchor, andReflection.hasOwnDocumenthave been removed.Deserializer.reviveProject(s)no longer accepts an option to add project documents.Deserializer.reviveProjectsnow requires analwaysCreateEntryPointModuleoption.Comment.serializeDisplayPartsno longer requires a serializer argument.ReflectionSymbolId.fileNameis now optional, TypeDoc now stores a combination of a package name and package relative path instead.The
fileNameproperty will be present when initially created, but is not serialized.DeclarationReflection.relevanceBoostattribute which was added for plugins, but never used.i18nproxy is no longer passed to many functions, instead, referencei18nexported from the module directly.ReflectionKind.singularStringandReflectionKind.pluralStringnow returns translated strings.The methods on
Internationalizationto do this previously have been removed.DefaultThemeRenderContext'stypeDeclarationandtypeDetailsIfUsefulmethods now require both a reflection and a type in order to support
@expandTypeFeatures
--routeroption which can be used to modify TypeDoc's output folderstructure. This can be extended with plugins, #2111.
@primaryExportmodifier tag to provide more fine grainedcontrol over export conversion order, #2856
packagesRequiringDocumentationoption forvalidation.notDocumented, TypeDoc will expect comments to be present for symbols in the specified packages.typedoc/browserentrypoint for parsing and using serialized JSON files, #2528.packageOptionsasPartial<TypeDocOptions>, #2878.packageOptions, #2878.@functiontag to force TypeDoc to convert variable declarations with a type annotation as functions, #2881.TypeDocglobal object in the HTML theme which can be used to prevent TypeDoc from usinglocalStorage, #2872.@preventInlineand@inlineTypetags for further control extending the@inlinetag, #2862.@preventExpandand@expandTypetags for further control extending the@expandtag, #2862.DefaultThemeRenderContext.reflectionIconfor more granular control over displayed reflection icons.Bug Fixes
Thanks!
v0.27.9Compare Source
This will be the last v0.27.x release, see #2868 for discussion on the 0.28 beta.
Features
v0.27.8Compare Source
Features
visibilityFilteroption now supports individual signatures, #2846.faviconoption may now be given a link starting withhttps?://instead of a path, #2851.#as the link inexternalSymbolLinkMappingsto indicate the type should not be linked to, #2853.Bug Fixes
Configuration
📅 Schedule: (UTC)
* 0-3 * * 1)🚦 Automerge: Enabled.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
👻 Immortal: This PR will be recreated if closed unmerged. Get config help if that's undesired.
This PR was generated by Mend Renovate. View the repository job log.