Skip to content

Conversation

@dependabot
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Dec 29, 2020

Bumps typedoc from 0.19.1 to 0.20.1.

Release notes

Sourced from typedoc's releases.

v0.20.1

0.20.1 (2020-12-29)

Bug Fixes

v0.20.0

0.20.0 (2020-12-28)

Migration from previous versions

Version 0.20 completely reworks how documentation is generated by TypeDoc. In previous versions, there was --mode file and --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.
  2. Removed options - mode, excludeNotExported, includeDeclarations, ignoreCompilerErrors (#1403), entryPoint
  3. inputFiles has been renamed to entryPoints to better reflect its usage
  4. Existing third party themes may be broken due to changes to the type structure
  5. The behavior of exclude has changed, it is now only used to filter entry points if a directory is provided as the entry point.

The command line for most projects now should be fairly simple:

npx typedoc src/index.ts

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 @module tag to change it:

/**
  * @packageDocumentation
  * @module myLibrary
  */

Bug Fixes

  • A few of the issues with the type converter (6ff7fcd)
  • Accessor with a set signature was converted incorrectly (1200212)
  • Array types were converted incorrectly (c892c00)
  • Categorization was broken with a single entry point (7f6e924)
  • Change target back to ES2018 (671e6d3)
  • ConstructorType node support (7ba17f6)
  • Correct handling of arrays in generic constraints (d575dc0), closes #1408
  • Declaration merged namespaces sometimes produced multiple reflections (5de3bf5)
  • Fix bug in ReferenceType equality check (3f63956), closes #1383

... (truncated)

Commits
  • b1d1c9d chore: Bump version to 0.20.1
  • 5bf4d05 fix: Initializers should only be included if "simple"
  • 79471af chore: Prettier
  • 3ac7391 chore: Add code of conduct
  • 00ae3c7 chore: Bump version to 0.20.0
  • 37d779d chore: Rebuild specs for colored links
  • 586132c chore: Fix breaks caused by Array.isArray signature changes
  • b1636c0 chore: Upgrade dependencies
  • 4ac0a75 chore: Update publish script
  • 83256d9 chore: Improve schema generation
  • Additional commits viewable in compare view

Dependabot compatibility score

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.


Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

  • @dependabot rebase will rebase this PR
  • @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
  • @dependabot merge will merge this PR after your CI passes on it
  • @dependabot squash and merge will squash and merge this PR after your CI passes on it
  • @dependabot cancel merge will cancel a previously requested merge and block automerging
  • @dependabot reopen will reopen this PR if it is closed
  • @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
  • @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

Bumps [typedoc](https://github.com/TypeStrong/TypeDoc) from 0.19.1 to 0.20.1.
- [Release notes](https://github.com/TypeStrong/TypeDoc/releases)
- [Commits](TypeStrong/typedoc@v0.19.1...v0.20.1)

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot dependabot bot added the dependencies Pull requests that update a dependency file label Dec 29, 2020
@dependabot @github
Copy link
Contributor Author

dependabot bot commented on behalf of github Dec 30, 2020

Superseded by #217.

@dependabot dependabot bot closed this Dec 30, 2020
@dependabot dependabot bot deleted the dependabot/npm_and_yarn/typedoc-0.20.1 branch December 30, 2020 05:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dependencies Pull requests that update a dependency file

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants