Skip to content
This repository has been archived by the owner on Aug 31, 2021. It is now read-only.

check_for_required_extensions

Marcel Kloubert edited this page Jan 2, 2018 · 1 revision

Home >> Settings >> Check for required extensions

Check for required extensions

Checks for required and/or recommended Visual Studio Code extensions on startup.

{
    "deploy.reloaded": {
        "requiredExtensions": {
            "mkloubert.vscode-git-notify": null,

            "eamodio.gitlens": true,

            "mkloubert.vs-media-player": {
                "isMustHave": false
            }
        }
    }
}

Possible Values

(null)

Shows a warning message, when the extension has not been found.

{
    "deploy.reloaded": {
        "requiredExtensions": {
            "mkloubert.vscode-git-notify": null
        }
    }
}

Bool

Show an error message (true) and skip loading the configuration, when extension has not been found, or show a warning message instead (false).

{
    "deploy.reloaded": {
        "requiredExtensions": {
            "eamodio.gitlens": true,

            "mkloubert.vs-media-player": false
        }
    }
}

Object (settings)

{
    "deploy.reloaded": {
        "requiredExtensions": {
            "eamodio.gitlens": {
                "isMustHave": true,

                "if": " 'mkloubert' === require('os').userInfo().username "
            },

            "mkloubert.vs-media-player": {
                "isMustHave": false,
                
                "platforms": [ "win32" ]
            }
        }
    }
}
Name Description
if One or more conditions (as JavaScript code) that defines if entry is available or not.
isMustHave Show an error message (true) and skip loading the configuration, when extension has not been found, or show a warning message instead (false). Default: (false)
platforms One or more platform names the entry is for, s. process.platform
Clone this wiki locally