Package io.github.cdklabs.projen.vscode

Class VsCodeLaunchConfig

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

io.github.cdklabs.projen.Component

io.github.cdklabs.projen.vscode.VsCodeLaunchConfig

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.322Z")
@Stability(Experimental)
public class VsCodeLaunchConfig
extends Component

(experimental) VSCode launch configuration file (launch.json), useful for enabling in-editor debugger.

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
	VsCodeLaunchConfig(VsCode vscode)
protected	VsCodeLaunchConfig(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	VsCodeLaunchConfig(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	addCommandInput(VsCodeLaunchCommandInputEntry cfg)	(experimental) Adds an input variable with type command to .vscode/launch.json.
void	addConfiguration(VsCodeLaunchConfigurationEntry cfg)	(experimental) Adds a VsCodeLaunchConfigurationEntry (e.g.
void	addPickStringInput(VsCodeLaunchPickStringInputEntry cfg)	(experimental) Adds an input variable with type pickString to .vscode/launch.json.
void	addPromptStringInput(VsCodeLaunchPromptStringInputEntry cfg)	(experimental) Adds an input variable with type promptString to .vscode/launch.json.
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

VsCodeLaunchConfig

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

VsCodeLaunchConfig

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

VsCodeLaunchConfig

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

Parameters:

vscode - This parameter is required.

Method Detail

addCommandInput

@Stability(Experimental)
public void addCommandInput(@NotNull
                            VsCodeLaunchCommandInputEntry cfg)

(experimental) Adds an input variable with type command to .vscode/launch.json.

See https://code.visualstudio.com/docs/editor/variables-reference#_input-variables for details.

Parameters:

cfg - VsCodeLaunchCommandInputEntry. This parameter is required.

addConfiguration

@Stability(Experimental)
public void addConfiguration(@NotNull
                             VsCodeLaunchConfigurationEntry cfg)

(experimental) Adds a VsCodeLaunchConfigurationEntry (e.g. a node.js debugger) to `.vscode/launch.json. Each configuration entry has following mandatory fields: type, request and name. See https://code.visualstudio.com/docs/editor/debugging#_launchjson-attributes for details.

Parameters:

cfg - VsCodeLaunchConfigurationEntry. This parameter is required.

addPickStringInput

@Stability(Experimental)
public void addPickStringInput(@NotNull
                               VsCodeLaunchPickStringInputEntry cfg)

(experimental) Adds an input variable with type pickString to .vscode/launch.json.

See https://code.visualstudio.com/docs/editor/variables-reference#_input-variables for details.

Parameters:

cfg - VsCodeLaunchPickStringInputEntry. This parameter is required.

addPromptStringInput

@Stability(Experimental)
public void addPromptStringInput(@NotNull
                                 VsCodeLaunchPromptStringInputEntry cfg)

(experimental) Adds an input variable with type promptString to .vscode/launch.json.

See https://code.visualstudio.com/docs/editor/variables-reference#_input-variables for details.

Parameters:

cfg - VsCodeLaunchPromptStringInputEntry. This parameter is required.

getFile

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