changeset-bot[bot]
commented
2 years ago ⚠️ No Changeset found
Latest commit: 3974c46f766478fb2766b67206fd3ed4227c3de1
Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.
This PR includes no changesets
When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver typesClick here to learn what changesets are, and how to add one.
Click here if you're a maintainer who wants to add a changeset to this PR
This PR contains the following updates:
16.11.41->16.11.435.29.0->5.30.55.29.0->5.30.58.18.0->8.19.04.0.0->4.2.113.0.2->13.0.37.3.0->7.5.010.8.1->10.8.20.22.17->0.23.5^0.5.1->^0.6.1Release Notes
typescript-eslint/typescript-eslint (@typescript-eslint/eslint-plugin)
### [`v5.30.5`](https://togithub.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#5305-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5304v5305-2022-07-04) [Compare Source](https://togithub.com/typescript-eslint/typescript-eslint/compare/v5.30.4...v5.30.5) ##### Bug Fixes - **eslint-plugin:** \[consistent-indexed-object-style] fix record mode fixer for generics with a default value ([#5280](https://togithub.com/typescript-eslint/typescript-eslint/issues/5280)) ([57f032c](https://togithub.com/typescript-eslint/typescript-eslint/commit/57f032c2e6a822c049177713778d0077ee138d9a)) ### [`v5.30.4`](https://togithub.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#5304-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5303v5304-2022-07-03) [Compare Source](https://togithub.com/typescript-eslint/typescript-eslint/compare/v5.30.3...v5.30.4) **Note:** Version bump only for package [@typescript-eslint/eslint-plugin](https://togithub.com/typescript-eslint/eslint-plugin) ### [`v5.30.3`](https://togithub.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#5303-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5302v5303-2022-07-01) [Compare Source](https://togithub.com/typescript-eslint/typescript-eslint/compare/v5.30.2...v5.30.3) **Note:** Version bump only for package [@typescript-eslint/eslint-plugin](https://togithub.com/typescript-eslint/eslint-plugin) ### [`v5.30.2`](https://togithub.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#5302-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5301v5302-2022-07-01) [Compare Source](https://togithub.com/typescript-eslint/typescript-eslint/compare/v5.30.1...v5.30.2) **Note:** Version bump only for package [@typescript-eslint/eslint-plugin](https://togithub.com/typescript-eslint/eslint-plugin) ### [`v5.30.1`](https://togithub.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#5301-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5300v5301-2022-07-01) [Compare Source](https://togithub.com/typescript-eslint/typescript-eslint/compare/v5.30.0...v5.30.1) ##### Bug Fixes - **eslint-plugin:** \[no-base-to-string] add missing apostrophe to message ([#5270](https://togithub.com/typescript-eslint/typescript-eslint/issues/5270)) ([d320174](https://togithub.com/typescript-eslint/typescript-eslint/commit/58034e343a167ca7751b54d2b2a0e7d3852aabec)) ### [`v5.30.0`](https://togithub.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#5300-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5290v5300-2022-06-27) [Compare Source](https://togithub.com/typescript-eslint/typescript-eslint/compare/v5.29.0...v5.30.0) ##### Features - **eslint-plugin:** \[no-shadow] add shadowed variable location to the error message ([#5183](https://togithub.com/typescript-eslint/typescript-eslint/issues/5183)) ([8ca08e9](https://togithub.com/typescript-eslint/typescript-eslint/commit/8ca08e9f18d59b29715c667fbb7d237f6e9a96ba)) - treat `this` in `typeof this` as a `ThisExpression` ([#4382](https://togithub.com/typescript-eslint/typescript-eslint/issues/4382)) ([b04b2ce](https://togithub.com/typescript-eslint/typescript-eslint/commit/b04b2ce1ba90d94718891f2562dd210a6d7b8609))typescript-eslint/typescript-eslint (@typescript-eslint/parser)
### [`v5.30.5`](https://togithub.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/parser/CHANGELOG.md#5305-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5304v5305-2022-07-04) [Compare Source](https://togithub.com/typescript-eslint/typescript-eslint/compare/v5.30.4...v5.30.5) **Note:** Version bump only for package [@typescript-eslint/parser](https://togithub.com/typescript-eslint/parser) ### [`v5.30.4`](https://togithub.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/parser/CHANGELOG.md#5304-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5303v5304-2022-07-03) [Compare Source](https://togithub.com/typescript-eslint/typescript-eslint/compare/v5.30.3...v5.30.4) **Note:** Version bump only for package [@typescript-eslint/parser](https://togithub.com/typescript-eslint/parser) ### [`v5.30.3`](https://togithub.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/parser/CHANGELOG.md#5303-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5302v5303-2022-07-01) [Compare Source](https://togithub.com/typescript-eslint/typescript-eslint/compare/v5.30.2...v5.30.3) **Note:** Version bump only for package [@typescript-eslint/parser](https://togithub.com/typescript-eslint/parser) ### [`v5.30.2`](https://togithub.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/parser/CHANGELOG.md#5302-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5301v5302-2022-07-01) [Compare Source](https://togithub.com/typescript-eslint/typescript-eslint/compare/v5.30.1...v5.30.2) **Note:** Version bump only for package [@typescript-eslint/parser](https://togithub.com/typescript-eslint/parser) ### [`v5.30.1`](https://togithub.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/parser/CHANGELOG.md#5301-2022-07-01) [Compare Source](https://togithub.com/typescript-eslint/typescript-eslint/compare/v5.30.0...v5.30.1) **Note:** Version bump only for package [@typescript-eslint/parser](https://togithub.com/typescript-eslint/parser) ### [`v5.30.0`](https://togithub.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/parser/CHANGELOG.md#5300-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5290v5300-2022-06-27) [Compare Source](https://togithub.com/typescript-eslint/typescript-eslint/compare/v5.29.0...v5.30.0) **Note:** Version bump only for package [@typescript-eslint/parser](https://togithub.com/typescript-eslint/parser)eslint/eslint
### [`v8.19.0`](https://togithub.com/eslint/eslint/releases/tag/v8.19.0) [Compare Source](https://togithub.com/eslint/eslint/compare/v8.18.0...v8.19.0) ##### Features - [`7023628`](https://togithub.com/eslint/eslint/commit/7023628eb3af1bcc0151afab2bf617217fae51b1) feat: add importNames support for patterns in no-restricted-imports ([#16059](https://togithub.com/eslint/eslint/issues/16059)) (Brandon Scott) - [`472c368`](https://togithub.com/eslint/eslint/commit/472c3681364833f697d726abc3c33fbe2663eeb7) feat: fix handling of blockless `with` statements in indent rule ([#16068](https://togithub.com/eslint/eslint/issues/16068)) (Milos Djermanovic) ##### Bug Fixes - [`fc81848`](https://togithub.com/eslint/eslint/commit/fc81848238ee0f6ff93615875ea4b8e95dc09249) fix: throw helpful exception when rule has wrong return type ([#16075](https://togithub.com/eslint/eslint/issues/16075)) (Bryan Mishkin) ##### Documentation - [`3ae0574`](https://togithub.com/eslint/eslint/commit/3ae0574fc78c4a2b406625e4792cb2859cb9bcb1) docs: Remove duplicate rule descriptions ([#16052](https://togithub.com/eslint/eslint/issues/16052)) (Amaresh S M) - [`f50cf43`](https://togithub.com/eslint/eslint/commit/f50cf436aaa5dff1273f4753dd3fc6782f95a045) docs: Add base href to each page to fix relative URLs ([#16046](https://togithub.com/eslint/eslint/issues/16046)) (Nicholas C. Zakas) - [`ae4b449`](https://togithub.com/eslint/eslint/commit/ae4b449719d496fd611903d596341ec4c1d81c16) docs: make logo link clickable on small width screens ([#16058](https://togithub.com/eslint/eslint/issues/16058)) (Milos Djermanovic) - [`280f898`](https://togithub.com/eslint/eslint/commit/280f898bff9b809327e4c94cea3632ba95af4485) docs: use only fenced code blocks ([#16044](https://togithub.com/eslint/eslint/issues/16044)) (Milos Djermanovic) - [`f5d63b9`](https://togithub.com/eslint/eslint/commit/f5d63b9e15d9f325ef4953b683cb67133b05e9ea) docs: add listener only if element exists ([#16045](https://togithub.com/eslint/eslint/issues/16045)) (Amaresh S M) - [`8b639cc`](https://togithub.com/eslint/eslint/commit/8b639ccb2fb0f0a7d7aaee1f1fc2881a237de95d) docs: add missing migrating-to-8.0.0 in the user guide ([#16048](https://togithub.com/eslint/eslint/issues/16048)) (唯然) - [`b8e68c1`](https://togithub.com/eslint/eslint/commit/b8e68c1f7e2b8fa5c108216f74dcd3100aa33b0f) docs: Update release process ([#16036](https://togithub.com/eslint/eslint/issues/16036)) (Nicholas C. Zakas) - [`6d0cb11`](https://togithub.com/eslint/eslint/commit/6d0cb11c6d134896d8920c9bf3cc3e492f0eb8e2) docs: remove table of contents from markdown text ([#15999](https://togithub.com/eslint/eslint/issues/15999)) (Nitin Kumar) ##### Chores - [`e884933`](https://togithub.com/eslint/eslint/commit/e88493395b3be2b08e14e9b84d20d2733f78582c) chore: use `github-slugger` for markdown anchors ([#16067](https://togithub.com/eslint/eslint/issues/16067)) (Strek) - [`02e9cb0`](https://togithub.com/eslint/eslint/commit/02e9cb01e7663af3a3fd16725afc7d71e73b9eed) chore: revamp carbon ad style ([#16078](https://togithub.com/eslint/eslint/issues/16078)) (Amaresh S M) - [`b6aee95`](https://togithub.com/eslint/eslint/commit/b6aee9591ecc2e2f5738ab8bef20faac1e05b5c3) chore: remove unwanted comments from rules markdown ([#16054](https://togithub.com/eslint/eslint/issues/16054)) (Strek) - [`6840940`](https://togithub.com/eslint/eslint/commit/6840940a766d671831d5cee0e3c0e2f4e642632a) chore: correctly use .markdownlintignore in Makefile ([#16060](https://togithub.com/eslint/eslint/issues/16060)) (Bryan Mishkin) - [`48904fb`](https://togithub.com/eslint/eslint/commit/48904fb00fc5001e534034e2e513ca99f3ada35e) chore: add missing images ([#16017](https://togithub.com/eslint/eslint/issues/16017)) (Amaresh S M) - [`910f741`](https://togithub.com/eslint/eslint/commit/910f741885a18b7744d4125e98e554312bc873eb) chore: add architecture to nav ([#16039](https://togithub.com/eslint/eslint/issues/16039)) (Strek) - [`9bb24c1`](https://togithub.com/eslint/eslint/commit/9bb24c1deb7ab6743080520d11aefe9c6b8b8f2d) chore: add correct incorrect in all rules doc ([#16021](https://togithub.com/eslint/eslint/issues/16021)) (Deepshika S) - [`5a96af8`](https://togithub.com/eslint/eslint/commit/5a96af853dcbe29c9f125a63528f3fec9fc0aae8) chore: prepare versions data file ([#16035](https://togithub.com/eslint/eslint/issues/16035)) (Nicholas C. Zakas) - [`50afe6f`](https://togithub.com/eslint/eslint/commit/50afe6fe8c92a1d5d52415e149d52e1e129c3cc7) chore: Included githubactions in the dependabot config ([#15985](https://togithub.com/eslint/eslint/issues/15985)) (Naveen) - [`473411e`](https://togithub.com/eslint/eslint/commit/473411e61d46c2bbac70e9a66d434d477851d98a) chore: add deploy workflow for playground ([#16034](https://togithub.com/eslint/eslint/issues/16034)) (Milos Djermanovic) - [`a30b66c`](https://togithub.com/eslint/eslint/commit/a30b66c030bf45864784c0550276267e5a146697) chore: fix print style ([#16025](https://togithub.com/eslint/eslint/issues/16025)) (Amaresh S M) - [`f4dad59`](https://togithub.com/eslint/eslint/commit/f4dad59e5c7e966291d6f8c1456a465ae5629061) chore: add noindex meta tag ([#16016](https://togithub.com/eslint/eslint/issues/16016)) (Milos Djermanovic) - [`db387a8`](https://togithub.com/eslint/eslint/commit/db387a87b23c398ed691ba35bdf3b6aa7dcfe750) chore: fix sitemap ([#16026](https://togithub.com/eslint/eslint/issues/16026)) (Milos Djermanovic) - [`285fbc5`](https://togithub.com/eslint/eslint/commit/285fbc5e6a92c50e1195f252675b599ecd929b9d) chore: remove TOC from printable ([#16020](https://togithub.com/eslint/eslint/issues/16020)) (Strek) - [`8e84c21`](https://togithub.com/eslint/eslint/commit/8e84c2148cc2d25a7076e73233ae41bc1a000a53) chore: remove ligatures from fonts ([#16019](https://togithub.com/eslint/eslint/issues/16019)) (Strek)prettier/eslint-plugin-prettier
### [`v4.2.1`](https://togithub.com/prettier/eslint-plugin-prettier/blob/HEAD/CHANGELOG.md#421) [Compare Source](https://togithub.com/prettier/eslint-plugin-prettier/compare/v4.2.0...v4.2.1) ##### Patch Changes - [#485](https://togithub.com/prettier/eslint-plugin-prettier/pull/485) [`5736ed5`](https://togithub.com/prettier/eslint-plugin-prettier/commit/5736ed5224b06507374e21c626e8c462552cacf2) Thanks [@JounQin](https://togithub.com/JounQin)! - chore: reuse prettierRcOptions instead of resolveConfig again ### [`v4.2.0`](https://togithub.com/prettier/eslint-plugin-prettier/blob/HEAD/CHANGELOG.md#420) [Compare Source](https://togithub.com/prettier/eslint-plugin-prettier/compare/v4.1.0...v4.2.0) ##### Minor Changes - [#483](https://togithub.com/prettier/eslint-plugin-prettier/pull/483) [`7bd70b6`](https://togithub.com/prettier/eslint-plugin-prettier/commit/7bd70b65b680d360cd55aa9998804fc1e7188331) Thanks [@JounQin](https://togithub.com/JounQin)! - feat: support svelte out of box close [#472](https://togithub.com/prettier/eslint-plugin-prettier/issues/472), close [#482](https://togithub.com/prettier/eslint-plugin-prettier/issues/482) We recommend to use [`eslint-plugin-svelte`](https://togithub.com/ota-meshi/eslint-plugin-svelte) instead of [`eslint-plugin-svelte3`](https://togithub.com/sveltejs/eslint-plugin-svelte3). ### [`v4.1.0`](https://togithub.com/prettier/eslint-plugin-prettier/blob/HEAD/CHANGELOG.md#v410-2022-06-27) [Compare Source](https://togithub.com/prettier/eslint-plugin-prettier/compare/v4.0.0...v4.1.0) - feat: skip processing code blocks on specific languages like `stylelint-prettier` ([#415](https://togithub.com/prettier/eslint-plugin-prettier/issues/415)) ([52eec48](https://togithub.com/prettier/eslint-plugin-prettier/commit/52eec489cf5ec7a6d97c3edbb7dafc109e9156a4)) - build(deps): Bump minimist from 1.2.5 to 1.2.6 ([#464](https://togithub.com/prettier/eslint-plugin-prettier/issues/464)) ([42bfe88](https://togithub.com/prettier/eslint-plugin-prettier/commit/42bfe88bb748a5d433aeac6d7f17dd8bce3da58c)) - build(deps-dev): Bump graphql from 15.5.1 to 15.7.2 ([#442](https://togithub.com/prettier/eslint-plugin-prettier/issues/442)) ([0158640](https://togithub.com/prettier/eslint-plugin-prettier/commit/01586408fc27bf34e9f51f2047eecf421774074e)) - build(deps-dev): Bump [@graphql-eslint/eslint-plugin](https://togithub.com/graphql-eslint/eslint-plugin) from 2.3.0 to 2.4.0 ([#444](https://togithub.com/prettier/eslint-plugin-prettier/issues/444)) ([4bcaca2](https://togithub.com/prettier/eslint-plugin-prettier/commit/4bcaca2ee3632b832ccd9366c8d7333376263199)) - chore(CI): add tests for ESLint 8 ([#428](https://togithub.com/prettier/eslint-plugin-prettier/issues/428)) ([f3713be](https://togithub.com/prettier/eslint-plugin-prettier/commit/f3713befaec34fc35c87b71c68db626e38fe31b5)) - README.md: HTTP => HTTPS ([#443](https://togithub.com/prettier/eslint-plugin-prettier/issues/443)) ([44e1478](https://togithub.com/prettier/eslint-plugin-prettier/commit/44e14784396713e43941be8a1635143c5a0c5f4f))okonet/lint-staged
### [`v13.0.3`](https://togithub.com/okonet/lint-staged/releases/tag/v13.0.3) [Compare Source](https://togithub.com/okonet/lint-staged/compare/v13.0.2...v13.0.3) ##### Bug Fixes - correctly handle git stash when using MSYS2 ([#1178](https://togithub.com/okonet/lint-staged/issues/1178)) ([0d627a5](https://togithub.com/okonet/lint-staged/commit/0d627a52846d63cd6fc6018a8d7779ef454a99b2))pnpm/pnpm
### [`v7.5.0`](https://togithub.com/pnpm/pnpm/releases/tag/v7.5.0) [Compare Source](https://togithub.com/pnpm/pnpm/compare/v7.4.1...v7.5.0) #### Minor Changes - A new value `rolling` for option `save-workspace-protocol`. When selected, pnpm will save workspace versions using a rolling alias (e.g. `"foo": "workspace:^"`) instead of pinning the current version number (e.g. `"foo": "workspace:^1.0.0"`). Usage example, in the root of your workspace, create a `.npmrc` with the following content: save-workspace-protocol=rolling #### Patch Changes - `pnpm removeTypeStrong/ts-node
### [`v10.8.2`](https://togithub.com/TypeStrong/ts-node/releases/tag/v10.8.2) [Compare Source](https://togithub.com/TypeStrong/ts-node/compare/v10.8.1...v10.8.2) **Fixed** - Revert "Use file URL for source map paths" ([#1821](https://togithub.com/TypeStrong/ts-node/issues/1821)) [@cspotcode](https://togithub.com/cspotcode) - Fixes [#1790](https://togithub.com/TypeStrong/ts-node/issues/1790): ts-node 10.8.1 regression where `nyc` code coverage reports had incorrect paths - Fixes [#1797](https://togithub.com/TypeStrong/ts-node/issues/1797): ts-node 10.8.1 regression where breakpoints did not hit in VSCode debugging - Allow JSON imports in node 16.15 and up ([#1792](https://togithub.com/TypeStrong/ts-node/issues/1792)) [@queengooborg](https://togithub.com/queengooborg) - JSON imports were already supported in v17.5 and up - this change extends support to >=16.15.0,<17.0.0 - These version ranges match vanilla node's support for JSON imports https://github.com/TypeStrong/ts-node/milestone/15?closed=1TypeStrong/TypeDoc
### [`v0.23.5`](https://togithub.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0235-2022-07-02) [Compare Source](https://togithub.com/TypeStrong/TypeDoc/compare/v0.23.4...v0.23.5) ##### Features - The `DEBUG_SEARCH_WEIGHTS` global variable can now be set on `window` to add search scoring information in the search results. - TypeDoc's icons are now available on `DefaultThemeRenderContext.icons` for use/modification by themes. ### [`v0.23.4`](https://togithub.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0234-2022-07-02) [Compare Source](https://togithub.com/TypeStrong/TypeDoc/compare/v0.23.3...v0.23.4) ##### Bug Fixes - TypeDoc no longer ignores project references if `--entryPointStrategy Packages` is set, [#1976](https://togithub.com/TypeStrong/TypeDoc/issues/1976). - Boost computations are now done when creating the search index, resulting in a smaller `search.js` generated file. ##### Features - The `--exclude` option will now be respected by `--entryPointStrategy Packages` and can be used to exclude package directories, [#1959](https://togithub.com/TypeStrong/TypeDoc/issues/1959). - TypeDoc now emits an `IndexEvent` on the `Renderer` when preparing the search index, [#1953](https://togithub.com/TypeStrong/TypeDoc/issues/1953). - Added new `--searchInComments` option to include comment text in the search index, [#1553](https://togithub.com/TypeStrong/TypeDoc/issues/1553). Turning this option on will increase the size of your search index, potentially by an order of magnitude. ### [`v0.23.3`](https://togithub.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0233-2022-07-01) [Compare Source](https://togithub.com/TypeStrong/TypeDoc/compare/v0.23.2...v0.23.3) ##### Bug Fixes - Function properties in type space will no longer be interpreted as methods, [#1637](https://togithub.com/TypeStrong/TypeDoc/issues/1637). - TypeDoc will no longer crash if a comment contains an empty `@example` tag, [#1967](https://togithub.com/TypeStrong/TypeDoc/issues/1967). - TypeDoc will now detect attempted inheritance from accessors and inherit from the getter or setter, [#1968](https://togithub.com/TypeStrong/TypeDoc/issues/1968). - `intentionallyNotExported` will now properly respect qualified names, [#1972](https://togithub.com/TypeStrong/TypeDoc/issues/1972). - Fixed missing namespace comments on `export * as NS` declarations, [#1973](https://togithub.com/TypeStrong/TypeDoc/issues/1973). - Fixed missing comments on `export const x = () => 123` function variables, [#1973](https://togithub.com/TypeStrong/TypeDoc/issues/1973). - Exported variable functions with properties will now be converted as a function+namespace instead of a variable+namespace, [#1651](https://togithub.com/TypeStrong/TypeDoc/issues/1651). - Validation warnings caused by missing documentation will now be formatted like other warnings which reference a declaration. - TypeDoc will no longer warn if both the `get` and `set` signatures of an accessor have a comment. ##### Features - Added `--htmlLang` option to set the [`lang`](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/lang) attribute in the generated HTML. Defaults to `en`, [#1951](https://togithub.com/TypeStrong/TypeDoc/issues/1951). - Added `--basePath` option to override TypeDoc's detected root directory, [#1924](https://togithub.com/TypeStrong/TypeDoc/issues/1924). - Added support for TypeDoc specific `:getter` and `:setter` meaning keywords in declaration references. - Warnings caused by comment contents will now do a better job of including the location of the text that caused the warning. ### [`v0.23.2`](https://togithub.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0232-2022-06-28) [Compare Source](https://togithub.com/TypeStrong/TypeDoc/compare/v0.23.1...v0.23.2) ##### Bug Fixes - Module comments will no longer be inappropriately attached to signatures, [#1962](https://togithub.com/TypeStrong/TypeDoc/issues/1962). - Projects with a single entry point will now parse `@module` comments in the entry point, [#1963](https://togithub.com/TypeStrong/TypeDoc/issues/1963). - Removed duplicate "in comment" warning when parsing comments, [#1964](https://togithub.com/TypeStrong/TypeDoc/issues/1964). - Reflections with a boost of `<= 0` due to `searchCategoryBoosts` or `searchGroupBoosts` will be excluded from search. ### [`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). - The `hideLegend` option has been removed as the default theme no longer contains a legend. - 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) - [@Configuration
📅 Schedule: Branch creation - "before 12pm on Sunday" (UTC), Automerge - 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.
👻 Immortal: This PR will be recreated if closed unmerged. Get config help if that's undesired.
This PR has been generated by Mend Renovate. View repository job log here.