zowe / zowe-explorer-vscode

Visual Studio Code Extension for Zowe, which lets users interact with z/OS Data Sets, Unix System Services, and Jobs on a remote mainframe instance. Powered by Zowe SDKs.
Eclipse Public License 2.0
159 stars 89 forks source link

feat: Zowe Explorer Development CLI #2914

Closed traeok closed 1 month ago

traeok commented 1 month ago

Proposed changes

This branch proposes the introduction of a lightweight development CLI made in Rust, providing the following commands as helper utilities:

Developers can leverage this utility while developing a Zowe Explorer bug fix/feature, or for testing other contributions without modifying their original environment. It's entirely optional and does not interfere with normal behavior of the repo, so developers can choose to adopt it if they find it useful.

Other ideas that I had in mind for the future of this tool:

Installation steps

  1. Install the requirements if they aren't yet installed - cmake, gcc, Git Bash and Rust
  2. cd into the zedc folder in the root of the repo and run the command cargo build --release.
  3. Once complete, create a folder for the zedc tool that can be added to your PATH environment variable.
  4. Add this folder's path to your PATH environment variable and open a new shell.
  5. Attempt to run the tool by running the zedc command. A help message should appear with the available commands.

Release Notes

Milestone:

Changelog:

Types of changes

What types of changes does your code introduce to Zowe Explorer? Put an x in the boxes that apply

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This checklist will be used as reference for both the contributor and the reviewer

codecov[bot] commented 1 month ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 92.68%. Comparing base (6370958) to head (19b920f).

:exclamation: Current head 19b920f differs from pull request most recent head 4c0b248

Please upload reports for the commit 4c0b248 to get more accurate results.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## next #2914 +/- ## ======================================= Coverage 92.68% 92.68% ======================================= Files 109 109 Lines 10981 10981 Branches 2314 2313 -1 ======================================= Hits 10178 10178 Misses 801 801 Partials 2 2 ```

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

traeok commented 1 month ago

Sorry to anyone that was trying to test on macOS - I needed to make some changes to fix extracting portable VS Code versions. I've ran some manual tests with the latest changes and all seems to be working as intended now 😅

sonarcloud[bot] commented 1 month ago

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

traeok commented 1 month ago

Hey @traeok I don't see any instructions in the description on how to package and install the new package. I ran build and package as usual but don't see anything new included after the command. It may be good to add these steps to our dev/top-level README for contributors to also know how to use it.

Sorry about that @JillieBeanSim, I added a section in the zedc readme but forgot to add the steps in the PR description. I've updated the PR with steps on how to install 👍