Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

types: Add missing return types, see #2952 #3021

Merged
merged 11 commits into from
Aug 8, 2024
Merged

types: Add missing return types, see #2952 #3021

merged 11 commits into from
Aug 8, 2024

Conversation

zFernand0
Copy link
Member

@zFernand0 zFernand0 commented Jul 25, 2024

Proposed changes

Release Notes

Milestone: 3.0

Changelog: Added missing return types to Zowe Explorer API programmatic interfaces.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • Enhancement (non-breaking change which adds or improves functionality)
  • Breaking change (a change that would cause existing functionality to not work as expected)
  • Documentation (Markdown, README updates)
  • Other (please specify above in "Proposed changes" section)

Checklist

General

  • I have read the CONTRIBUTOR GUIDANCE wiki
  • All PR dependencies have been merged and published (if applicable)
  • A GIF or screenshot is included in the PR for visual changes
  • The pre-publish command has been executed:
    • v2 and below: yarn workspace vscode-extension-for-zowe vscode:prepublish
    • v3: pnpm --filter vscode-extension-for-zowe vscode:prepublish

Code coverage

  • There is coverage for the code that I have added
  • I have added new test cases and they are passing
  • I have manually tested the changes

Deployment

  • I have added developer documentation (if applicable)
  • Documentation should be added to Zowe Docs
    • If you're an outside contributor, please post in the #zowe-doc Slack channel to coordinate documentation.
    • Otherwise, please check with the rest of the squad about any needed documentation before merging.
  • These changes may need ported to the appropriate branches (list here):

Further comments

TODO:

  • Add breaking change notes to the corresponding places
  • Publish another prerelease after this PR is merged

@zFernand0 zFernand0 added the v3 label Jul 25, 2024
@zFernand0 zFernand0 added this to the v3 pre-releases milestone Jul 25, 2024
@zFernand0 zFernand0 requested a review from t1m0thyj July 25, 2024 14:56
@zFernand0 zFernand0 self-assigned this Jul 25, 2024
@zFernand0 zFernand0 linked an issue Jul 25, 2024 that may be closed by this pull request
Copy link

codecov bot commented Jul 25, 2024

Codecov Report

Attention: Patch coverage is 91.17647% with 3 lines in your changes missing coverage. Please review.

Project coverage is 92.77%. Comparing base (4f44706) to head (e732689).

Files Patch % Lines
...ges/zowe-explorer/src/trees/dataset/DatasetTree.ts 75.00% 2 Missing ⚠️
...ckages/zowe-explorer/src/configuration/Profiles.ts 50.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             next    #3021      +/-   ##
==========================================
- Coverage   92.87%   92.77%   -0.10%     
==========================================
  Files         107      107              
  Lines       10913    10897      -16     
  Branches     2280     2358      +78     
==========================================
- Hits        10135    10110      -25     
- Misses        776      785       +9     
  Partials        2        2              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@zFernand0 zFernand0 force-pushed the zfernand0/ze-2952 branch from 2bf1197 to 2c454e0 Compare July 26, 2024 10:53
@zFernand0 zFernand0 force-pushed the zfernand0/ze-2952 branch from 2c454e0 to 35d25b1 Compare July 29, 2024 18:36
Signed-off-by: zFernand0 <37381190+zFernand0@users.noreply.github.com>
Signed-off-by: zFernand0 <37381190+zFernand0@users.noreply.github.com>
Signed-off-by: zFernand0 <37381190+zFernand0@users.noreply.github.com>
@zFernand0 zFernand0 force-pushed the zfernand0/ze-2952 branch from 35d25b1 to 2702e39 Compare July 29, 2024 18:58
Signed-off-by: zFernand0 <37381190+zFernand0@users.noreply.github.com>
Signed-off-by: zFernand0 <37381190+zFernand0@users.noreply.github.com>
@zFernand0 zFernand0 marked this pull request as ready for review July 31, 2024 18:53
Base automatically changed from ext-not to next August 1, 2024 17:03
@zFernand0 zFernand0 requested a review from anaxceron August 1, 2024 19:30
anaxceron
anaxceron previously approved these changes Aug 1, 2024
Copy link
Contributor

@anaxceron anaxceron left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A+

Signed-off-by: Fernando Rijo Cedeno <37381190+zFernand0@users.noreply.github.com>
anaxceron
anaxceron previously approved these changes Aug 2, 2024
Copy link
Member

@traeok traeok left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks Fernando! I have a quick request for the encoding property, but the type changes make sense to me.

packages/zowe-explorer-api/src/tree/IZoweTreeNode.ts Outdated Show resolved Hide resolved
…eUSSTreeNode interface

Signed-off-by: zFernand0 <37381190+zFernand0@users.noreply.github.com>
Copy link

sonarqubecloud bot commented Aug 6, 2024

Quality Gate Failed Quality Gate failed

Failed conditions
3.8% Duplication on New Code (required ≤ 3%)

See analysis details on SonarCloud

Copy link
Member

@traeok traeok left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes LGTM - thanks for adding the deprecation comment 🙂

Copy link
Member

@t1m0thyj t1m0thyj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks @zFernand0!

@t1m0thyj t1m0thyj merged commit eebf116 into next Aug 8, 2024
27 of 28 checks passed
@t1m0thyj t1m0thyj deleted the zfernand0/ze-2952 branch August 8, 2024 20:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: Closed
Development

Successfully merging this pull request may close these issues.

Add return types to all interface methods in Zowe Explorer API
5 participants