Class VscodeConfigurator

java.lang.Object

org.jdrupes.builder.core.AbstractProvider

org.jdrupes.builder.core.AbstractGenerator

org.jdrupes.builder.vscode.VscodeConfigurator

All Implemented Interfaces:

Generator, Renamable, ResourceProvider

public class VscodeConfigurator
extends AbstractGenerator

The VscodeConfigurator provides the resource VscodeConfiguration. The configuration consists of the configuration files:

• .vscode/settings.json
• .vscode/launch.json
• .vscode/tasks.json

Each generated data structure can be post processed by a corresponding adapt method before being written to disk.

VS Code relies on the .project and .classpath files as used by eclipse for its java support. Currently, the configurator does not generate these files. Use the eclipse configurator in addition.

Constructor Summary

Constructors

Constructor	Description
VscodeConfigurator(Project project)	Initializes a new vscode configurator.

Method Summary

Modifier and Type	Method	Description
VscodeConfigurator	adaptConfiguration(Runnable adaptor)	Allow the user to add additional resources.
VscodeConfigurator	adaptLaunch(Consumer<Map<String,Object>> adaptor)	Allow the user to adapt the launch data structure before writing.
VscodeConfigurator	adaptSettings(Consumer<Map<String,Object>> adaptor)	Allow the user to adapt the settings data structure before writing.
VscodeConfigurator	adaptTasks(Consumer<Map<String,Object>> adaptor)	Allow the user to adapt the tasks data structure before writing.
protected <T extends Resource> Stream<T>	doProvide(ResourceRequest<T> requested)	Invoked by ResourceProviderSpi.provide(ResourceRequest) after checking if the invocation is allowed.
VscodeConfigurator	jdk(String version, Path location)	VSCode does not have a central JDK registry.

Methods inherited from class AbstractGenerator

cleanup, name, project, toString

Methods inherited from class AbstractProvider

context, name, of, rename, vavrStream

Methods inherited from class Object

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

Methods inherited from interface ResourceProvider

context, name, of, of, resources

Constructor Details

VscodeConfigurator

public VscodeConfigurator(Project project)

Initializes a new vscode configurator.

Parameters:

project - the project

Method Details

adaptSettings

public VscodeConfigurator adaptSettings(Consumer<Map<String,Object>> adaptor)

Allow the user to adapt the settings data structure before writing.

Parameters:

adaptor - the adaptor

Returns:

the vscode configurator

jdk

public VscodeConfigurator jdk(String version,
 Path location)

VSCode does not have a central JDK registry. JDKs can therefore be configured with this method.

Parameters:

version - the version

location - the location

Returns:

the vscode configurator

doProvide

protected <T extends Resource> Stream<T> doProvide(ResourceRequest<T> requested)

Description copied from class: AbstractProvider

Invoked by ResourceProviderSpi.provide(ResourceRequest) after checking if the invocation is allowed.

Specified by:

doProvide in class AbstractProvider

Type Parameters:

T - the generic type

Parameters:

requested - the request for resources

Returns:

the stream

adaptLaunch

public VscodeConfigurator adaptLaunch(Consumer<Map<String,Object>> adaptor)

Allow the user to adapt the launch data structure before writing. The version and an empty list for "configurations" has already be added.

Parameters:

adaptor - the adaptor

Returns:

the vscode configurator

adaptTasks

public VscodeConfigurator adaptTasks(Consumer<Map<String,Object>> adaptor)

Allow the user to adapt the tasks data structure before writing.

Parameters:

adaptor - the adaptor

Returns:

the vscode configurator

adaptConfiguration

public VscodeConfigurator adaptConfiguration(Runnable adaptor)

Allow the user to add additional resources.

Parameters:

adaptor - the adaptor

Returns:

the eclipse configurator