Any way to launch the clprompt webview with a string?

[ptc-abrown]

So as I work to replace our RDi plugin for Implementer with VSCode we have a way to edit a compilation command using code like this

                                      IBMiConnection  system = subsystem.getConnection();
				CLPrompter cp = new CLPrompter(shell, system, compileCommand);

				if(cp.showDialog() == CLPrompter.OK) {
					compileCommand = cp.getCommandString();     // get command string
				} else {
					okToRun = false;
				}

Now I have opened a text document with clprompter installed like this

const doc = await vscode.workspace.openTextDocument({ language: 'cl', content: command});
await vscode.window.showTextDocument(doc);

And I get a nice dialog and formatted untitle document. If clprompter is not installed I guess I am forced to use the document in some way. Although I am asked to name it and save it which is less that ideal. I might be able to use a temporary disc file to avoid this.

In an ideal world I would test to see if clprompter is installed, activate it, and then have the webview come up directly on the command instead of having to have an editor document. Something like:

const command = await vscode.commands.executeCommand('clPrompter.webview', command);
if (command !== '') {
//run compile
}

And I would rather not import all of the webview into my extension. Much easier if I can inherit from your work (which is very very nice BTW - and thank you).

Is this sort of ability on the roadmap?

Thanks.

[bobcozzi]

Solution Available: CLPrompter Public API

Great news! The CL Prompter extension now exposes a public API that solves exactly what you need - prompting CL commands programmatically without requiring editor documents.

Two Approaches

Option 1: Optional Enhancement (Recommended)

Your extension works fine without CLPrompter, but enhances the experience if users have it installed.

1. Create type definitions src/clprompter.d.ts:

declare module 'CozziResearch.clprompter' {
  export function CLPrompter(commandString: string): Promise<string | null>;
}

2. Use with graceful fallback:

import * as vscode from 'vscode';

async function promptCommand(command: string): Promise<string | null> {
    // Check if CLPrompter is available
    const clPrompterExt = vscode.extensions.getExtension('CozziResearch.clprompter');

    if (clPrompterExt) {
        // CLPrompter installed - use it!
        if (!clPrompterExt.isActive) {
            await clPrompterExt.activate();
        }

        try {  // Import the Extension ,if found
            const { CLPrompter } = await import('CozziResearch.clprompter');
            return await CLPrompter(command);
        } catch (error) {
            console.error('CLPrompter error:', error);
            // Fall through to fallback
        }
    }

    // Fallback: Simple input box
    return await vscode.window.showInputBox({
        prompt: 'Edit CL Command',
        value: command,
        placeHolder: 'Install CozziResearch.clprompter for full IBM i prompting'
    }) || command;
}

// Use it
const result = await promptCommand(compileCommand);
if (result && result !== compileCommand) {
    compileCommand = result;
    // Run compile...
}

Benefits:

• Your extension works for everyone
• Enhanced experience if CLPrompter is installed
• No forced dependency
• Users can install CLPrompter later if they want

---

Option 2: Required Dependency

Force users to have CLPrompter (simpler code, but requires all users to install it).

1. Add dependency to package.json:

{
  "extensionDependencies": [
    "CozziResearch.clprompter"
  ]
}

2. Create type definitions src/clprompter.d.ts:

declare module 'CozziResearch.clprompter' {
  export function CLPrompter(commandString: string): Promise<string | null>;
}

3. Use directly:

import { CLPrompter } from 'CozziResearch.clprompter';

// Your original RDi code equivalent:
// if(cp.showDialog() == CLPrompter.OK) {
//     compileCommand = cp.getCommandString();
// }

// VS Code version - much simpler!
const result = await CLPrompter(compileCommand);

if (result && result !== compileCommand) {
    // User made changes - use updated command
    compileCommand = result;
    // Run compile...
} else {
    // User cancelled
}

Benefits:

• Simpler code - no fallback logic needed
• VS Code prompts users to install missing extension automatically

Drawback:

• All users must install CLPrompter

---

Key Features

• No editor document required - No openTextDocument() or showTextDocument() needed
• No file save dialogs - Everything in webview panel
• Clean async/await API - Simple Promise-based interface
• No webview code in your extension - You inherit all the prompter functionality
• Returns updated command string - Just like RDi's getCommandString()
• Works with any CL command - Full parameter validation and special values support

Documentation

Full API documentation with more examples: CLPROMPTER_API.md

---

This is exactly what you asked for - a way to prompt commands without editor documents, check if installed, and get the result back. Much cleaner than the openTextDocument workaround!

Choose the approach that fits your needs:

• Optional (Option 1): Works without CLPrompter, enhanced if installed
• Required (Option 2): Simpler code, auto-installs for users

[ptc-abrown]

