Package io.github.cdklabs.projen.vscode

Class VsCodeSettings

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

io.github.cdklabs.projen.Component

io.github.cdklabs.projen.vscode.VsCodeSettings

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:43.325Z")
@Stability(Experimental)
public class VsCodeSettings
extends Component

(experimental) VS Code Workspace settings Source: https://code.visualstudio.com/docs/getstarted/settings#_workspace-settings.

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
	VsCodeSettings(VsCode vscode)
protected	VsCodeSettings(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	VsCodeSettings(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	addSetting(String setting, Object value)	(experimental) Adds a workspace setting.
void	addSetting(String setting, Object value, String language)	(experimental) Adds a workspace setting.
void	addSettings(Map<String,Object> settings)	(experimental) Adds a workspace setting.
void	addSettings(Map<String,Object> settings, Object languages)	(experimental) Adds a workspace setting.
JsonFile	getFile()

Methods inherited from class io.github.cdklabs.projen.Component

getProject, isComponent, postSynthesize, preSynthesize, synthesize

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

VsCodeSettings

protected VsCodeSettings(software.amazon.jsii.JsiiObjectRef objRef)

VsCodeSettings

protected VsCodeSettings(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

VsCodeSettings

@Stability(Experimental)
public VsCodeSettings(@NotNull
                      VsCode vscode)

Parameters:

vscode - This parameter is required.

Method Detail

addSetting

@Stability(Experimental)
public void addSetting(@NotNull
                       String setting,
                       @NotNull
                       Object value,
                       @Nullable
                       String language)

(experimental) Adds a workspace setting.

Parameters:

setting - The setting ID. This parameter is required.

value - The value of the setting. This parameter is required.

language - Scope the setting to a specific language.

addSetting

@Stability(Experimental)
public void addSetting(@NotNull
                       String setting,
                       @NotNull
                       Object value)

(experimental) Adds a workspace setting.

Parameters:

setting - The setting ID. This parameter is required.

value - The value of the setting. This parameter is required.

addSettings

@Stability(Experimental)
public void addSettings(@NotNull
                        Map<String,Object> settings,
                        @Nullable
                        Object languages)

(experimental) Adds a workspace setting.

Parameters:

settings - Array structure: [setting: string, value: any, languages?: string[]]. This parameter is required.

languages -

addSettings

@Stability(Experimental)
public void addSettings(@NotNull
                        Map<String,Object> settings)

(experimental) Adds a workspace setting.

Parameters:

settings - Array structure: [setting: string, value: any, languages?: string[]]. This parameter is required.

getFile

@Stability(Experimental)
@NotNull
public JsonFile getFile()