docs: typedoc improvements
Cleanup PR based on learnings from the TypeDoc PRs.
- Direct use of
npx typedocrather than JavaScript API removes legacybuild_docs.jsfrom code. Their JavaScript API has minimal documentation, and most options are available viatypedoc.jsonconfiguration anyways. - Use of
externalSymbolLinkMappingsto show links to types available via external Electron packages (e.g. get and notarize).
Tag changes:
- Changed plaintext examples to use the
@exampletag. - Fixed outstanding cases of legacy
[[link tag syntax]]to use{@link tag syntax}. - Used
@interfaceto expand utility types whenever possible (e.g. instead ofOmit<TypeA, 'KeyB' | 'KeyC'>, adding the@interfacetag makes it so that all ofTypeA's properties are displayed in the API documentation excludingKeyBandKeyC. - Used
@internalandexcludeInternalsto hide types that should not be used by end users of Electron Packager.
Do we also need to add explicit external link config for osx-sign and windows-sign? Plus any other dependency where we proxy the options that I'm forgetting.
Codecov Report
All modified and coverable lines are covered by tests :white_check_mark:
Project coverage is 89.06%. Comparing base (
e94088d) to head (f24e1e6).
Additional details and impacted files
@@ Coverage Diff @@
## main #1734 +/- ##
==========================================
- Coverage 89.28% 89.06% -0.23%
==========================================
Files 17 17
Lines 905 905
Branches 187 187
==========================================
- Hits 808 806 -2
- Misses 61 62 +1
- Partials 36 37 +1
:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.
:tada: This PR is included in version 18.4.0 :tada:
The release is available on:
Your semantic-release bot :package::rocket: