This repository was archived by the owner on Apr 25, 2022. It is now read-only.
Open
Conversation
458e6dd to
6bbce47
Compare
6bbce47 to
7136a4b
Compare
7136a4b to
d6ec0fd
Compare
d6ec0fd to
b99a614
Compare
b99a614 to
e4c0653
Compare
e4c0653 to
2013f64
Compare
2013f64 to
e723443
Compare
e723443 to
8c52b2d
Compare
8c52b2d to
c90436e
Compare
c90436e to
08dd102
Compare
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
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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:
0.20.27->0.22.15Release Notes
TypeStrong/TypeDoc
v0.22.15Compare Source
Features
abstractand enums which areconstwill now be indicated in their rendered documentation, #1874.compilerOptions, which can be used to override compiler options read fromtsconfig.json, #1891.content.begin,content.end,navigation.begin,navigation.endBug Fixes
undefined, #1907.Thanks!
v0.22.14Compare Source
Bug Fixes
@enumstyle enum members defined in declaration files, #1880.--validation.notDocumentedwarnings for functions/methods/type aliases, #1895, #1898.removeReflectionnot completely removing reflections from the project, #1898.@hidden/@ignore/@excludecomments on default exports with no associated variable, #1903.makeRecursiveVisitorwill now correctly call theintersectioncallback, #1910.Thanks!
v0.22.13Compare Source
Features
@paramcomments for nested members that target union and intersection types, #1876.Bug Fixes
--requiredToBeDocumentedoption, #1872.thisparameters in documentation for some functions, #1875.v0.22.12Compare Source
Features
--validation.notDocumentedoption to warn on items that are not documented, #1817.Bug Fixes
constvariables not properly marked asconst, #1866.Thanks!
v0.22.11Compare Source
Features
cnameoption for GitHub Pages custom domain support, #1803.ReferenceTypes which reference an external symbol will now includequalifiedNameandpackagein their serialized JSON.Bug Fixes
h1andh2elements being too low, #1796.addUnknownSymbolResolverwill now be correctly given the qualified name to the symbol being referenced, #1832.Thanks!
v0.22.10Compare Source
Features
Bug Fixes
default, thedefaultexport will now always be the renamed symbol, #1795.@types/nodeversions, Gerrit0/typedoc-plugin-missing-exports#5.v0.22.9Compare Source
Features
It will only work if both loaded TypeDocs are v0.22.9 or later.
typedoc-themein their keywords.Plugins which define a custom theme should include this keyword so that they can be automatically collected and displayed at https://typedoc.org/guides/themes/.
Bug Fixes
<meta charset="utf-8" />appears within the first 1024 bytes of generated pages, #1783.Thanks!
v0.22.8Compare Source
Features
See the documentation in custom-themes.md for details.
Bug Fixes
@categorytag incorrectly appearing on function types if used on a type alias, #1745.Thanks!
v0.22.7Compare Source
Features
githubprivate.comdomain, #1743.Bug Fixes
hideGeneratoris set, #1749.@categorytag incorrectly appearing on function types if used on a type alias, #1745.Thanks!
v0.22.6Compare Source
Features
@enumto all variables whose property types are string literals, #1740.Bug Fixes
as conststyle enums, #1727.@typeParamon type aliases, #1733.Thanks!
v0.22.5Compare Source
Features
@paramcomments for destructured parameters and rename__namedParametersto the name specifiedin the
@paramcomment if the number of@paramcomments match the number of parameters, resolves #1703.intentionallyNotExportedoption may now include file names/paths to limit its scope, for example, the followingwill suppress warnings from
Fooinsrc/foo.tsnot being exported, but will not suppress warnings if anotherFoodeclared in
src/utils/foo.tsis not exported.{ "intentionallyNotExported": ["src/foo.ts:Foo"] }--emitoption can now be used to more finely control what TypeDoc will emit.bothdocsnonetrueboth, for backwards compatibility. Will be removed in 0.23.falsedocs, for backwards compatibility. Will be removed in 0.23.Bug Fixes
<caption>elements from@exampletags, resolves #1679.emitDeclarationOnlycompiler option is now supported, resolves #1716..json, resolves #1712.globalThisnamespace, could only be caused by a plugin.Thanks!
v0.22.4Compare Source
Features
validationcan now be set to true/false to enable/disable all flags within them.githubPagesoption (default: true), which will create a.nojekyllpage in the generated output, resolves #1680.MarkdownEventis now exported, resolves #1696.Bug Fixes
Thanks!
v0.22.3Compare Source
Bug Fixes
light-plusanddark-plus, they were accidentally set tomin-lightandmin-darkin v0.22.0.Features
validationoption which can be used to disable checks for non-exported symbols.On the command line, this can be specified with
--validation.notExported true, or in an options file with:{ "validation": { "notExported": true } }validationoption, deprecatedlistInvalidSymbolLinks, which will be removed in 0.23.v0.22.2Compare Source
Bug Fixes
v0.22.1Compare Source
Features
abstractand enums which areconstwill now be indicated in their rendered documentation, #1874.compilerOptions, which can be used to override compiler options read fromtsconfig.json, #1891.content.begin,content.end,navigation.begin,navigation.endBug Fixes
undefined, #1907.Thanks!
v0.22.0Compare Source
Breaking Changes
packagesandentryPointsoptions have been combined.To migrate configurations which used
packages, replacepackageswithentryPointsand setentryPointStrategytopackages.disableOutputChecktocleanOutputDirto more clearly reflect its behavior.highlightThemeoption has been split intolightHighlightThemeanddarkHighlightTheme.tocoption.This change provides major performance benefits, reducing rendering time by up to 10x for several benchmarked projects.
It also allows themes to be easily type checked, preventing mistakes when creating custom themes.
Removing Handlebars also fixed memory leaks when
--watchwas specified due to Handlebar's caching mechanism.This change breaks all existing custom themes, so a theme created for v0.21 or earlier will not work in v0.22.
See internal-docs/custom-themes.md for documentation on how to create a custom theme in v0.22.
entryPointStrategyfromexpandtoresolve.This means that an exclude of
**/someDirwill not exclude files in that directory. To exclude files in a directory, specify**/someDir/**.Features
customCssoption, closes #1060.for documentation on how to create a plugin which enables this.
Support for linking to MDN for global types is provided by typedoc-plugin-mdn-links.
entryPointStrategyto reduce confusion from new TypeDoc users on handling of entry points.There are three possible options:
<directory>/indexas the entry point.--packagesin v0.21, behaves as documented in the Monorepo section in the readme.typedocMainin package.json when using thepackagesstrategy for resolving entry points.application.validate(project).as constenums", closes #1675.hideLegendoption, closes #1108.--logLevel Verbose)Bug Fixes
@param, the name will not be dropped when rendering, closes #1410.API Breaking Changes
"export"key inpackage.json, preventing plugins from importing internal paths.TypeDoc should now export all necessary structures (potentially marked with
@internalif likely to change) from the root export.ReflectionKindvalues forProject,Module,Namespace, andEnumhave changed.export=. Plugins are now required to export aloadfunction.TypeParameterType, references to type parameters have produced aReferenceTypesince v0.20.0.clonemethod. It inconsistently performed deep or shallow clones, and was not used by TypeDoc.equalsmethod. It was occasionally correct for medium-complexity types, and always incorrect for more complicated types.Thanks!
v0.21.9 (2021-08-29)
Bug Fixes
Thanks!
v0.21.8 (2021-08-28)
Features
Thanks!
v0.21.7 (2021-08-27)
Features
v0.21.6 (2021-08-19)
Features
Bug Fixes
Thanks!
v0.21.5 (2021-07-31)
Features
Bug Fixes
Thanks!
v0.21.4 (2021-07-12)
Bug Fixes
v0.21.3 (2021-07-10)
Breaking Changes
Bug Fixes
Thanks!
v0.21.2 (2021-06-27)
Bug Fixes
v0.21.1 (2021-06-25)
Bug Fixes
readmecould not be set tononein a config file, closes #1608v0.21.10Compare Source
v0.21.9Compare Source
Bug Fixes
Thanks!
v0.21.8Compare Source
Features
Thanks!
v0.21.7Compare Source
Features
v0.21.6Compare Source
Features
Bug Fixes
Thanks!
v0.21.5Compare Source
Features
Bug Fixes
Thanks!
v0.21.4Compare Source
Bug Fixes
v0.21.3Compare Source
Breaking Changes
Bug Fixes
Thanks!
v0.21.2Compare Source
Bug Fixes
v0.21.1Compare Source
Bug Fixes
readmecould not be set tononein a config file, closes #1608v0.21.0Compare Source
Breaking Changes
Features
Bug Fixes
voidreturn type, closes #1215Thanks!
v0.20.37 (2021-06-16)
Features
Bug Fixes
markeddependency to 2.0.x (#1602), closes #1601Thanks!
v0.20.36 (2021-04-23)
Features
Bug Fixes
Thanks!
v0.20.35 (2021-04-03)
Features
Bug Fixes
Thanks!
v0.20.34 (2021-03-25)
Bug Fixes
v0.20.33 (2021-03-22)
Bug Fixes
v0.20.32 (2021-03-14)
Bug Fixes
v0.20.31 (2021-03-14)
Bug Fixes
Thanks!
v0.20.30 (2021-03-06)
Bug Fixes
v0.20.29 (2021-03-04)
Features
v0.20.28 (2021-02-23)
Bug Fixes
v0.20.27 (2021-02-20)
Features
Bug Fixes
Thanks!
v0.20.26 (2021-02-20)
Bug Fixes
v0.20.25 (2021-02-15)
Features
v0.20.24 (2021-02-11)
Features
Thanks!
v0.20.23 (2021-02-06)
Bug Fixes
Thanks!
v0.20.22 (2021-02-06)
Bug Fixes
v0.20.21 (2021-02-05)
Bug Fixes
v0.20.20 (2021-01-31)
Features
Bug Fixes
Thanks!
v0.20.19 (2021-01-25)
Features
v0.20.18 (2021-01-24)
Bug Fixes
v0.20.17 (2021-01-23)
Features
Bug Fixes
Thanks!
v0.20.16 (2021-01-17)
Bug Fixes
v0.20.15 (2021-01-16)
Features
Bug Fixes
@types/ws, closes #1463@enumtags, closes #1464Thanks!
v0.20.14 (2021-01-09)
Bug Fixes
Thanks!
v0.20.13 (2021-01-06)
Bug Fixes
v0.20.12 (2021-01-05)
Bug Fixes
Thanks!
v0.20.11 (2021-01-04)
Bug Fixes
v0.20.10 (2021-01-03)
Bug Fixes
v0.20.9 (2021-01-02)
Bug Fixes
1886304v0.20.8 (2021-01-01)
Bug Fixes
v0.20.7 (2020-01-01)
Bug Fixes
v0.20.6 (2020-01-01)
Features
Bug Fixes
v0.20.5 (2020-12-30)
Bug Fixes
v0.20.4 (2020-12-30)
Bug Fixes
v0.20.3 (2020-12-29)
Features
v0.20.2 (2020-12-29)
Features
Bug Fixes
v0.20.1 (2020-12-29)
Bug Fixes
v0.20.37Compare Source
Features
Bug Fixes
markeddependency to 2.0.x (#1602), closes #1601Thanks!
v0.20.36Compare Source
Features
Bug Fixes
Thanks!
v0.20.35Compare Source
Features
Bug Fixes
Thanks!
v0.20.34Compare Source
Bug Fixes
v0.20.33Compare Source
Bug Fixes
v0.20.32Compare Source
Bug Fixes
v0.20.31Compare Source
Bug Fixes
Thanks!
v0.20.30Compare Source
Bug Fixes
v0.20.29Compare Source
Features
v0.20.28Compare Source
Bug Fixes
Configuration
📅 Schedule: At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR has been generated by WhiteSource Renovate. View repository job log here.