I cannot even begin to tell you how much I appreciated the quick response. Problem is it does not work. Why does it now work you ask. * git clone * Hunt through source… I cannot find a return from activate. Functions you might think (like activate()) are exported. But, in fact, to get exports populated you must return. (See code-for-ibmi extension.ts activate return value). vi extension.ts 186 return { 187 CLPrompter, 188 CLPrompterCallback 189. } npm install npm run build vsce package Replace the github version with my local built copy Add src/clprompter.d.ts as documented try { const mod = await import('CozziResearch.clprompter'); if (typeof mod.CLPrompter === 'function') { return await mod.CLPrompter(command); } } catch (error) { console.error('CLPrompter dynamic import failed:', error); return null; } Exception "Cannot find package 'CozziResearch.clprompter' imported from” This DOES work however. const clPrompterExt = vscode.extensions.getExtension('CozziResearch.clprompter'); if (clPrompterExt) { if (!clPrompterExt.isActive) { await clPrompterExt.activate(); } if (clPrompterExt.exports) { const CLPrompter = clPrompterExt.exports.CLPrompter; // assign the imported function to the variable if (typeof CLPrompter === 'function') { try { return await CLPrompter(command); } catch (error) { } } } Don’t get me wrong I would be happy to mark your extension as required. But it helps to just recommend the extension for now. ***@***.*** Thanks again. Alan. From: Bob Cozzi ***@***.***> Reply-To: bobcozzi/clPrompter ***@***.***> Date: Friday, February 20, 2026 at 17:02 To: bobcozzi/clPrompter ***@***.***> Cc: Alan Brown ***@***.***>, Author ***@***.***> Subject: Re: [bobcozzi/clPrompter] Any way to launch the clprompt webview with a string? (Issue #6) [Image removed by sender.]bobcozzi left a comment (bobcozzi/clPrompter#6)<#6 (comment)> Solution Available: CLPrompter Public API Great news! The CL Prompter extension now exposes a public API that solves exactly what you need - prompting CL commands programmatically without requiring editor documents. Two Approaches Option 1: Optional Enhancement (Recommended) Your extension works fine without CLPrompter, but enhances the experience if users have it installed. 1. Create type definitions src/clprompter.d.ts: declare module 'CozziResearch.clprompter' { export function CLPrompter(commandString: string): Promise<string | null>; } 2. Use with graceful fallback: import * as vscode from 'vscode'; async function promptCommand(command: string): Promise<string | null> { // Check if CLPrompter is available const clPrompterExt = vscode.extensions.getExtension('CozziResearch.clprompter'); if (clPrompterExt) { // CLPrompter installed - use it! if (!clPrompterExt.isActive) { await clPrompterExt.activate(); } try { // Import the Extension ,if found const { CLPrompter } = await import('CozziResearch.clprompter'); return await CLPrompter(command); } catch (error) { console.error('CLPrompter error:', error); // Fall through to fallback } } // Fallback: Simple input box return await vscode.window.showInputBox({ prompt: 'Edit CL Command', value: command, placeHolder: 'Install CozziResearch.clprompter for full IBM i prompting' }) || command; } // Use it const result = await promptCommand(compileCommand); if (result && result !== compileCommand) { compileCommand = result; // Run compile... } Benefits: * Your extension works for everyone * Enhanced experience if CLPrompter is installed * No forced dependency * Users can install CLPrompter later if they want

…

________________________________ Option 2: Required Dependency Force users to have CLPrompter (simpler code, but requires all users to install it). 1. Add dependency to package.json: { "extensionDependencies": [ "CozziResearch.clprompter" ] } 2. Create type definitions src/clprompter.d.ts: declare module 'CozziResearch.clprompter' { export function CLPrompter(commandString: string): Promise<string | null>; } 3. Use directly: import { CLPrompter } from 'CozziResearch.clprompter'; // Your original RDi code equivalent: // if(cp.showDialog() == CLPrompter.OK) { // compileCommand = cp.getCommandString(); // } // VS Code version - much simpler! const result = await CLPrompter(compileCommand); if (result && result !== compileCommand) { // User made changes - use updated command compileCommand = result; // Run compile... } else { // User cancelled } Benefits: * Simpler code - no fallback logic needed * VS Code prompts users to install missing extension automatically Drawback: * All users must install CLPrompter

________________________________ Key Features * No editor document required - No openTextDocument() or showTextDocument() needed * No file save dialogs - Everything in webview panel * Clean async/await API - Simple Promise-based interface * No webview code in your extension - You inherit all the prompter functionality * Returns updated command string - Just like RDi's getCommandString() * Works with any CL command - Full parameter validation and special values support Documentation Full API documentation with more examples: CLPROMPTER_API.md<https://github.com/bobcozzi/clPrompter/blob/main/CLPROMPTER_API.md>

________________________________ This is exactly what you asked for - a way to prompt commands without editor documents, check if installed, and get the result back. Much cleaner than the openTextDocument workaround! Choose the approach that fits your needs: * Optional (Option 1): Works without CLPrompter, enhanced if installed * Required (Option 2): Simpler code, auto-installs for users — Reply to this email directly, view it on GitHub<#6 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/APRL5DQJG3VUOKPCHGJAGDT4M5775AVCNFSM6AAAAACV2YFQ56VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZTSMZXGM3DONZSG4>. You are receiving this because you authored the thread.Message ID: ***@***.***>

[bobcozzi]

Are you saying the "Requires my Extension" logic works, but the other "Optional Extension" logic fails? Is that it?

[bobcozzi]

I made a few tweaks and pushed out v0.0.49 that has those changes. Review the CLPROMPTER_API.ms file and try it again. Let me know what you find.