chore(deps): update dependency typedoc to ~0.20.0 #21
Conversation
This file contains 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
![renovate[bot]](https://avatars.githubusercontent.com/in/2740?s=60&v=4){kind=small}
renovate
bot
requested review from
amacar,
KovacZan and
kristjank
as code owners
amacar
approved these changes
Jan 4, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.19.2->~0.20.0Release Notes
TypeStrong/TypeDoc
v0.20.10Compare Source
Bug Fixes
Changes
typedoc --helpv0.20.9Compare Source
Bug Fixes
v0.20.8Compare Source
Bug Fixes
v0.20.7Compare Source
Bug Fixes
v0.20.6Compare Source
Bug Fixes
Features
v0.20.5Compare Source
Bug Fixes
v0.20.4Compare Source
Bug Fixes
v0.20.3Compare Source
Features
v0.20.2Compare Source
Bug Fixes
Features
v0.20.1Compare Source
Bug Fixes
v0.20.0Compare Source
Migration from previous versions
Version 0.20 completely reworks how documentation is generated by TypeDoc. In previous versions, there was
--mode fileand--mode modules, which documented files according to their content on the filesystem. This worked reasonably well before ES modules were commonly used, but was insufficient for the modern ecosystem. In 0.20, TypeDoc documents your project according to what you export.With this in mind, there are several breaking changes that will likely effect you:
1. TypeScript compiler options must be specified in a tsconfig.json file, they may not be passed directly to TypeDoc.
1. Removed options -
mode,excludeNotExported,includeDeclarations,ignoreCompilerErrors(#1403),entryPoint1.
inputFileshas been renamed toentryPointsto better reflect its usage1. Existing third party themes may be broken due to changes to the type structure
1. The behavior of
excludehas changed, it is now only used to filter entry points if a directory is provided as the entry point.1. TypeDoc now uses Shiki instead of Highlight.js for syntax highlighting. Shiki is faster, about 10% of the size of Highlight.js, and makes it possible for future work to allow users to choose a light or dark theme. However, it does not support all of the same languages as Highlight.js. If you run
typedoc --help, it will print a list of all supported highlighting languages.The command line for most projects now should be fairly simple:
If you have more than one entry point, TypeDoc will create a module for each entry point. The module name will be derived from the entry file name. If the derived name is not the desired name, you can use a module comment with the
@moduletag to change it:Bug Fixes
Features
[@module](https://togithub.com/module)tag (15cb73c)API Breaking changes
Application.generateDocs,Application.generateJsonnow return a promise"string-literal"type removed, there is now a single"literal"type that includes string literals, number literals, bigint literals, and nullcontext.fileNameshas been removedisExported/isConstructorPropertyReflectionFlags remvoedConverter.EVENT_FUNCTION_IMPLEMENTATIONremoved - it was inappropriately used to perform some data extraction, which was unreliable since not all function declarations include an implementationConverter.EVENT_BEGINlisteners may not accesscontext.program. If they need access to a TS program, they should instead usecontext.programsand find the one they are interested in.Thanks!
Thank you to everyone who helped test the 0.20 beta, and the following code contributors:
Renovate 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.