sf command runner md

up and running

npm install


sff vsce command runner
sff vscode ext

# vscode send text to terminal
sth terminal.sendText

VSCode Command Runner

WARN!!!

don't use this extension, it is for my personal learning!!!

Use offial project from author https://marketplace.visualstudio.com/items?itemName=edonet.vscode-command-runner

Run custom shell command defined in vs code configuration and node module package.json

start 'https://github.com/dumpvn/command-runner' start https://code.visualstudio.com/api/references/contribution-points#keybinding-example npm install

Features

Run custom shell command
Run selected content as shell command
Run custom shell command with selected files by explorer context menu

Extension Settings

You can defined shell command in vs code configuration

{
    "command-runner.terminal.name": "runCommand",
    "command-runner.terminal.autoClear": true,
    "command-runner.terminal.autoFocus": true,
    "command-runner.commands": {
        "echo workspaceFolder": "echo ${workspaceFolder}",
        "echo file": "echo ${file}"
    }
}

or in node module package.json

{
    "commands": {
        "echo workspaceFolder": "echo ${workspaceFolder}",
        "echo file": "echo ${file}"
    }
}

Key Binding

You can bind custom keys for the command which defined in configuration

{
    "key": "ctrl+alt+1",
    "command": "command-runner.run",
    "args": { "command": "echo file" }
}

Terminal Options

You can customize the terminal for the command

{
    "key": "ctrl+alt+1",
    "command": "command-runner.run",
    "args": {
        "command": "echo file",
        "terminal": "runCommand"
    }
}

{
    "key": "ctrl+alt+1",
    "command": "command-runner.run",
    "args": {
        "terminal": {
            "name": "runCommand",
            "cwd": "path/to/runCommand",
            "shellArgs": [],
            "autoClear": true,
            "autoFocus": true
        }
    }
}

Predefined Variable

${file}: activated file path;
${fileBasename}: activated file basename;
${fileBasenameNoExtension}: activated file basename with no extension;
${fileDirname}: activated file dirname;
${fileExtname}: activated file extension;
${lineNumber}: the first selected line number;
${lineNumbers}: the all selected line number, eg. 41,46,80;
${selectedText}: the first selected text;
${selectedTextList}: the all selected text list, eg. sl1 sl2;
${selectedTextSection}: the all selected text section, eg. sl1\nsl2;
${selectedPosition}: the selected position list, eg. 21,6;
${selectedPositionList}: the all selected position list, eg. 45,6 80,18 82,5;
${relativeFile}: activated file relative path;
${workspaceFolder}: activated workspace folder path;
${workspaceFolderBasename}: activated workspace folder basename;
${homedir}: the home directory of the current user;
${tmpdir}: default directory for temporary files;
${platform}: os platform;
${env:PATH}: shell environment variable "PATH";
${config:editor.fontSize}: vscode config variable;
${command:workbench.action.terminal.clear}: run vscode command;
${input}: input a value as parameter;
${input:defaultValue}: input a value as parameter, and specify the default value;

Usages

use shortcut Ctrl+Shift+R to select custom command
use shortcut Ctrl+Shift+Enter to run selected content as shell command, if there is no selection, the current line will be executed.
or press F1 and then select/type Run Command or Run In Terminal,
or right click the Text Editor and then click Run Command to select custom command in editor context menu
or right click the Text Editor and then click Run In Terminal to run selected content as shell command in editor context menu

showQuickPick allow new value

const choices = ['a', 'b']

async function getUserSelectdValue() {
    return new Promise((resolve) => {
        const quickPick = window.createQuickPick();
        quickPick.items = choices.map(choice => ({ label: choice }));

        quickPick.title = 'Choose your favorite value:'

        quickPick.onDidChangeValue(() => {
            // INJECT user values into proposed values
            if (!choices.includes(quickPick.value)) quickPick.items = [quickPick.value, ...choices].map(label => ({ label }))
        })

        quickPick.onDidAccept(() => {
            const selection = quickPick.activeItems[0]
            resolve(selection.label)
            quickPick.hide()
        })
        quickPick.show();
    })
}