How to open and edit dataset member in vscode using extensibility API?

[JWaters02]

In my (company internal only) vscode extension that supports various TSO utilities to vscode frontend panels, I have an option to open a JCL dataset instead of submitting it directly. I want to call the zowe.ds.editDataSet command, but I have two problems:

1. I am not sure how to get the IZoweDatasetTreeNode reference for the JCL member knowing only its PDS/PDS member name
2. Once I have that, I'm not sure what nodelist or selected members is doing and if it would even allow this to work. Code is from here

vscode.commands.registerCommand("zowe.ds.editDataSet", async (node, nodeList) => {
    let selectedNodes = SharedUtils.getSelectedNodeList(node, nodeList) as IZoweDatasetTreeNode[];
    selectedNodes = selectedNodes.filter((element) => SharedContext.isDs(element) || SharedContext.isDsMember(element));
    for (const item of selectedNodes) {
        await vscode.commands.executeCommand(item.command.command, item.resourceUri);
    }
})

For reference, this is what I am trying to do:

    if (editJcl) {
        // Edit the JCL
        // Get reference to the node of the JCL PDS/member dataset somehow
        const args = [node, node.getChildren()];
        const editJclCmd = `command:zowe.ds.editDataSet?${encodeURIComponent(JSON.stringify(args))}`;
        Gui.showMessage(
            `Edit the ${type} JCL in [${jclDataset}](${editJclCmd})`,
        )
    } else {
        // Submit the JCL
        const jobResponse = await submitJcl(jclDataset, session);
        const args = [sessionName, jobResponse.jobid];
        const setJobCmd = `command:zowe.jobs.setJobSpool?${encodeURIComponent(JSON.stringify(args))}`;
        Gui.showMessage(
            `${type} job submitted [${jobResponse.jobid}](${setJobCmd})`,
        )
    }

The submit JCL command and message works just fine, so the idea of calling the command is not invalid.

I looked at the FileSystemProvider docs but firstly, I could not figure out how to make a valid pdsMemberUri link that actually worked, it just always threw a dataset not found error. And secondly, even if I could, there is no FileSystemProvider API for actually opening that dataset in the editor. Perhaps vscode.window.showTextDocument(pdsMemberUri) could work, but would that allow edits to the file to actually be saved through to the mainframe? I was trying to do this:

        let pdsMemberUri = vscode.Uri.parse("zowe-ds:/zosmf/<censored PDS>/TEST1?fetch=true");
        try {
            // open the member in the editor
            await vscode.window.showTextDocument(pdsMemberUri);
        } catch (err) {
            // an error occurred while trying to fetch the resource; return.
            console.log(err);
            return;
        }

But it can't find the file. Note that I am using vscode.Uri.parse instead of the documented vscode.Uri.from, because the example provided has incorrect syntax and seems to be doing what parse does rather than what from does. Either way, if I ctrl+click on the link with an example PDS and PDS member, it says cannot find file. I am also not using <lpar>.zosmf, only the zosmf bit, because I am using just the zosmf profile, not one split up between different LPARs. Unless this still needs to be specified? But tried anyway with the LPAR name.zosmf and still doesn't work.

Thanks!

[traeok]

Hi @JWaters02,

Thanks for pointing out that the recommended function vscode.Uri.from is incorrect - you are correct that it is meant to be Uri.parse. I've updated the documentation to reflect that.

The steps outlined in "Fetching a resource on demand" should work for looking up resources with the FileSystemProvider. If you want to open the resource in the editor after its been fetched using the vscode.workspace.fs.stat function, you can call vscode.commands.executeCommand with the vscode.open command and the URI:

let pdsMemberUri = vscode.Uri.parse("zowe-ds:/zosmf/<censored PDS>/TEST1?fetch=true");
try {
    const fsEntry = await vscode.workspace.fs.stat(pdsMemberUri);
    pdsMemberUri = pdsMemberUri.with({ query: "" });
} catch (err) {
    console.log(err);
    return;
}

await vscode.commands.executeCommand("vscode.open", pdsMemberUri);

[JWaters02]

Ahh so that's what I was missing... thank you so much for the solution and the quick reply!