MVP: Imperative Event Emitter

zFernand0 commented 2 months ago

What It Does

Introduce client event emission capabilities

How to Test

You may need to create a dummy app (e.g. VSCE) in order to test this 😋 ( or use ~fernando's example VSCE~ - amber's comment )

UPDATE: Here is a public instance of the sample VSCE

https://github.com/zowe/zowe-cli-sample-scripts/tree/add-sample-vsce/client-event-handling/sample-vsce

Review Checklist I certify that I have:

[x] tested my changes
[x] added/updated automated tests
[x] updated the changelog
[x] followed the contribution guidelines

Additional Comments

TODO:

[ ] Integration/system testing
[ ] Documentation of the new behavior
[x] Outline of future plans (see packages/imperative/src/events/src/ImperativeEventConstants.ts)

Expand this section for a complete list of future enhancements

``` The following list of event types will only be implemented upon request Shared events: Global: - $ZOWE_CLI_HOME/.events/onConfigChanged - $ZOWE_CLI_HOME/.events/onSchemaChanged Project: - $ZOWE_CLI_HOME/.events//onConfigChanged - $ZOWE_CLI_HOME/.events//onSchemaChanged User events: Global: - ~/.zowe/.events/onUserConfigChanged Project: - ~/.zowe/.events//onUserConfigChanged Custom events: Shared: Global: - $ZOWE_CLI_HOME/.events// Project: - $ZOWE_CLI_HOME/.events/// User: Global: - ~/.zowe/.events// Project: - ~/.zowe/.events/// ```

codecov[bot] commented 2 months ago

Codecov Report

Attention: Patch coverage is 96.70330% with 6 lines in your changes are missing coverage. Please review.

Project coverage is 91.20%. Comparing base (1016963) to head (d68e05d). Report is 2 commits behind head on next.

Files	Patch %	Lines
...mperative/src/events/src/ImperativeEventEmitter.ts	96.42%	4 Missing :warning:
packages/imperative/src/config/src/ConfigUtils.ts	95.45%	1 Missing :warning:
...tive/src/security/src/CredentialManagerOverride.ts	66.66%	1 Missing :warning:

Additional details and impacted files

```diff @@ Coverage Diff @@ ## next #2118 +/- ## ========================================== + Coverage 91.15% 91.20% +0.05% ========================================== Files 623 628 +5 Lines 17716 17877 +161 Branches 3763 3750 -13 ========================================== + Hits 16149 16305 +156 - Misses 1566 1571 +5 Partials 1 1 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

zFernand0 commented 1 month ago

Thanks for the review! 🙏🏽 Moving this back to draft to address these items 😋

zFernand0 commented 1 month ago

This PR should be ready to review as-is.

There will be many more changes happening once the following PR gets in: