Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update dependency typedoc to ^0.20.32 #63

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

Conversation

pennlabsbot
Copy link

@pennlabsbot pennlabsbot commented Mar 14, 2021

This PR contains the following updates:

Package Type Update Change
typedoc (source) devDependencies minor ^0.19.2 -> ^0.20.32

Release Notes

TypeStrong/TypeDoc

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://togithub.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:


Renovate configuration

📅 Schedule: At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻️ Rebasing: Renovate will not automatically rebase this PR, because other commits have been found.

🔕 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 Renovate Bot.

@pennlabsbot pennlabsbot added dependencies Pull requests that update a dependency file major pre-1-0-0 labels Mar 14, 2021
@pennlabsbot pennlabsbot changed the title Update dependency typedoc to ^0.20.31 Update dependency typedoc to ^0.20.32 Mar 14, 2021
@codecov
Copy link

codecov bot commented Mar 14, 2021

Codecov Report

Merging #63 (4f98782) into master (08c611c) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##            master       #63    +/-   ##
==========================================
  Coverage   100.00%   100.00%            
==========================================
  Files           15        26    +11     
  Lines          138       308   +170     
  Branches         9        49    +40     
==========================================
+ Hits           138       308   +170     
Flag Coverage Δ
kittyhawk 100.00% <ø> (?)
kraken 100.00% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
cdk/kittyhawk/src/cronjob.ts 100.00% <0.00%> (ø)
cdk/kittyhawk/src/deployment.ts 100.00% <0.00%> (ø)
cdk/kittyhawk/src/chart.ts 100.00% <0.00%> (ø)
cdk/kittyhawk/src/ingress.ts 100.00% <0.00%> (ø)
cdk/kittyhawk/src/application.ts 100.00% <0.00%> (ø)
cdk/kittyhawk/src/autoscaler.ts 100.00% <0.00%> (ø)
cdk/kittyhawk/src/container.ts 100.00% <0.00%> (ø)
cdk/kittyhawk/src/certificate.ts 100.00% <0.00%> (ø)
cdk/kittyhawk/src/index.ts 100.00% <0.00%> (ø)
cdk/kittyhawk/test/utils.ts 100.00% <0.00%> (ø)
... and 1 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ae62ea4...4f98782. Read the comment docs.

@pennlabsbot
Copy link
Author

Autoclosing Skipped

This PR has been flagged for autoclosing, however it is being skipped due to the branch being already modified. Please close/delete it manually or report a bug if you think this is in error.

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 major pre-1-0-0
Development

Successfully merging this pull request may close these issues.

2 participants