feat: convert shell.openItem to async shell.openPath

[codebytere]

Description of Change

BREAKING CHANGE.

Resolves #20606.
Resolves #7210.

Implements an asynchronous version of shell.openItem(path) as a new method shell.openPath(path).

Adheres to this spec.

Checklist

• PR description included and stakeholders cc'd
• npm test passes
• PR title follows semantic commit guidelines
• PR release notes describe the change in a way relevant to app developers, and are capitalized, punctuated, and past tense.

Release Notes

Notes: Split shell.openItem(path) into synchronous and asynchronous methods.

[deepak1556]

@codebytere this will conflict #10902 in behavior. /cc @zcbenz @ckerr

[codebytere]

@deepak1556 hmm - why don't we allow in an optional callback with an error code and description string if one exists? i think that would solve both issues 🤔

[deepak1556]

There is no reason to not implement it #7210 😄

[zcbenz]

Generally I think we should not change API's behavior and return value silently, otherwise we would not be able to show deprecation warnings, and it would very hard to users to debug if any bug was introduced to their apps due to the behavior change.

For example, previous silent errors would now turn into unhandled exceptions.

A safe choice would be deprecating openItem and renaming the APIs to openPath/openPathSync.

/cc @electron/wg-api for more inputs.

[codebytere]

@zcbenz fair point! i'll address these mechanical changes and then add this to the agenda for tomorrow :)

Do you think we should get rid of the sync version entirely? I personally would prefer that as I think the sync version leads to false assumtions for users about the nature of the synchronicity.

[codebytere]

This should be ready to go per the spec!

[release-clerk]

Release Notes Persisted

Split shell.openItem(path) into synchronous and asynchronous methods.

[anitakurz]

The release-notes of this breaking change says: Split shell.openItem(path) into synchronous and asynchronous methods.
This is misleading as openItem was replaced by openPath. The link to the spec in the first comment is also broken (not https://github.com/electron/governance/blob/master/wg-api/RFCs/shell-openitem.md anymore but https://github.com/electron/governance/blob/master/wg-api/spec-documents/shell-openitem.md). This is important as the API-documentation in this change is wrong and got corrected with #21641 (which is not linked anywhere).
Comming from https://www.electronjs.org/releases/stable#breaking-changes it is quite hard to find out what has been going on. I'd be glad if the release notes of a breaking change would state the nature of the change more clearly and/or outline the actions required for a successful upgrade.
Thanks for considering it.