Skip to content

Configuration/Settings examples do not show in the settings view for extensions #198690

@deribaucourt

Description

@deribaucourt

When developping a VSCode extension, one may add configuration elements to their package.json. An example field allows to provide the user with examples:

    "configuration": {
      "type": "object",
      "title": "BitBake",
      "properties": {
        "bitbake.commandWrapper": {
          "type": "string",
          "examples": [
            "docker run --rm -v ${workspaceFolder}:${workspaceFolder} crops/poky --workdir=${workspaceFolder} /bin/bash -c",
            "kas shell -c",
            "cqfd run",
            "${workspaceFolder}/build.sh --"
          ],
          "description": "A build tool command to wrap around BitBake commands.\n\nVarious tools provide ways to automatically configure the BitBake environment, or even call it inside containers. This option allows you to use them through this extension by wrapping around the bitbake invocation.\nThe resulting commands generated by this extension will be for example:\n $ commandWrapper 'bitbake core-image-minimal'\nOr, if pathToEnvScript and pathToBuildFolder are defined:\n $ commandWrapper '. pathToEnvScript pathToBuildFolder && bitbake core-image-minimal'\nSee examples."
        }
    }

These examples show as completion items when editing the .vscode/settings.json file:
image

However, they will not show through the Settings Webview:
image

It would be great if these examples could be displayed and suggested to the user through the Settings view. It's the most convenient way for users to configure an extension.

Metadata

Metadata

Assignees

Labels

feature-requestRequest for new features or functionalitysettings-editorVS Code settings editor issues

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions