Skip to content
This repository has been archived by the owner on Jul 27, 2023. It is now read-only.

Update dependency typedoc to v0.20.36 #16

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

renovate[bot]
Copy link

@renovate renovate bot commented Jan 3, 2019

WhiteSource Renovate

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
typedoc (source) 0.13.0 -> 0.20.36 age adoption passing confidence

Release Notes

TypeStrong/TypeDoc

v0.20.36

Compare Source

Features
  • use 'pretty' option when generating json (d5930e0)
  • create 'pretty' option (b3c856e)
Bug Fixes
  • Always write to stdout, even if redirected (dcbda43), closes #​1566
  • Create directories when writing JSON output (4817db4)
Thanks!

v0.20.35

Compare Source

Features
  • Include debugging information in highlighting error messages (#​1561) (a90deee)
Bug Fixes
Thanks!
  • Masato Makino

v0.20.34

Compare Source

Bug Fixes

v0.20.33

Compare Source

Bug Fixes

v0.20.32

Compare Source

Bug Fixes

v0.20.31

Compare Source

Bug Fixes
Thanks!

v0.20.30

Compare Source

Bug Fixes
  • Categories should only appear once if specified multiple times (6949a1f), closes #​1522
  • Remove undefined from optional property types (c9faa9b), closes #​1525
  • Support JSDocNullableType, JSDocNonNullableType (34d05f2), closes #​1524

v0.20.29

Compare Source

Features

v0.20.28

Compare Source

Bug Fixes

v0.20.27

Compare Source

Bug Fixes
Features
  • preserve spaces in code blocks (c8de53a)
Thanks!

v0.20.26

Compare Source

Bug Fixes

v0.20.25

Compare Source

Features
  • Support for specifying comments on export declarations (7b7bf66), closes #​1504
  • Support for the @module tag to mark a comment as belonging to a module (7b7bf66)

v0.20.24

Compare Source

Features
Thanks!

v0.20.23

Compare Source

Bug Fixes
  • Missing namespace members when ns is created by re-exporting an entire module (7dfadcf), closes #​1499
  • Set inheritedFrom on accessor signatures (ccd519a), closes #​1497
  • Copy comment from interface members if implementing member doesn't have a comment #​1498

v0.20.22

Compare Source

Bug Fixes

v0.20.21

Compare Source

Bug Fixes
  • Missing exported members in file-as-namespace reflection (1423960), closes #​1493

v0.20.20

Compare Source

Bug Fixes
Features
  • add highlight theme option (4a6df9a)
Thanks!

v0.20.19

Compare Source

Features
  • Support for --watch, --preserveWatchOutput, --emit (2188f86)

v0.20.18

Compare Source

Bug Fixes
  • Static methods added to the class manually in JS (687ae53), closes #​1481

v0.20.17

Compare Source

Bug Fixes
Features
  • inheritDoc: Add support for copying item’s documentation by copying it from another API item (84db49a)
Thanks!

v0.20.16

Compare Source

Bug Fixes
  • Comments on projects were broken (685ca41)
  • Constructors were a bit broken (d746d85)

v0.20.15

Compare Source

Bug Fixes
Features
  • Support for excludeInternal (4f4d85c), closes #​1469
  • category: add option to read more categories from doc (18d83f6)
Thanks!

v0.20.14

Compare Source

Bug Fixes
Thanks!

v0.20.13

Compare Source

Bug Fixes
  • Use type nodes if converting a regular function (d528c69), closes #​1454

v0.20.12

Compare Source

Bug Fixes
Thanks!

v0.20.11

Compare Source

Bug Fixes
  • Crash when converting a generic with a tuple constraint (685cd3e), closes #​1449

v0.20.10

Compare Source

Bug Fixes
  • Errors due to bad options in tsconfig file were dropped (f76b521), closes #​1444
Changes
  • Updated warning about unsupported highlight language to point users to typedoc --help

v0.20.9

Compare Source

Bug Fixes

v0.20.8

Compare Source

Bug Fixes
  • CLI should not exit cleanly on unexpected error (2907328)

v0.20.7

Compare Source

Bug Fixes

v0.20.6

Compare Source

Bug Fixes
Features

v0.20.5

Compare Source

Bug Fixes
  • Functions might not have a parent in global files (d739298), closes #​1436

v0.20.4

Compare Source

Bug Fixes
  • --excludeNotDocumented didn't remove reflections (5ebbd0f), closes #​1435

v0.20.3

Compare Source

Features

v0.20.2

Compare Source

Bug Fixes
  • ArgumentsReader should warn if missing a value (02b915d), closes #​1429
  • Literal boolean converter in TS 3 (ed67eda), closes #​1432
  • Map bash, sh, shell to shellscript when highlighting (6eb6c28), closes #​1432
  • Negative literal types were converted incorrectly (c14b5b5), closes #​1427
  • TS 3 converters for null, this types (20febfd)
Features
  • Better detection for declaration files defining a module (38d8edf), closes #​1430

v0.20.1

Compare Source

Bug Fixes

v0.20.0

Compare Source

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.
  6. 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:

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:

/**
 * @​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
  • Hidden module-namespaces (88fa674), closes #​1396
  • isExternal flag wasn't set properly (0060eb7)
  • JSON schema had incorrect value types (26a9c0d), closes #​1389
  • Lint (d75c67c)
  • Missing comments on variable functions (e15bcd6), closes #​1421
  • Normalize unions (9f8375d), closes #​571
  • Reintroduce support for index signatures (20a7d5f)
  • Resolve type parameters in concrete subclasses (85cd06d)
  • Somehow didn't save a file (33c2bc6)
  • docs: A typo in description of DefaultTheme.getMapping (#​1416) (a4c3d9e)
  • perf: Only create extra programs when dealing with solution style tsconfigs (6525a7b)
  • Missing default exports (017fad1)
  • Reference types should always be given resolved symbols (1d6120f)
  • Rendering works again (17bf655)
  • Some issues with inheritence (033b1ae)
  • Support for specify a directory as an entry point (ac4c688)
  • Type converters threw on older TS versions (1161cb2)
  • TypeDoc should warn users about missing entry points (8c51af8)
  • We pick up all properties now (4845209)
Features
  • Add logLevel option (80c4524)
  • Automatically generate schema for typedoc.json (cd84548)
  • Colors in console output (49189de)
  • Initial attempt at support for project references (e1106dd), closes #​1414
  • Mostly working library mode (bcbd401)
  • new option "markedOptions" (#​1412) (2bf6e49)
  • Options may specify a validation function (#​1398) (884332b)
  • Partial support for global files (9cb5b9c)
  • Support for [@module](https://github.com/module) tag (15cb73c)
  • Support for mapped types (1036069)
  • Support for the remaining literal types (695f5c7)
  • Support for TS 4.1 mapped types + string literal types (a32c976), closes #​1397
  • Switch back to search.js (f0af1f1), closes #​1339
API Breaking changes
  • Application.generateDocs, Application.generateJson now return a promise
  • Converter.EVENT_FILE_BEGIN has been removed - it no longer makes sense since re-exports are fully supported
  • "string-literal" type removed, there is now a single "literal" type that includes string literals, number literals, bigint literals, and null
  • context.fileNames has been removed
  • isExported / isConstructorProperty ReflectionFlags remvoed
  • Converter.EVENT_FUNCTION_IMPLEMENTATION removed - it was inappropriately used to perform some data extraction, which was unreliable since not all function declarations include an implementation
  • Converter.EVENT_BEGIN listeners may not access context.program. If they need access to a TS program, they should instead use context.programs and find the one they are interested in.
Thanks!

Thank you to everyone who helped test the 0.20 beta, and the following code contributors:

v0.19.2

Compare Source

Bug Fixes
  • Export declarations within namespaces weren't detected (983c0e6), closes #​1366

v0.19.1

Compare Source

Features
Thanks!

v0.19.0

Compare Source

Bug Fixes
Features
Thanks!

v0.18.0

Compare Source

Bug Fixes
Breaking Changes
  • Minimum Node version bumped to v10.0.0

v0.17.8

Compare Source

Bug Fixes
Thanks!

v0.17.7

Compare Source

Bug Fixes
Features
  • (Plugin API) Allow every possible number as a defaultValue for a number option (#​1296) (f93c76b), closes #​1291
Thanks!

v0.17.6

Compare Source

Bug Fixes
  • Correct prepublish script, it was supposed to enable more lax typings for plugins, but failed to do so. (3b081de)

v0.17.5

Compare Source

Bug Fixes
Features
Thanks!

v0.17.4

Compare Source

Bug Fixes
  • options: Map type options should not have their default value validated (#​1250) (c296503)
Features
Thanks!

v0.17.3

Compare Source

Features
Fixed
  • The legend is no longer missing on most documentation pages
Thanks!

v0.17.2

Compare Source

Bug Fixes

v0.17.1

Compare Source

Bug Fixes

v0.17.0

Compare Source

Bug Fixes
  • Check for compiler errors before converting (802c408)
  • Plugin resolution now uses relative paths (#​1194) closes #​1188
Features
BREAKING CHANGES
  • Any plugins which referenced ReflectionKind.ExternalModule or ReflectionKind.Module need to be updated to reference ReflectionKind.Module and ReflectionKind.Namespace respectively.
  • createMinimatch is no longer a public function.
  • @Option decorator removed
Thanks!

TypeDoc wouldn't be maintained without the help of the community, thanks to all who submitted issues and especially to those who contributed code to this release:

v0.16.11

Compare Source

Bug Fixes 🐛
Features ✨
Thanks 👏

v0.16.10

Compare Source

Features ✨
  • Add the ability to remove tags from doc comments (#​815)
  • The logger will now also count warning messages (#​1205)
Fixed 🐛
  • The link tag will now no longer be incorrectly stripped from some param comments (#​1001)
  • Mixins will no longer cause TypeDoc to crash in some cases (#​1207)
Thanks 👏

v0.16.9

Compare Source

Fixed 🐛
  • TypeDoc now correctly handles BOM in package.json (#​1192)
Thanks 👏

v0.16.8

Compare Source

Fixed 🐛
  • export * from ... could cause a circular reference that sent TypeDoc into an infinite loop (#​1186)

v0.16.7

Compare Source

Fixed 🐛
  • Object literal {} now renders correctly (#​1179)
Features ✨
  • Support for query types (type Z = typeof z)
Thanks

v0.16.6

Compare Source

Fixed 🐛
  • removeReflection does not fully remove reflections #​1176

v0.16.5

Compare Source

Fixed 🐛
  • @BindOption now works with plugin options (#​1174)
  • Empty modules are no longer included in the HTML documentation (#​1126)
Changed 📦
  • The project version is no longer added to the package name by default, specify the --includeVersion flag to include it. (#​1175)
  • The NavigationBuilder class is now available to simplify theme creation (#​1171)
Thanks 👏

v0.16.4

Compare Source

Fixed 🐛
  • CLI crashing due to circular dependencies (#​1172)

v0.16.3

Compare Source

Fixed 🐛
  • @hidden can now be used to selectively hide overloads (#​1142)
  • Plugins are now correctly autoloaded (#​1170)
  • Corrected JSON output types
Changed 📦
  • @Option decorator deprecated in favor of registering manually.
  • @BindOption property decorator now available for fetching options like @Option
  • References are now no longer created for source files not included in the documentation
Thanks 👏

Thank you to all who reported issues and the following code contributors:

v0.16.2

Compare Source

Features ✨
  • Plugins may now use the @Option decorator to declare options. (#​1165)
Fixed 🐛
  • @param and @returns are overly sensitive to whitespace (#​1164)
  • TypeDoc is missing exported values to set options without importing internals (#​1163)
Changed 📦
  • TypeDoc's tests now run in ~30 seconds instead of 3 minutes, making for a much better development experience (#​1156)

v0.16.1

Compare Source

v0.16.0

Compare Source

Features ✨
  • In modules mode, export declarations are now resolved.
  • Support for import x =
Fixed 🐛
  • expandInputFiles will no longer throw if the input directory includes a symbolic link (#​751)
  • Nested object literals are now correctly marked as exported (#​1103)
  • Resolve and link TypeOperatorType types (#​1161)
Breaking Changes ⚠️
  • With --mode file, all declarations are now considered exported.
  • When using the programmatic API, if you want to automatically read tsconfig.json and typedoc.json you must add the readers to the Options class on Application
  • typedoc.js may no longer return a function to be called to set options.
  • Options now calls the registered option readers instead of firing an event.
  • Programmatic users must call app.bootstrap with their options instead of new App(options)
Thanks! 👏

TypeDoc would be far worse off without these people's help.

v0.15.8

Compare Source

Fixed 🐛
  • Upgraded handlebars to 4.7.0 - #​1159
Thanks 👏

v0.15.7

Compare Source

Fixed 🐛

v0.15.6

Compare Source

Fixed 🐛
  • When using recursive types TypeDoc ran out of memory (#​1150)
  • Improved performance by ~20% when --ignoreCompilerErrors is passed by not asking TypeScript for the errors (#​1032)
  • Fixes included in typedoc-default-themes@0.6.3
Features ✨
  • Support for TS2.8 conditional types (#​831)
  • Support for indexed-access types (#​1153)
  • The `@pa

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.


  • If you want to rebase/retry this PR, check this box.

This PR has been generated by WhiteSource Renovate. View repository job log here.

@renovate renovate bot changed the title Update dependency typedoc to v0.14.0 Update dependency typedoc to v0.14.1 Jan 11, 2019
@renovate renovate bot force-pushed the renovate/typedoc-0.x branch from bb95747 to 6e611c9 Compare January 11, 2019 01:36
@renovate renovate bot changed the title Update dependency typedoc to v0.14.1 Update dependency typedoc to v0.14.2 Jan 16, 2019
@renovate renovate bot force-pushed the renovate/typedoc-0.x branch from 6e611c9 to 4915b90 Compare January 16, 2019 17:44
@renovate renovate bot force-pushed the renovate/typedoc-0.x branch from 4915b90 to 356feb0 Compare August 10, 2019 10:58
@renovate renovate bot changed the title Update dependency typedoc to v0.14.2 Update dependency typedoc to v0.15.0 Aug 10, 2019
@renovate renovate bot changed the title Update dependency typedoc to v0.15.0 Update dependency typedoc to v0.15.2 Nov 21, 2019
@renovate renovate bot force-pushed the renovate/typedoc-0.x branch from 356feb0 to b94edd6 Compare November 21, 2019 14:08
@renovate renovate bot force-pushed the renovate/typedoc-0.x branch from b94edd6 to a1e91d9 Compare December 14, 2019 22:54
@renovate renovate bot changed the title Update dependency typedoc to v0.15.2 Update dependency typedoc to v0.15.4 Dec 14, 2019
@renovate renovate bot force-pushed the renovate/typedoc-0.x branch from a1e91d9 to 22988b6 Compare December 21, 2019 22:51
@renovate renovate bot changed the title Update dependency typedoc to v0.15.4 Update dependency typedoc to v0.15.5 Dec 21, 2019
@renovate renovate bot force-pushed the renovate/typedoc-0.x branch from 22988b6 to 48638a2 Compare December 31, 2019 11:00
@renovate renovate bot changed the title Update dependency typedoc to v0.15.5 Update dependency typedoc to v0.15.6 Dec 31, 2019
@renovate renovate bot force-pushed the renovate/typedoc-0.x branch from 48638a2 to 2a1e6e7 Compare January 18, 2020 19:18
@renovate renovate bot changed the title Update dependency typedoc to v0.15.6 Update dependency typedoc to v0.16.7 Jan 18, 2020
@renovate renovate bot force-pushed the renovate/typedoc-0.x branch from 2a1e6e7 to cf7c6d0 Compare February 8, 2020 21:55
@renovate renovate bot changed the title Update dependency typedoc to v0.16.7 Update dependency typedoc to v0.16.9 Feb 8, 2020
@renovate renovate bot force-pushed the renovate/typedoc-0.x branch from cf7c6d0 to 7530e54 Compare February 22, 2020 10:55
@renovate renovate bot changed the title Update dependency typedoc to v0.16.9 Update dependency typedoc to v0.16.10 Feb 22, 2020
@renovate renovate bot force-pushed the renovate/typedoc-0.x branch from 7530e54 to 9c1f3ab Compare March 15, 2020 04:01
@renovate renovate bot changed the title Update dependency typedoc to v0.16.10 Update dependency typedoc to v0.16.11 Mar 15, 2020
@renovate renovate bot force-pushed the renovate/typedoc-0.x branch from 9c1f3ab to 1f4d161 Compare April 28, 2020 05:00
@renovate renovate bot changed the title Update dependency typedoc to v0.16.11 Update dependency typedoc to v0.17.6 Apr 28, 2020
@renovate renovate bot force-pushed the renovate/typedoc-0.x branch from 1f4d161 to 69c5b96 Compare July 2, 2020 02:56
@renovate renovate bot changed the title Update dependency typedoc to v0.17.6 Update dependency typedoc to v0.17.8 Jul 2, 2020
@renovate renovate bot force-pushed the renovate/typedoc-0.x branch from 69c5b96 to 4afef9d Compare August 22, 2020 08:58
@renovate renovate bot changed the title Update dependency typedoc to v0.17.8 Update dependency typedoc to v0.18.0 Aug 22, 2020
@renovate renovate bot force-pushed the renovate/typedoc-0.x branch from 4afef9d to 6fdd907 Compare October 29, 2020 10:00
@renovate renovate bot changed the title Update dependency typedoc to v0.18.0 Update dependency typedoc to v0.19.2 Oct 29, 2020
@renovate renovate bot force-pushed the renovate/typedoc-0.x branch from 6fdd907 to e41965d Compare January 6, 2021 20:56
@renovate renovate bot changed the title Update dependency typedoc to v0.19.2 Update dependency typedoc to v0.20.13 Jan 6, 2021
@renovate renovate bot force-pushed the renovate/typedoc-0.x branch from e41965d to 9daef17 Compare January 24, 2021 14:00
@renovate renovate bot changed the title Update dependency typedoc to v0.20.13 Update dependency typedoc to v0.20.17 Jan 24, 2021
@renovate renovate bot force-pushed the renovate/typedoc-0.x branch from 9daef17 to e951f08 Compare January 31, 2021 17:58
@renovate renovate bot changed the title Update dependency typedoc to v0.20.17 Update dependency typedoc to v0.20.19 Jan 31, 2021
@renovate renovate bot force-pushed the renovate/typedoc-0.x branch from e951f08 to cbc48cf Compare February 9, 2021 04:54
@renovate renovate bot changed the title Update dependency typedoc to v0.20.19 Update dependency typedoc to v0.20.23 Feb 9, 2021
@renovate renovate bot force-pushed the renovate/typedoc-0.x branch from cbc48cf to 5e53d36 Compare February 11, 2021 09:28
@renovate renovate bot changed the title Update dependency typedoc to v0.20.23 Update dependency typedoc to v0.20.24 Feb 11, 2021
@renovate renovate bot force-pushed the renovate/typedoc-0.x branch from 5e53d36 to b5a1aaa Compare April 26, 2021 17:04
@renovate renovate bot changed the title Update dependency typedoc to v0.20.24 Update dependency typedoc to v0.20.36 Apr 26, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant