Does theia's keybinding support calling commands with args?

[HaoboGu]

Hello, I'm migrating my vscode extension to theia. In my vscode extension, I defined a command and bind it with a shortcut:

      {
        "command": "mycommand",
        "args": 1,
        "key": "shift+ctrl+1",
        "mac": "shift+ctrl+1"
      },

I registered mycommand in extension.ts:

vscode.commands.registerCommand('mycommand', async (order: number) => {
  console.log(order);
   ... logic here
})

I got 0 printed in console, it seems that theia doesn't support add args to keybinding?

[vince-fugnitto]

@HaoboGu thank you for the discussion, do you have an example vscode extension where setting the args in the package.json works correctly? I tried a similar use-case as yours (writing args in the package.json) and it did not work in vscode.

[HaoboGu]

@vince-fugnitto Thanks for the reply!

The following is the sample package.json and extension.ts that work in vscode:

{
	"name": "test",
	"displayName": "test",
	"description": "",
	"version": "0.0.1",
	"engines": {
		"vscode": "^1.50.0"
	},
	"categories": [
		"Other"
	],
	"activationEvents": [
		"onCommand:test.helloWorld"
	],
	"main": "./dist/extension.js",
	"contributes": {
		"commands": [
			{
				"command": "test.helloWorld",
				"title": "Hello World"
			}
		],
		"keybindings": [
			{
				"command": "test.helloWorld",
				"args": 1,
				"key": "shift+ctrl+1",
				"mac": "shift+ctrl+1"
			},
			{
				"command": "test.helloWorld",
				"args": 2,
				"key": "shift+ctrl+2",
				"mac": "shift+ctrl+2"
			}
		]
	},
	"scripts": {
		"vscode:prepublish": "npm run package",
		"compile": "webpack",
		"watch": "webpack --watch",
		"package": "webpack --mode production --devtool hidden-source-map",
		"test-compile": "tsc -p ./",
		"test-watch": "tsc -watch -p ./",
		"pretest": "npm run test-compile && npm run lint",
		"lint": "eslint src --ext ts",
		"test": "node ./out/test/runTest.js"
	},
	"devDependencies": {
		"@types/vscode": "^1.53.0",
		"@types/glob": "^7.1.3",
		"@types/mocha": "^8.0.4",
		"@types/node": "^12.11.7",
		"eslint": "^7.19.0",
		"@typescript-eslint/eslint-plugin": "^4.14.1",
		"@typescript-eslint/parser": "^4.14.1",
		"glob": "^7.1.6",
		"mocha": "^8.2.1",
		"typescript": "^4.1.3",
		"vscode-test": "^1.5.0",
		"ts-loader": "^8.0.14",
		"webpack": "^5.19.0",
		"webpack-cli": "^4.4.0"
	}
}

extension.ts

// The module 'vscode' contains the VS Code extensibility API
// Import the module and reference it with the alias vscode in your code below
import * as vscode from 'vscode';

// this method is called when your extension is activated
// your extension is activated the very first time the command is executed
export function activate(context: vscode.ExtensionContext) {

	// Use the console to output diagnostic information (console.log) and errors (console.error)
	// This line of code will only be executed once when your extension is activated
	console.log('Congratulations, your extension "test" is now active!');

	// The command has been defined in the package.json file
	// Now provide the implementation of the command with registerCommand
	// The commandId parameter must match the command field in package.json
	let disposable = vscode.commands.registerCommand('test.helloWorld', (order: number) => {
		// The code you place here will be executed every time your command is executed

		// Display a message box to the user
		vscode.window.showInformationMessage(String(order));
	});

	context.subscriptions.push(disposable);
}

// this method is called when your extension is deactivated
export function deactivate() {}

You can follow the instruction of vscode to initialize the extension: https://code.visualstudio.com/api/get-started/your-first-extension

Here is the working screen shot(the command is triggered by shortcut set in package.json)

[vince-fugnitto]

@HaoboGu thank you for responding, with your additional information I was able to reproduce the feature in both vscode and theia to see their behavior 👍 I noticed like you've mentioned that the args defined by keybindings are not respected by the framework when triggering commands.

Would you mind opening a "bug issue" regarding your findings?

[HaoboGu]

Thanks for the response. I'll open an issue later.

[vince-fugnitto]

Opened follow-up issue: #9126
Thank you for the report!