zowe/zowe-explorer-ftp-extension

Adds zFTP support to Zowe Explorer demonstrating how to extend the Zowe Explorer using its extensibility API.

Zowe Explorer FTP extension

An example VS Code extension demonstrating how to use the Zowe Explorer extension API. It implements Zowe CLI FTP plugin support for the USS explorer. You can then create Zowe CLI FTP profiles and add them to the USS Zowe Explorer to use the FTP protocol for accessing files instead of zOSMF.

How to build

Install the latest Zowe Explorer

This example will ony work with version 1.2.0 or newer of the Zowe Explorer.

• Install it from the VS Code Marketplace following the instructions described here.
• Test the Zowe Explorer using z/OSMF CLI profiles if you have z/OSMF available.

Create a Zowe FTP profile

This example is using the Zowe FTP CLI plugin as a dependency to provide FTP capabilities.

• Go to the Zowe FTP CLI Plugin GitHub repository for instructions for how to install it: https://github.com/zowe/zowe-cli-ftp-plugin
• Create Zowe CLI FTP profile:

  zowe profiles create zftp <profile name> -H <host> -u <user> -p <password> -P <port>

Build this extension

This repo uses Yarn for building.

• Clone this zowe-explorer-ftp-extension repo:

  git clone [email protected]:zowe/zowe-explorer-ftp-extension.git

• Build the VS Code extension with

  yarn && yarn package

• Install the vsix file using the Preferences > Extensions menu or just run this extension from VS Code that has the Zowe Explorer built from the AI branch running with the <F5> key.

Using the FTP Extension

• Start VS Code with the extension installed or via the <F5> out of the development workspace as described above.
• A message will be shown telling you that activation was successful.
• Click the + icon and you will see your Zowe FTP profile listed in the drop-down.
• Select it and it will appear in the USS Explorer.
• Click the Search icon next to it to specify a USS path to list it.
• Try opening and saving files.

How to create your own Zowe Explorer extension

TBD, but the rough steps would be:

• Copy the file src/api/ZoweExplorerAPI.ts
• Implement classes that implement any of the IMvs, IUss, IJes interfaces.
• Implement a registration method similar to registerFtpApi() in extension.ts that queries the Zowe Explorer API and calls the registration method.

zowe-explorer-ftp-extension's Issues

vsce package missing as a dependency

When you try to run the following command :

npm install && npm run build && npm run package

you will get an error like below

> @zowe/[email protected] postinstall C:\Users\test2020\vscode-extension-for-zowe-api-sample\node_modules\@zowe\cli
> node ./scripts/validatePlugins

Since you re-installed Zowe CLI, we are re-validating any plugins.

_____ Validation results for plugin '@zowe/zos-ftp-for-zowe-cli' _____
This plugin was successfully validated. Enjoy the plugin.
added 148 packages from 148 contributors and audited 150 packages in 8.38s
found 0 vulnerabilities


> [email protected] build C:\Users\test2020\vscode-extension-for-zowe-api-sample
> tsc -p ./


> [email protected] package C:\Users\test2020\vscode-extension-for-zowe-api-sample
> vsce package

'vsce' is not recognized as an internal or external command,
operable program or batch file.
npm ERR! code ELIFECYCLE
npm ERR! errno 1
npm ERR! [email protected] package: `vsce package`
npm ERR! Exit status 1
npm ERR!
npm ERR! Failed at the [email protected] package script.
npm ERR! This is probably not a problem with npm. There is likely additional logging output above.

npm ERR! A complete log of this run can be found in:
npm ERR!     C:\Users\AppData\Roaming\npm-cache\_logs\2020-05-29T09_40_08_794Z-debug.log

This is because the vsce needs to be installed globally which can be done either via the following command

npm install -g vsce or you can run it locally to fix this
eg
npm install vsce

Request for enhancement: support data sets

Dear developers, I have recently installed the Zowe Explorer FTP extension, hoping to be able to work with z/OS datasets.
Unfortunately I discovered that it only enables me to work with USS files. While this is very convenient, I could have reached the same goal using one of the other FTP extensions that are available for VSCode.
The real value would be, for me, being able to work seamlessly with z/OS datasets. I see that this is possible using Zowe-cli from the command line with a zftp profile. Would it be possible to add such functionality in the Zowe Explorer FTP Extensions?
Thank you in advance
Cris

Error in building the package

I am following the Build This Extension instructions and I encountered this error. I installed eslint and prettier manually but it is still happening. No idea why. I just disabled npm run lint when building the package.