refactor: Add better typing support on AppUpdater as an event emitter

[Nokel81]

• Helps with not having to look up the specific types for the events
  that are emitted

Signed-off-by: Sebastian Malton sebastian@malton.name

[changeset-bot]

🦋 Changeset detected

Latest commit: 91533c8

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
electron-updater	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[netlify]

✅ Deploy Preview for car-park-attendant-cleat-11576 ready!

Name	Link
🔨 Latest commit	91533c8
🔍 Latest deploy log	https://app.netlify.com/sites/car-park-attendant-cleat-11576/deploys/626a9a5d2dc3de0008f760f1
😎 Deploy Preview	https://deploy-preview-6825--car-park-attendant-cleat-11576.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site settings.

[mmaietta]

As much as I liked this addition, it breaks pnpm generate-docs, which is how we auto-deploy to our Documentation website. I'm working on finding a fix, but if none are found, then we'll need to revert this PR.

@Nokel81 If you're willing to help out, you can test locally with pnpm generate-docs

[Nokel81]

I can give it a shot

[Nokel81]

I don't know anything about carthasis or even the inner workings of handlebars but I think it is being tripped up by the first / of the string module:/Users/nokel81/repos/electron-builder/node_modules/.pnpm/typed-emitter@2.1.0/node_modules/typed-emitter/index.TypedEventEmitter which it is trying to parse as a type reference or something. Is this the first new packaged dependency in a while?

[mmaietta]

Yeah, it's rare that a new dependency is added. I have renovatebot manage dependencies we already use

I did a search and found index.TypedEventEmitter referenced in scripts/jsdoc/out/updater/electron-updater.js after generate-docs

/**
 * @extends module:/Users/michaelmaietta/Development/electron-builder/node_modules/.pnpm/typed-emitter@2.1.0/node_modules/typed-emitter/index.TypedEventEmitter
...

Even the js intellisense is barfing on reading that line

[Nokel81]

Ah I see indeed. The project that I work on uses mkdocs instead so I don't have a lot of experience with packages this package use. I guess either we have to figure out how to get an {@link ...} to somewhere or I should rewrite the PR to not use that dependency.

[mmaietta]

I wonder if we can edit it in helpers.js, as I see we already do that for various IDs

electron-builder/scripts/jsdoc/helpers.js

Lines 260 to 262 in cfa4131

	if (id === "internal:EventEmitter") {
	return "[EventEmitter](https://nodejs.org/api/events.html#events_class_eventemitter)"
	}

electron-builder/scripts/jsdoc/helpers.js

Lines 312 to 317 in cfa4131

	if (id.endsWith(".RequestHeaders")) {
	// don't want complicate docs, if someone need - just see source code
	return "[key: string]: string"
	}
	console.warn(`Unresolved member (helpers.js) ${id}`)

[mmaietta]

Changing this:

electron-builder/scripts/jsdoc/helpers.js

Line 33 in cfa4131

.map(it => tagOpen + link2(catharsis.parse(it, {jsdoc: true}), delimiter, root, isSkipNull) + tagClose)

to be catharsis.parse(it.replace(/.*node_modules\//, "module:") fixes the compilation issue, but I'm not sure of the impact on how that'd look on the docs. The updated .md file shows

<li><a href="#AppUpdater">.AppUpdater</a> ⇐ <code>module:typed-emitter@2.1.0/node_modules/typed-emitter/index.TypedEventEmitter</code>