From 481a7ed2b77e7e1b448f27e58fedeac53b107ffc Mon Sep 17 00:00:00 2001 From: Mike Maietta Date: Thu, 5 May 2022 16:11:50 -0700 Subject: [PATCH] fix: rendering extended node_modules in jsdoc (#6843) --- .changeset/sweet-queens-brake.md | 5 +++++ docs/api/electron-builder.md | 16 ++++------------ scripts/jsdoc/helpers.js | 6 +++++- scripts/renderer/src/main.ts | 6 +++++- 4 files changed, 19 insertions(+), 14 deletions(-) create mode 100644 .changeset/sweet-queens-brake.md diff --git a/.changeset/sweet-queens-brake.md b/.changeset/sweet-queens-brake.md new file mode 100644 index 0000000000..2e08c91191 --- /dev/null +++ b/.changeset/sweet-queens-brake.md @@ -0,0 +1,5 @@ +--- + +--- + +fix: rendering extended node_modules in jsdoc correctly to unblock release pipeline diff --git a/docs/api/electron-builder.md b/docs/api/electron-builder.md index 2c1a497526..0c7b364923 100644 --- a/docs/api/electron-builder.md +++ b/docs/api/electron-builder.md @@ -1417,7 +1417,7 @@ return path.join(target.outDir, __${target.name}-${getArtifactArchName(arc
  • .isUpdaterActive() ⇒ Boolean
    • -
  • .AppUpdater ⇐ module:events.EventEmitter +
  • .AppUpdater ⇐ module:typed-emitter/index.TypedEventEmitter
  • .autoUpdater : AppUpdater
    • -
  • .DOWNLOAD_PROGRESS : “login” | “checking-for-update” | “update-available” | “update-not-available” | “update-cancelled” | “download-progress” | “update-downloaded” | “error”
    • -
  • .UPDATE_DOWNLOADED : “login” | “checking-for-update” | “update-available” | “update-not-available” | “update-cancelled” | “download-progress” | “update-downloaded” | “error”
    • @@ -1574,9 +1572,9 @@ return path.join(target.outDir, __${target.name}-${getArtifactArchName(arc

    appImageUpdater.isUpdaterActive() ⇒ Boolean

    -

    AppUpdater ⇐ module:events.EventEmitter

    +

    AppUpdater ⇐ module:typed-emitter/index.TypedEventEmitter

    Kind: class of electron-updater
    -Extends: module:events.EventEmitter
    +Extends: module:typed-emitter/index.TypedEventEmitter
    Properties

    • @@ -1630,7 +1628,7 @@ return path.join(target.outDir, __${target.name}-${getArtifactArchName(arc

    Methods

      -
    • .AppUpdater ⇐ module:events.EventEmitter +
    • .AppUpdater ⇐ module:typed-emitter/index.TypedEventEmitter
      • .addAuthHeader(token)
      • .checkForUpdates() ⇒ Promise< | UpdateCheckResult>
        • @@ -1981,12 +1979,6 @@ This is different from the normal quit event sequence.

        electron-updater.autoUpdater : AppUpdater

        -

        Kind: constant of electron-updater
        -

        -

        electron-updater.DOWNLOAD_PROGRESS : “login” | “checking-for-update” | “update-available” | “update-not-available” | “update-cancelled” | “download-progress” | “update-downloaded” | “error”

        -

        Kind: constant of electron-updater
        -

        -

        electron-updater.UPDATE_DOWNLOADED : “login” | “checking-for-update” | “update-available” | “update-not-available” | “update-cancelled” | “download-progress” | “update-downloaded” | “error”

        Kind: constant of electron-updater

        diff --git a/scripts/jsdoc/helpers.js b/scripts/jsdoc/helpers.js index f9d60d348b..b1afb760f9 100644 --- a/scripts/jsdoc/helpers.js +++ b/scripts/jsdoc/helpers.js @@ -30,7 +30,11 @@ function renderTypeNames(types, delimiter, root, isTypeAsCode, isSkipNull) { types = types.filter(it => !isSkipNull || it !== "null") } return types - .map(it => tagOpen + link2(catharsis.parse(it, {jsdoc: true}), delimiter, root, isSkipNull) + tagClose) + .map(it => { + const lastIndex = it.lastIndexOf("node_modules") + it = lastIndex < 0 ? it : `module:${it.substring(lastIndex + 13)}`; + return tagOpen + link2(catharsis.parse(it, {jsdoc: true}), delimiter, root, isSkipNull) + tagClose + }) .join(delimiter) } diff --git a/scripts/renderer/src/main.ts b/scripts/renderer/src/main.ts index c4f58d024f..2d47dc351c 100644 --- a/scripts/renderer/src/main.ts +++ b/scripts/renderer/src/main.ts @@ -56,7 +56,11 @@ export class Renderer { const tagOpen = isTypeAsCode ? "" : "" const tagClose = isTypeAsCode ? "" : "" return types - .map(it => tagOpen + this.renderLink(catharsis.parse(it, {jsdoc: true}), delimiter, isSkipNull, inlinedTypeId) + tagClose) + .map(it => { + const lastIndex = it.lastIndexOf("node_modules") + it = lastIndex < 0 ? it : `module:${it.substring(lastIndex + 13)}`; + return tagOpen + this.renderLink(catharsis.parse(it, {jsdoc: true}), delimiter, isSkipNull, inlinedTypeId) + tagClose + }) .join(delimiter) }