TypeStrong/TypeDoc
### [`v0.23.1`](https://togithub.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0231-2022-06-26)
[Compare Source](https://togithub.com/TypeStrong/TypeDoc/compare/v0.23.0...v0.23.1)
##### Bug Fixes
- If a declaration has multiple comments associated with it, the last one should be used, [#1961](https://togithub.com/TypeStrong/TypeDoc/issues/1961).
### [`v0.23.0`](https://togithub.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0230-2022-06-26)
[Compare Source](https://togithub.com/TypeStrong/TypeDoc/compare/v0.22.18...v0.23.0)
##### Breaking Changes
- Node 12 is no longer officially supported as it has gone end of life as of 2022-04-30. It might still work, but may stop working at any time.
- Dropped support for TypeScript before 4.6.
- `{@link}` tags in comments will now be resolved as declaration references similar to TSDoc's declaration references.
For most cases, this will just work. See [the documentation](https://typedoc.org/guides/link-resolution/) for details on how link resolution works.
- TypeDoc will now produce warnings for bracketed links (`[[ target ]]`). Use `{@link target}` instead. The `{@link}` syntax will be recognized by [TypeScript 4.3](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-4-3.html#editor-support-for-link-tags) and later and used to provide better intellisense. TypeDoc version 0.24.0 will remove support for `[[ target ]]` style links.
- `extends` in typedoc.json is now resolved using NodeJS module resolution, so a local path must begin with `./`.
- In the JSON output for `DeclarationReflection`s, `getSignature` is no longer a one-tuple.
- In the JSON output for `DeclarationReflection`s, `setSignature` is no longer a one-tuple.
- In the JSON output for `DeclarationReflection`s, `typeParameter` has been renamed to `typeParameters`
- The `searchGroupBoosts` option must now be given the rendered group name rather than reflection kind names, and can be given custom group names.
- `@inheritDoc` now follows the behavior specified by TSDoc when copying comments with a reference.
- The `gaSite` option has been removed since Google Analytics now infers the site automatically, updated Google Analytics script to latest version, [#1846](https://togithub.com/TypeStrong/TypeDoc/issues/1846).
- Comments on export declarations will only overrides comments for references and namespaces, [#1901](https://togithub.com/TypeStrong/TypeDoc/issues/1901).
- The deprecated `listInvalidSymbolLinks` option has been removed. Use `validation.invalidLink` instead.
- The deprecated `true` and `false` values have been removed from `--emit`, to migrate replace `true` with `"both"` and `false` with `"docs"` (the default).
- Links are no longer be resolved against a global list of all symbols. See [the documentation](https://typedoc.org/guides/link-resolution/) for details on link resolution.
- The `validation.invalidLink` option is now on by default.
- `reflection.decorates`, `reflection.decorators`, and their corresponding interfaces have been removed as no code in TypeDoc used them.
- The shape of the `Comment` class has changed significantly to support multiple tag kinds.
- Listeners to `Converter.EVENT_CREATE_TYPE_PARAMETER` and `Converter.EVENT_CREATE_DECLARATION` will now never be passed a `ts.Node` as their third argument.
- Constant variables which are interpreted as functions will no longer have the `ReflectionFlag.Const` flag set.
- `reflection.defaultValue` is no longer set for enum members. The same information is available on `reflection.type` with more precision.
- Removed deprecated `removeReaderByName`, `addDeclarations` and `removeDeclarationByName` methods on `Options`.
- Removed `ProjectReflection.directory`, it was unused by TypeDoc and not properly tested.
- Removed `ProjectReflection.files`, this was an internal cache that should not have been exposed, and shouldn't have existed in the first place, since removing it made TypeDoc faster.
- Removed `ReflectionGroup.kind` since groups can now be created with the `@group` tag.
- Removed `ReflectionKind.Event`, the `@event` tag is now an alias for `@group Events`. Note: This changes the value of `ReflectionKind.Reference` from `16777216` to `8388608`.
- Themes are now set on the document element rather than on body, [#1706](https://togithub.com/TypeStrong/TypeDoc/issues/1706).
##### Features
- TypeDoc now supports the `@group` tag to group reflections in a page. If no `@group` tag is specified, reflections will be grouped according to their kind, [#1652](https://togithub.com/TypeStrong/TypeDoc/issues/1652).
- TypeDoc will now search for `typedoc.js(on)` in the `.config` folder in the current working directory.
- Entry point strategies `Resolve` and `Expand` may now specify globs, [#1926](https://togithub.com/TypeStrong/TypeDoc/issues/1926).
- `typedoc.json` now supports comments like `tsconfig.json`.
- TypeDoc will now read the `blockTags`, `inlineTags`, and `modifierTags` out of `tsdoc.json` in the same directory as `tsconfig.json` if it exists.
It is recommended to add `"extends": ["typedoc/tsdoc.json"]`, which defines TypeDoc specific tags to your `tsdoc.json` if you create one.
- If an exported symbol has multiple declarations, TypeDoc will now check all appropriate declarations for comments, and warn if more than one declaration contains a comment, [#1855](https://togithub.com/TypeStrong/TypeDoc/issues/1855).
- Improved support for JSDoc style `@example` tags. If the tag content does not include a code block, TypeDoc now follows VSCode's behavior of treating the entire block as a code block, [#135](https://togithub.com/TypeStrong/TypeDoc/issues/135).
- TypeDoc will now render members marked with `@deprecated` with a line through their name, [#1381](https://togithub.com/TypeStrong/TypeDoc/issues/1381).
- Added new `commentStyle` option which can be used to control what comments TypeDoc will parse.
| Value | Behavior |
| ----- | -------------------------------------- |
| JSDoc | Use block comments starting with `/**` |
| Block | Use all block comments |
| Line | Use `//` comments |
| All | Use both block and line comments |
- TypeDoc will now warn if part of a comment will be overwritten due to use of `@inheritDoc` instead of silently dropping part of the comment.
- Added support for inline `@inheritDoc` tags, [#1480](https://togithub.com/TypeStrong/TypeDoc/issues/1480).
- It is now possible to link directly to a specific overload, [#1326](https://togithub.com/TypeStrong/TypeDoc/issues/1326).
- The JSON output will now include URLs to the file on the remote repository if possible.
- Added a new `visibilityFilters` option which controls the available filters on a page.
- TypeDoc will now try to place block elements on a new line in HTML output, resulting in less overwhelming diffs when rebuilding docs, [#1923](https://togithub.com/TypeStrong/TypeDoc/issues/1923).
- Added `blockTags`, `inlineTags`, `modifierTags` to control which tags TypeDoc will allow when parsing comments.
If a tag not in in one of these options is encountered, TypeDoc will produce a warning and use context clues to determine how to parse the tag.
##### Bug Fixes
- Fixed off by one error in warnings for types referenced but not included in the documentation.
- TypeDoc will no longer render a `Type Parameters` heading if there are no type parameters in some cases.
- Improved source location detection for constructors.
- Improved comment discovery on destructured exported functions, [#1770](https://togithub.com/TypeStrong/TypeDoc/issues/1770).
- Links which refer to members within a reference reflection will now correctly resolve to the referenced reflection's member, [#1770](https://togithub.com/TypeStrong/TypeDoc/issues/1770).
- Correctly detect optional parameters in JavaScript projects using JSDoc, [#1804](https://togithub.com/TypeStrong/TypeDoc/issues/1804).
- Fixed identical anchor links for reflections with the same name, [#1845](https://togithub.com/TypeStrong/TypeDoc/issues/1845).
- TypeDoc will now automatically inherit documentation from classes `implements` by other interfaces/classes.
- Fixed `@inheritDoc` on accessors, [#1927](https://togithub.com/TypeStrong/TypeDoc/issues/1927).
- JS exports defined as `exports.foo = ...` will now be converted as variables rather than properties.
- `searchCategoryBoosts` are now correctly computed for all categories, [#1960](https://togithub.com/TypeStrong/TypeDoc/issues/1960).
- The `excludeNotDocumented` option will no longer hide a module if it has a documentation comment, [#1948](https://togithub.com/TypeStrong/TypeDoc/issues/1948).
- Prevent `--excludeNotDocumented` from hiding properties of type literals (`a` in `function fn(p: { a: string })`), [#1752](https://togithub.com/TypeStrong/TypeDoc/issues/1752).
- Allow `cts` and `mts` extensions in packages resolution mode, [#1952](https://togithub.com/TypeStrong/TypeDoc/issues/1952).
- Corrected schema generation for https://typedoc.org/schema.json
##### Thanks!
- [@aqumus](https://togithub.com/aqumus)
- [@fb55](https://togithub.com/fb55)
- [@futurGH](https://togithub.com/futurGH)
- [@Shane4368](https://togithub.com/Shane4368)
- [@shmax](https://togithub.com/shmax)
#### v0.22.18 (2022-06-25)
##### Features
- Relaxed restrictions on `@enum` style enums to also permit non-literal strings and numbers, [#1956](https://togithub.com/TypeStrong/TypeDoc/issues/1956).
##### Bug Fixes
- `searchGroupBoosts` was only computing the boost for the first reflection in a group, [#1958](https://togithub.com/TypeStrong/TypeDoc/issues/1958).
##### Thanks!
- [@shmax](https://togithub.com/shmax)
- [@Zamiell](https://togithub.com/Zamiell)
#### v0.22.17 (2022-06-01)
##### Features
- Added support for documenting a module's global declarations as its exports if it contains no real exports.
##### Bug Fixes
- Restore support for TS 4.0 through 4.5, [#1945](https://togithub.com/TypeStrong/TypeDoc/issues/1945).
#### v0.22.16 (2022-05-30)
##### Features
- Added support for TypeScript 4.7, [#1935](https://togithub.com/TypeStrong/TypeDoc/issues/1935).
- Support enum-like objects with numeric literal values tagged with `@enum`, [#1918](https://togithub.com/TypeStrong/TypeDoc/issues/1918).
- Enum member reflections will now have their `type` set to either a `LiteralType` with a string or numeric value or an `IntrinsicType` with type `number`, [#1942](https://togithub.com/TypeStrong/TypeDoc/issues/1942).
Using `defaultValue` on `EnumMember` reflections is now deprecated, and will be broken in 0.23.
##### Bug Fixes
- Fixed invalid type output in some uncommon edge cases, TypeDoc also now renders fewer superfluous parenthesis when creating types.
- TypeDoc is now more consistent about ordering with `enum-value-ascending` or `enum-value-descending` sort strategies in mixed string/number enums.
##### Thanks!
- [@ejuda](https://togithub.com/ejuda)
- [@Zamiell](https://togithub.com/Zamiell)
#### v0.22.15 (2022-04-10)
##### Features
- Classes which are `abstract` and enums which are `const` will now be indicated in their rendered documentation, [#1874](https://togithub.com/TypeStrong/TypeDoc/issues/1874).
- Added a new option `compilerOptions`, which can be used to override compiler options read from `tsconfig.json`, [#1891](https://togithub.com/TypeStrong/TypeDoc/issues/1891).
- Added new render hooks: `content.begin`, `content.end`, `navigation.begin`, `navigation.end`
##### Bug Fixes
- TypeDoc will now warn if a project name/version cannot be inferred from a package.json file rather than using `undefined`, [#1907](https://togithub.com/TypeStrong/TypeDoc/issues/1907).
##### Thanks!
- [@ejuda](https://togithub.com/ejuda)
- [@matteobruni](https://togithub.com/matteobruni)
- [@schlusslicht](https://togithub.com/schlusslicht)
#### v0.22.14 (2022-04-07)
##### Bug Fixes
- Fixed missing comments on `@enum` style enum members defined in declaration files, [#1880](https://togithub.com/TypeStrong/TypeDoc/issues/1880).
- Fixed `--validation.notDocumented` warnings for functions/methods/type aliases, [#1895](https://togithub.com/TypeStrong/TypeDoc/issues/1895), [#1898](https://togithub.com/TypeStrong/TypeDoc/issues/1898).
- Search results will no longer include random items when the search bar is empty, [#1881](https://togithub.com/TypeStrong/TypeDoc/issues/1881).
- Comments on overloaded constructors will now be detected in the same way that overloaded functions/methods are.
- Fixed `removeReflection` not completely removing reflections from the project, [#1898](https://togithub.com/TypeStrong/TypeDoc/issues/1898).
- Fixed `@hidden` / `@ignore` / `@exclude` comments on default exports with no associated variable, [#1903](https://togithub.com/TypeStrong/TypeDoc/issues/1903).
- `makeRecursiveVisitor` will now correctly call the `intersection` callback, [#1910](https://togithub.com/TypeStrong/TypeDoc/issues/1910).
##### Thanks!
- [@nlepage](https://togithub.com/nlepage)
- [@ychan167](https://togithub.com/ychan167)
#### v0.22.13 (2022-03-06)
##### Features
- Add support for TypeScript 4.6, [#1877](https://togithub.com/TypeStrong/TypeDoc/issues/1877).
- Support copying `@param` comments for nested members that target union and intersection types, [#1876](https://togithub.com/TypeStrong/TypeDoc/issues/1876).
##### Bug Fixes
- Fixed validation for `--requiredToBeDocumented` option, [#1872](https://togithub.com/TypeStrong/TypeDoc/issues/1872).
- Fixed missing `this` parameters in documentation for some functions, [#1875](https://togithub.com/TypeStrong/TypeDoc/issues/1875).
#### v0.22.12 (2022-02-20)
##### Features
- Added `--validation.notDocumented` option to warn on items that are not documented, [#1817](https://togithub.com/TypeStrong/TypeDoc/issues/1817).
##### Bug Fixes
- Fixed `const` variables not properly marked as `const`, [#1866](https://togithub.com/TypeStrong/TypeDoc/issues/1866).
##### Thanks!
- [@albyrock87](https://togithub.com/albyrock87)
- [@Nokel81](https://togithub.com/Nokel81)
#### v0.22.11 (2022-01-18)
##### Features
- Added new `cname` option for GitHub Pages custom domain support, [#1803](https://togithub.com/TypeStrong/TypeDoc/issues/1803).
- `ReferenceType`s which reference an external symbol will now include `qualifiedName` and `package` in their serialized JSON.
- Added clickable anchor link for member titles, [#1842](https://togithub.com/TypeStrong/TypeDoc/issues/1842).
##### Bug Fixes
- Fixed line height of `h1` and `h2` elements being too low, [#1796](https://togithub.com/TypeStrong/TypeDoc/issues/1796).
- Code blocks in the light theme will no longer have the same background as the rest of the page, [#1836](https://togithub.com/TypeStrong/TypeDoc/issues/1836).
- Symbol names passed to `addUnknownSymbolResolver` will now be correctly given the qualified name to the symbol being referenced, [#1832](https://togithub.com/TypeStrong/TypeDoc/issues/1832).
- The search index will now be written as JSON, reducing load times for large projects, [#1825](https://togithub.com/TypeStrong/TypeDoc/issues/1825).
##### Thanks!
- [@adeniszczyc](https://togithub.com/adeniszczyc)
- [@dragomirtitian](https://togithub.com/dragomirtitian)
- [@matteobruni](https://togithub.com/matteobruni)
- [@srmagura](https://togithub.com/srmagura)
- [@stefanobaghino-da](https://togithub.com/stefanobaghino-da)
#### v0.22.10 (2021-11-25)
##### Features
- Added support for TypeScript 4.5, [#1798](https://togithub.com/TypeStrong/TypeDoc/issues/1798).
##### Bug Fixes
- If file exports a symbol both under it's real name and as `default`, the `default` export will now always be the renamed symbol, [#1795](https://togithub.com/TypeStrong/TypeDoc/issues/1795).
- TypeDoc will no longer crash if a symbol is defined both as a normal class (and optional interface) and as a property, as is used for global Node types in older `@types/node` versions, [Gerrit0/typedoc-plugin-missing-exports#5](https://togithub.com/Gerrit0/typedoc-plugin-missing-exports/issues/5).
#### v0.22.9 (2021-11-14)
##### Features
- TypeDoc will now detect and warn if multiple instances of the package are loaded. This usually means that a plugin has its own version of TypeDoc installed, which will lead to things breaking in unexpected ways.
It will only work if both loaded TypeDocs are v0.22.9 or later.
- TypeDoc will now automatically load packages with `typedoc-theme` in 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
- Corrected HTML generation for projects using Google Analytics, [#1786](https://togithub.com/TypeStrong/TypeDoc/issues/1786).
- Ensured that the `` appears within the first 1024 bytes of generated pages, [#1783](https://togithub.com/TypeStrong/TypeDoc/issues/1783).
##### Thanks!
- [@RunDevelopment](https://togithub.com/RunDevelopment)
#### v0.22.8 (2021-11-07)
##### Features
- Added hooks which can be used to inject HTML without completely replacing a template, [#1773](https://togithub.com/TypeStrong/TypeDoc/issues/1773).
See the documentation in [custom-themes.md](https://togithub.com/TypeStrong/typedoc/blob/master/internal-docs/custom-themes.md) for details.
##### Bug Fixes
- Actually fixed `@category` tag incorrectly appearing on function types if used on a type alias, [#1745](https://togithub.com/TypeStrong/TypeDoc/issues/1745).
- Fix error in console when a page contains no documentation items.
##### Thanks!
- [@RunDevelopment](https://togithub.com/RunDevelopment)
- [@srmagura](https://togithub.com/srmagura)
#### v0.22.7 (2021-10-25)
##### Features
- Added support for GitHub enterprise projects with a `githubprivate.com` domain, [#1743](https://togithub.com/TypeStrong/TypeDoc/issues/1743).
- Added support for GitLab repositories, [#1728](https://togithub.com/TypeStrong/TypeDoc/issues/1728).
##### Bug Fixes
- Replaced O(n^2) with O(1) implementation for determining unique IDs in a rendered page, [#1755](https://togithub.com/TypeStrong/TypeDoc/issues/1755).
- Fixed crash with when running in very large repositories, [#1744](https://togithub.com/TypeStrong/TypeDoc/issues/1744).
- Fixed visible gap after footer in dark mode if `hideGenerator` is set, [#1749](https://togithub.com/TypeStrong/TypeDoc/issues/1749).
- Fixed `@category` tag incorrectly appearing on function types if used on a type alias, [#1745](https://togithub.com/TypeStrong/TypeDoc/issues/1745).
- Fixed incorrect JS to apply themes on page load, [#1709](https://togithub.com/TypeStrong/TypeDoc/issues/1709) (again).
- Accessors and index signatures are now properly marked as inherited on declaration creation, [#1742](https://togithub.com/TypeStrong/TypeDoc/issues/1742).
##### Thanks!
- [@nlfurniss](https://togithub.com/nlfurniss)
- [@RunDevelopment](https://togithub.com/RunDevelopment)
- [@srmagura](https://togithub.com/srmagura)
#### v0.22.6 (2021-10-17)
##### Features
- Added support for displaying identifiers & property access expressions in initializers, [#1730](https://togithub.com/TypeStrong/TypeDoc/issues/1730).
- Expanded support for variables tagged with `@enum` to all variables whose property types are string literals, [#1740](https://togithub.com/TypeStrong/TypeDoc/issues/1740).
##### Bug Fixes
- Fixed flash when navigating to a second page when OS theme does not match selected theme, [#1709](https://togithub.com/TypeStrong/TypeDoc/issues/1709).
- Fixed improper quoting of `as const` style enums, [#1727](https://togithub.com/TypeStrong/TypeDoc/issues/1727).
- Fixed handling of `@typeParam` on type aliases, [#1733](https://togithub.com/TypeStrong/TypeDoc/issues/1733).
- Fixed handling of comment tags on function type aliases, [#1734](https://togithub.com/TypeStrong/TypeDoc/issues/1734).
- Paths in warnings about non-exported symbols are now consistently displayed across platforms, [#1738](https://togithub.com/TypeStrong/TypeDoc/issues/1738).
##### Thanks!
- [@capraynor](https://togithub.com/capraynor)
- [@srmagura](https://togithub.com/srmagura)
#### v0.22.5 (2021-10-02)
##### Features
- TypeDoc will now recognize `@param` comments for destructured parameters and rename `__namedParameters` to the name specified
in the `@param` comment if the number of `@param` comments match the number of parameters, resolves [#1703](https://togithub.com/TypeStrong/TypeDoc/issues/1703).
- The `intentionallyNotExported` option may now include file names/paths to limit its scope, for example, the following
will suppress warnings from `Foo` in `src/foo.ts` not being exported, but will not suppress warnings if another `Foo`
declared in `src/utils/foo.ts` is not exported.
```json
{
"intentionallyNotExported": ["src/foo.ts:Foo"]
}
```
- The `--emit` option can now be used to more finely control what TypeDoc will emit.
| Value | Behavior |
| --- | --- |
| `both` | Emit both documentation and JS. |
| `docs` | Emit documentation, but not JS (default). |
| `none` | Emit nothing, just convert and run validation. |
| `true` | Alias for `both`, for backwards compatibility. Will be removed in 0.23. |
| `false` | Alias for `docs`, for backwards compatibility. Will be removed in 0.23. |
##### Bug Fixes
- TypeDoc will now only create one highlighter for rendering code, saving ~200-500ms for rendering time.
- For compatibility with JSDoc, TypeDoc will now strip `
` elements from `@example` tags, resolves [#1679](https://togithub.com/TypeStrong/TypeDoc/issues/1679).
- TypeScript's `emitDeclarationOnly` compiler option is now supported, resolves [#1716](https://togithub.com/TypeStrong/TypeDoc/issues/1716).
- Fixed discovery of tsconfig.json when the provided path ends in `.json`, resolves [#1712](https://togithub.com/TypeStrong/TypeDoc/issues/1712).
- Fixed a crash when converting the `globalThis` namespace, could only be caused by a plugin.
##### Thanks!
- [@Gudahtt](https://togithub.com/Gudahtt)
- [@mgred](https://togithub.com/mgred)
- [@schlusslicht](https://togithub.com/schlusslicht)
- [@srmagura](https://togithub.com/srmagura)
#### v0.22.4 (2021-09-18)
##### Features
- Flag option types like `validation` can now be set to true/false to enable/disable all flags within them.
- Source code links now work with Bitbucket repositories, resolves [#1615](https://togithub.com/TypeStrong/TypeDoc/issues/1615).
- Added `githubPages` option (default: true), which will create a `.nojekyll` page in the generated output, resolves [#1680](https://togithub.com/TypeStrong/TypeDoc/issues/1680).
- `MarkdownEvent` is now exported, resolves [#1696](https://togithub.com/TypeStrong/TypeDoc/issues/1696).
##### Bug Fixes
- Fixed the hamburger menu not being visible on mobile devices, fixes [#1699](https://togithub.com/TypeStrong/TypeDoc/issues/1699).
- Comments on function implementations with overloaded signatures will now be correctly handled, fixes [#1697](https://togithub.com/TypeStrong/TypeDoc/issues/1697).
##### Thanks!
- [@srmagura](https://togithub.com/srmagura)
#### v0.22.3 (2021-09-12)
##### Bug Fixes
- Switched the default highlighting themes back to `light-plus` and `dark-plus`, they were accidentally set to `min-light` and `min-dark` in v0.22.0.
##### Features
- Added new `validation` option 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:
```json
{
"validation": {
"notExported": true
}
}
```
- Added invalidLink to `validation` option, deprecated `listInvalidSymbolLinks`, which will be removed in 0.23.
#### v0.22.2 (2021-09-11)
##### Bug Fixes
- Fix background color of tables in dark mode, closes [#1684](https://togithub.com/TypeStrong/TypeDoc/issues/1684).
#### v0.22.1 (2021-09-10)
##### Bug Fixes
- Validation for non-exported symbols will now only produce one warning per symbol, instead of one warning per reference.
- Syntax highlighting when the preferred color scheme is dark but dark theme is not explicitly selected will now properly use the dark highlighting theme.
### [`v0.22.18`](https://togithub.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v02218-2022-06-25)
[Compare Source](https://togithub.com/TypeStrong/TypeDoc/compare/v0.22.17...v0.22.18)
##### Features
- Relaxed restrictions on `@enum` style enums to also permit non-literal strings and numbers, [#1956](https://togithub.com/TypeStrong/TypeDoc/issues/1956).
##### Bug Fixes
- `searchGroupBoosts` was only computing the boost for the first reflection in a group, [#1958](https://togithub.com/TypeStrong/TypeDoc/issues/1958).
##### Thanks!
- [@shmax](https://togithub.com/shmax)
- [@Zamiell](https://togithub.com/Zamiell)
Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Enabled.
♻ 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.
[ ] If you want to rebase/retry this PR, click this checkbox.
This PR has been generated by Mend Renovate. View repository job log here.
This PR contains the following updates:
^0.22.0->^0.23.0Release Notes
TypeStrong/TypeDoc
### [`v0.23.1`](https://togithub.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0231-2022-06-26) [Compare Source](https://togithub.com/TypeStrong/TypeDoc/compare/v0.23.0...v0.23.1) ##### Bug Fixes - If a declaration has multiple comments associated with it, the last one should be used, [#1961](https://togithub.com/TypeStrong/TypeDoc/issues/1961). ### [`v0.23.0`](https://togithub.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0230-2022-06-26) [Compare Source](https://togithub.com/TypeStrong/TypeDoc/compare/v0.22.18...v0.23.0) ##### Breaking Changes - Node 12 is no longer officially supported as it has gone end of life as of 2022-04-30. It might still work, but may stop working at any time. - Dropped support for TypeScript before 4.6. - `{@link}` tags in comments will now be resolved as declaration references similar to TSDoc's declaration references. For most cases, this will just work. See [the documentation](https://typedoc.org/guides/link-resolution/) for details on how link resolution works. - TypeDoc will now produce warnings for bracketed links (`[[ target ]]`). Use `{@link target}` instead. The `{@link}` syntax will be recognized by [TypeScript 4.3](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-4-3.html#editor-support-for-link-tags) and later and used to provide better intellisense. TypeDoc version 0.24.0 will remove support for `[[ target ]]` style links. - `extends` in typedoc.json is now resolved using NodeJS module resolution, so a local path must begin with `./`. - In the JSON output for `DeclarationReflection`s, `getSignature` is no longer a one-tuple. - In the JSON output for `DeclarationReflection`s, `setSignature` is no longer a one-tuple. - In the JSON output for `DeclarationReflection`s, `typeParameter` has been renamed to `typeParameters` - The `searchGroupBoosts` option must now be given the rendered group name rather than reflection kind names, and can be given custom group names. - `@inheritDoc` now follows the behavior specified by TSDoc when copying comments with a reference. - The `gaSite` option has been removed since Google Analytics now infers the site automatically, updated Google Analytics script to latest version, [#1846](https://togithub.com/TypeStrong/TypeDoc/issues/1846). - Comments on export declarations will only overrides comments for references and namespaces, [#1901](https://togithub.com/TypeStrong/TypeDoc/issues/1901). - The deprecated `listInvalidSymbolLinks` option has been removed. Use `validation.invalidLink` instead. - The deprecated `true` and `false` values have been removed from `--emit`, to migrate replace `true` with `"both"` and `false` with `"docs"` (the default). - Links are no longer be resolved against a global list of all symbols. See [the documentation](https://typedoc.org/guides/link-resolution/) for details on link resolution. - The `validation.invalidLink` option is now on by default. - `reflection.decorates`, `reflection.decorators`, and their corresponding interfaces have been removed as no code in TypeDoc used them. - The shape of the `Comment` class has changed significantly to support multiple tag kinds. - Listeners to `Converter.EVENT_CREATE_TYPE_PARAMETER` and `Converter.EVENT_CREATE_DECLARATION` will now never be passed a `ts.Node` as their third argument. - Constant variables which are interpreted as functions will no longer have the `ReflectionFlag.Const` flag set. - `reflection.defaultValue` is no longer set for enum members. The same information is available on `reflection.type` with more precision. - Removed deprecated `removeReaderByName`, `addDeclarations` and `removeDeclarationByName` methods on `Options`. - Removed `ProjectReflection.directory`, it was unused by TypeDoc and not properly tested. - Removed `ProjectReflection.files`, this was an internal cache that should not have been exposed, and shouldn't have existed in the first place, since removing it made TypeDoc faster. - Removed `ReflectionGroup.kind` since groups can now be created with the `@group` tag. - Removed `ReflectionKind.Event`, the `@event` tag is now an alias for `@group Events`. Note: This changes the value of `ReflectionKind.Reference` from `16777216` to `8388608`. - Themes are now set on the document element rather than on body, [#1706](https://togithub.com/TypeStrong/TypeDoc/issues/1706). ##### Features - TypeDoc now supports the `@group` tag to group reflections in a page. If no `@group` tag is specified, reflections will be grouped according to their kind, [#1652](https://togithub.com/TypeStrong/TypeDoc/issues/1652). - TypeDoc will now search for `typedoc.js(on)` in the `.config` folder in the current working directory. - Entry point strategies `Resolve` and `Expand` may now specify globs, [#1926](https://togithub.com/TypeStrong/TypeDoc/issues/1926). - `typedoc.json` now supports comments like `tsconfig.json`. - TypeDoc will now read the `blockTags`, `inlineTags`, and `modifierTags` out of `tsdoc.json` in the same directory as `tsconfig.json` if it exists. It is recommended to add `"extends": ["typedoc/tsdoc.json"]`, which defines TypeDoc specific tags to your `tsdoc.json` if you create one. - If an exported symbol has multiple declarations, TypeDoc will now check all appropriate declarations for comments, and warn if more than one declaration contains a comment, [#1855](https://togithub.com/TypeStrong/TypeDoc/issues/1855). - Improved support for JSDoc style `@example` tags. If the tag content does not include a code block, TypeDoc now follows VSCode's behavior of treating the entire block as a code block, [#135](https://togithub.com/TypeStrong/TypeDoc/issues/135). - TypeDoc will now render members marked with `@deprecated` with a line through their name, [#1381](https://togithub.com/TypeStrong/TypeDoc/issues/1381). - Added new `commentStyle` option which can be used to control what comments TypeDoc will parse. | Value | Behavior | | ----- | -------------------------------------- | | JSDoc | Use block comments starting with `/**` | | Block | Use all block comments | | Line | Use `//` comments | | All | Use both block and line comments | - TypeDoc will now warn if part of a comment will be overwritten due to use of `@inheritDoc` instead of silently dropping part of the comment. - Added support for inline `@inheritDoc` tags, [#1480](https://togithub.com/TypeStrong/TypeDoc/issues/1480). - It is now possible to link directly to a specific overload, [#1326](https://togithub.com/TypeStrong/TypeDoc/issues/1326). - The JSON output will now include URLs to the file on the remote repository if possible. - Added a new `visibilityFilters` option which controls the available filters on a page. - TypeDoc will now try to place block elements on a new line in HTML output, resulting in less overwhelming diffs when rebuilding docs, [#1923](https://togithub.com/TypeStrong/TypeDoc/issues/1923). - Added `blockTags`, `inlineTags`, `modifierTags` to control which tags TypeDoc will allow when parsing comments. If a tag not in in one of these options is encountered, TypeDoc will produce a warning and use context clues to determine how to parse the tag. ##### Bug Fixes - Fixed off by one error in warnings for types referenced but not included in the documentation. - TypeDoc will no longer render a `Type Parameters` heading if there are no type parameters in some cases. - Improved source location detection for constructors. - Improved comment discovery on destructured exported functions, [#1770](https://togithub.com/TypeStrong/TypeDoc/issues/1770). - Links which refer to members within a reference reflection will now correctly resolve to the referenced reflection's member, [#1770](https://togithub.com/TypeStrong/TypeDoc/issues/1770). - Correctly detect optional parameters in JavaScript projects using JSDoc, [#1804](https://togithub.com/TypeStrong/TypeDoc/issues/1804). - Fixed identical anchor links for reflections with the same name, [#1845](https://togithub.com/TypeStrong/TypeDoc/issues/1845). - TypeDoc will now automatically inherit documentation from classes `implements` by other interfaces/classes. - Fixed `@inheritDoc` on accessors, [#1927](https://togithub.com/TypeStrong/TypeDoc/issues/1927). - JS exports defined as `exports.foo = ...` will now be converted as variables rather than properties. - `searchCategoryBoosts` are now correctly computed for all categories, [#1960](https://togithub.com/TypeStrong/TypeDoc/issues/1960). - The `excludeNotDocumented` option will no longer hide a module if it has a documentation comment, [#1948](https://togithub.com/TypeStrong/TypeDoc/issues/1948). - Prevent `--excludeNotDocumented` from hiding properties of type literals (`a` in `function fn(p: { a: string })`), [#1752](https://togithub.com/TypeStrong/TypeDoc/issues/1752). - Allow `cts` and `mts` extensions in packages resolution mode, [#1952](https://togithub.com/TypeStrong/TypeDoc/issues/1952). - Corrected schema generation for https://typedoc.org/schema.json ##### Thanks! - [@aqumus](https://togithub.com/aqumus) - [@fb55](https://togithub.com/fb55) - [@futurGH](https://togithub.com/futurGH) - [@Shane4368](https://togithub.com/Shane4368) - [@shmax](https://togithub.com/shmax) #### v0.22.18 (2022-06-25) ##### Features - Relaxed restrictions on `@enum` style enums to also permit non-literal strings and numbers, [#1956](https://togithub.com/TypeStrong/TypeDoc/issues/1956). ##### Bug Fixes - `searchGroupBoosts` was only computing the boost for the first reflection in a group, [#1958](https://togithub.com/TypeStrong/TypeDoc/issues/1958). ##### Thanks! - [@shmax](https://togithub.com/shmax) - [@Zamiell](https://togithub.com/Zamiell) #### v0.22.17 (2022-06-01) ##### Features - Added support for documenting a module's global declarations as its exports if it contains no real exports. ##### Bug Fixes - Restore support for TS 4.0 through 4.5, [#1945](https://togithub.com/TypeStrong/TypeDoc/issues/1945). #### v0.22.16 (2022-05-30) ##### Features - Added support for TypeScript 4.7, [#1935](https://togithub.com/TypeStrong/TypeDoc/issues/1935). - Support enum-like objects with numeric literal values tagged with `@enum`, [#1918](https://togithub.com/TypeStrong/TypeDoc/issues/1918). - Enum member reflections will now have their `type` set to either a `LiteralType` with a string or numeric value or an `IntrinsicType` with type `number`, [#1942](https://togithub.com/TypeStrong/TypeDoc/issues/1942). Using `defaultValue` on `EnumMember` reflections is now deprecated, and will be broken in 0.23. ##### Bug Fixes - Fixed invalid type output in some uncommon edge cases, TypeDoc also now renders fewer superfluous parenthesis when creating types. - TypeDoc is now more consistent about ordering with `enum-value-ascending` or `enum-value-descending` sort strategies in mixed string/number enums. ##### Thanks! - [@ejuda](https://togithub.com/ejuda) - [@Zamiell](https://togithub.com/Zamiell) #### v0.22.15 (2022-04-10) ##### Features - Classes which are `abstract` and enums which are `const` will now be indicated in their rendered documentation, [#1874](https://togithub.com/TypeStrong/TypeDoc/issues/1874). - Added a new option `compilerOptions`, which can be used to override compiler options read from `tsconfig.json`, [#1891](https://togithub.com/TypeStrong/TypeDoc/issues/1891). - Added new render hooks: `content.begin`, `content.end`, `navigation.begin`, `navigation.end` ##### Bug Fixes - TypeDoc will now warn if a project name/version cannot be inferred from a package.json file rather than using `undefined`, [#1907](https://togithub.com/TypeStrong/TypeDoc/issues/1907). ##### Thanks! - [@ejuda](https://togithub.com/ejuda) - [@matteobruni](https://togithub.com/matteobruni) - [@schlusslicht](https://togithub.com/schlusslicht) #### v0.22.14 (2022-04-07) ##### Bug Fixes - Fixed missing comments on `@enum` style enum members defined in declaration files, [#1880](https://togithub.com/TypeStrong/TypeDoc/issues/1880). - Fixed `--validation.notDocumented` warnings for functions/methods/type aliases, [#1895](https://togithub.com/TypeStrong/TypeDoc/issues/1895), [#1898](https://togithub.com/TypeStrong/TypeDoc/issues/1898). - Search results will no longer include random items when the search bar is empty, [#1881](https://togithub.com/TypeStrong/TypeDoc/issues/1881). - Comments on overloaded constructors will now be detected in the same way that overloaded functions/methods are. - Fixed `removeReflection` not completely removing reflections from the project, [#1898](https://togithub.com/TypeStrong/TypeDoc/issues/1898). - Fixed `@hidden` / `@ignore` / `@exclude` comments on default exports with no associated variable, [#1903](https://togithub.com/TypeStrong/TypeDoc/issues/1903). - `makeRecursiveVisitor` will now correctly call the `intersection` callback, [#1910](https://togithub.com/TypeStrong/TypeDoc/issues/1910). ##### Thanks! - [@nlepage](https://togithub.com/nlepage) - [@ychan167](https://togithub.com/ychan167) #### v0.22.13 (2022-03-06) ##### Features - Add support for TypeScript 4.6, [#1877](https://togithub.com/TypeStrong/TypeDoc/issues/1877). - Support copying `@param` comments for nested members that target union and intersection types, [#1876](https://togithub.com/TypeStrong/TypeDoc/issues/1876). ##### Bug Fixes - Fixed validation for `--requiredToBeDocumented` option, [#1872](https://togithub.com/TypeStrong/TypeDoc/issues/1872). - Fixed missing `this` parameters in documentation for some functions, [#1875](https://togithub.com/TypeStrong/TypeDoc/issues/1875). #### v0.22.12 (2022-02-20) ##### Features - Added `--validation.notDocumented` option to warn on items that are not documented, [#1817](https://togithub.com/TypeStrong/TypeDoc/issues/1817). ##### Bug Fixes - Fixed `const` variables not properly marked as `const`, [#1866](https://togithub.com/TypeStrong/TypeDoc/issues/1866). ##### Thanks! - [@albyrock87](https://togithub.com/albyrock87) - [@Nokel81](https://togithub.com/Nokel81) #### v0.22.11 (2022-01-18) ##### Features - Added new `cname` option for GitHub Pages custom domain support, [#1803](https://togithub.com/TypeStrong/TypeDoc/issues/1803). - `ReferenceType`s which reference an external symbol will now include `qualifiedName` and `package` in their serialized JSON. - Added clickable anchor link for member titles, [#1842](https://togithub.com/TypeStrong/TypeDoc/issues/1842). ##### Bug Fixes - Fixed line height of `h1` and `h2` elements being too low, [#1796](https://togithub.com/TypeStrong/TypeDoc/issues/1796). - Code blocks in the light theme will no longer have the same background as the rest of the page, [#1836](https://togithub.com/TypeStrong/TypeDoc/issues/1836). - Symbol names passed to `addUnknownSymbolResolver` will now be correctly given the qualified name to the symbol being referenced, [#1832](https://togithub.com/TypeStrong/TypeDoc/issues/1832). - The search index will now be written as JSON, reducing load times for large projects, [#1825](https://togithub.com/TypeStrong/TypeDoc/issues/1825). ##### Thanks! - [@adeniszczyc](https://togithub.com/adeniszczyc) - [@dragomirtitian](https://togithub.com/dragomirtitian) - [@matteobruni](https://togithub.com/matteobruni) - [@srmagura](https://togithub.com/srmagura) - [@stefanobaghino-da](https://togithub.com/stefanobaghino-da) #### v0.22.10 (2021-11-25) ##### Features - Added support for TypeScript 4.5, [#1798](https://togithub.com/TypeStrong/TypeDoc/issues/1798). ##### Bug Fixes - If file exports a symbol both under it's real name and as `default`, the `default` export will now always be the renamed symbol, [#1795](https://togithub.com/TypeStrong/TypeDoc/issues/1795). - TypeDoc will no longer crash if a symbol is defined both as a normal class (and optional interface) and as a property, as is used for global Node types in older `@types/node` versions, [Gerrit0/typedoc-plugin-missing-exports#5](https://togithub.com/Gerrit0/typedoc-plugin-missing-exports/issues/5). #### v0.22.9 (2021-11-14) ##### Features - TypeDoc will now detect and warn if multiple instances of the package are loaded. This usually means that a plugin has its own version of TypeDoc installed, which will lead to things breaking in unexpected ways. It will only work if both loaded TypeDocs are v0.22.9 or later. - TypeDoc will now automatically load packages with `typedoc-theme` in 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 - Corrected HTML generation for projects using Google Analytics, [#1786](https://togithub.com/TypeStrong/TypeDoc/issues/1786). - Ensured that the `` appears within the first 1024 bytes of generated pages, [#1783](https://togithub.com/TypeStrong/TypeDoc/issues/1783). ##### Thanks! - [@RunDevelopment](https://togithub.com/RunDevelopment) #### v0.22.8 (2021-11-07) ##### Features - Added hooks which can be used to inject HTML without completely replacing a template, [#1773](https://togithub.com/TypeStrong/TypeDoc/issues/1773). See the documentation in [custom-themes.md](https://togithub.com/TypeStrong/typedoc/blob/master/internal-docs/custom-themes.md) for details. ##### Bug Fixes - Actually fixed `@category` tag incorrectly appearing on function types if used on a type alias, [#1745](https://togithub.com/TypeStrong/TypeDoc/issues/1745). - Fix error in console when a page contains no documentation items. ##### Thanks! - [@RunDevelopment](https://togithub.com/RunDevelopment) - [@srmagura](https://togithub.com/srmagura) #### v0.22.7 (2021-10-25) ##### Features - Added support for GitHub enterprise projects with a `githubprivate.com` domain, [#1743](https://togithub.com/TypeStrong/TypeDoc/issues/1743). - Added support for GitLab repositories, [#1728](https://togithub.com/TypeStrong/TypeDoc/issues/1728). ##### Bug Fixes - Replaced O(n^2) with O(1) implementation for determining unique IDs in a rendered page, [#1755](https://togithub.com/TypeStrong/TypeDoc/issues/1755). - Fixed crash with when running in very large repositories, [#1744](https://togithub.com/TypeStrong/TypeDoc/issues/1744). - Fixed visible gap after footer in dark mode if `hideGenerator` is set, [#1749](https://togithub.com/TypeStrong/TypeDoc/issues/1749). - Fixed `@category` tag incorrectly appearing on function types if used on a type alias, [#1745](https://togithub.com/TypeStrong/TypeDoc/issues/1745). - Fixed incorrect JS to apply themes on page load, [#1709](https://togithub.com/TypeStrong/TypeDoc/issues/1709) (again). - Accessors and index signatures are now properly marked as inherited on declaration creation, [#1742](https://togithub.com/TypeStrong/TypeDoc/issues/1742). ##### Thanks! - [@nlfurniss](https://togithub.com/nlfurniss) - [@RunDevelopment](https://togithub.com/RunDevelopment) - [@srmagura](https://togithub.com/srmagura) #### v0.22.6 (2021-10-17) ##### Features - Added support for displaying identifiers & property access expressions in initializers, [#1730](https://togithub.com/TypeStrong/TypeDoc/issues/1730). - Expanded support for variables tagged with `@enum` to all variables whose property types are string literals, [#1740](https://togithub.com/TypeStrong/TypeDoc/issues/1740). ##### Bug Fixes - Fixed flash when navigating to a second page when OS theme does not match selected theme, [#1709](https://togithub.com/TypeStrong/TypeDoc/issues/1709). - Fixed improper quoting of `as const` style enums, [#1727](https://togithub.com/TypeStrong/TypeDoc/issues/1727). - Fixed handling of `@typeParam` on type aliases, [#1733](https://togithub.com/TypeStrong/TypeDoc/issues/1733). - Fixed handling of comment tags on function type aliases, [#1734](https://togithub.com/TypeStrong/TypeDoc/issues/1734). - Paths in warnings about non-exported symbols are now consistently displayed across platforms, [#1738](https://togithub.com/TypeStrong/TypeDoc/issues/1738). ##### Thanks! - [@capraynor](https://togithub.com/capraynor) - [@srmagura](https://togithub.com/srmagura) #### v0.22.5 (2021-10-02) ##### Features - TypeDoc will now recognize `@param` comments for destructured parameters and rename `__namedParameters` to the name specified in the `@param` comment if the number of `@param` comments match the number of parameters, resolves [#1703](https://togithub.com/TypeStrong/TypeDoc/issues/1703). - The `intentionallyNotExported` option may now include file names/paths to limit its scope, for example, the following will suppress warnings from `Foo` in `src/foo.ts` not being exported, but will not suppress warnings if another `Foo` declared in `src/utils/foo.ts` is not exported. ```json { "intentionallyNotExported": ["src/foo.ts:Foo"] } ``` - The `--emit` option can now be used to more finely control what TypeDoc will emit. | Value | Behavior | | --- | --- | | `both` | Emit both documentation and JS. | | `docs` | Emit documentation, but not JS (default). | | `none` | Emit nothing, just convert and run validation. | | `true` | Alias for `both`, for backwards compatibility. Will be removed in 0.23. | | `false` | Alias for `docs`, for backwards compatibility. Will be removed in 0.23. | ##### Bug Fixes - TypeDoc will now only create one highlighter for rendering code, saving ~200-500ms for rendering time. - For compatibility with JSDoc, TypeDoc will now strip `Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Enabled.
♻ 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 Mend Renovate. View repository job log here.