Readable dictionary that backs this configuration.
Indicates if package list is shown, even if there is only one entry.
Indicates if target list is shown, even if there is only one entry.
Always synchronize a local file with a newer one when using 'sync when open' in a package.
Select the workspace by active text editor automatically or not.
Settings for a "quick deploy button".
Inidciates if button is enabled / visible or not.
A list of one or more packages to deploy.
A custom text for the button.
Clear output on startup or not.
A list of one or more script based commands to register.
Activates or deactivates "deploy on change" feature.
Activates or deactivates "deploy on save" feature.
Disables the display of popups that reports for a new version of that extension.
Display loaded plugins in output window or not.
Display network information in output window or not.
Settings for the process's environment.
Automatically import environment variables as placesholders / values.
A list of variables that should NOT use placeholders / values.
One or more variable for the process to define.
One or more global events.
Indicates if a "fast" file check should be used for the list of ignored files (s. 'ignores').
Default value that indicates if a "fast" file check should be used for "deploy on change" feature or not.
Default value that indicates if a "fast" file check should be used for "deploy on save" feature or not.
Default value that indicates if a "fast" file check should be used for "sync when open" feature or not.
Defines an object that contains global values and objects, categorized by its properties.
The time in seconds the result item in the status bar should disapear.
Deploy host settings.
Run on startup or not.
The root directory where files should be stored.
Maximum size of a JSON message.
The path to a module that UNtransforms received message data.
s. 'TranformerModule' interface
The optional options for the "message data" transformer script.
An optional password to use.
The algorithm for the password to use.
The TCP port on that the host should listen.
Show popup if host has been started or stopped successfully.
The path to a module that UNtransforms received file data.
s. 'TranformerModule' interface
The optional options for the "file data" transformer script.
The path to the script that validates received files.
s. 'ValidatorModule' interface
The optional options for the "validator" script.
One or more pattern of files that should be ignored even if a deployment is started for them.
A list of imports.
The ID of the language to use (e.g. 'en', 'de')
List of additional files of plugin modules to load.
A custom machine name.
A list files to open on startup.
Open the output window before deploying starts or not.
Open the output window on startup or not.
List of packages.
Run build task on startup or define the wait time, in milliseconds, after the build task should be run after startup.
Run Git pull on startup or define the wait time, in milliseconds, after Git pull should be run after startup.
Show an item in the status bar after deployment or not.
Indicates if an info popup / notification should be displayed after a successful deployment or not.
Show a warning message if a (single) file has been ignored.
Indicates if a warning popup / notification should be displayed if targets do not exist.
Starts the REST API or not. s. https://github.com/mkloubert/vs-rest-api
Starts the cron jobs or not. s. https://github.com/mkloubert/vs-cron
A list of one or more Visual Studio Code commands that should be run on startup.
Activates or deactivates "sync when open" feature.
List of targets.
A list of template sources.
Allow unparsed (HTML) documents or not.
Path or URL to a HTML footer that should be inserted at the beginning inside the BODY tag of each (default) HTML document.
Path or URL to a HTML header that should be inserted at the beginning inside the BODY tag of each (default) HTML document.
Show default sources or not.
List of one or more sources.
The time (in milliseconds) to wait before activating 'deploy on change' feature.
Also check directory patterns, like in '.gitignore' files, in all packages by default or not.
Use 'targets' property of a package instead, if its 'deployOnSave' property is set to (true).
Use workspace start time for 'sync when open' for all packages by default or not.
A list of one or more values that can be accessed via placeholders in strings, e.g.
Return a value from this configuration.
Configuration name, supports dotted names.
The value section denotes or undefined.
Return a value from this configuration.
Configuration name, supports dotted names.
A value should be returned when no value could be found, is undefined.
The value section denotes or the default.
Check if this configuration has a certain value.
Configuration name, supports dotted names.
true if the section doesn't resolve to undefined.
Retrieve all information about a configuration setting. A configuration value often consists of a default value, a global or installation-wide value, a workspace-specific value and a folder-specific value.
The effective value (returned by get)
is computed like this: defaultValue overwritten by globalValue,
globalValue overwritten by workspaceValue. workspaceValue overwritten by workspaceFolderValue.
Refer to Settings Inheritence
for more information.
Note: The configuration name must denote a leaf in the configuration tree
(editor.fontSize vs editor) otherwise no result is returned.
Configuration name, supports dotted names.
Information about a configuration setting or undefined.
Update a configuration value. The updated configuration values are persisted.
A value can be changed in
Note 1: Setting a global value in the presence of a more specific workspace value has no observable effect in that workspace, but in others. Setting a workspace value in the presence of a more specific folder value has no observable effect for the resources under respective folder, but in others. Refer to Settings Inheritence for more information.
Note 2: To remove a configuration value use undefined, like so: config.update('somekey', undefined)
Will throw error when
workspace.getConfiguration(section, resource))Configuration name, supports dotted names.
The new value.
The configuration target or a boolean value.
- If `true` configuration target is `ConfigurationTarget.Global`.
- If `false` configuration target is `ConfigurationTarget.Workspace`.
- If `undefined` or `null` configuration target is
`ConfigurationTarget.WorkspaceFolder` when configuration is resource specific
`ConfigurationTarget.Workspace` otherwise.
Generated using TypeDoc
Configuration settings.