Tasks

The nmk-vscode plugin defines the tasks described below.

Setup tasks

All tasks in this chapter are dependencies of the base setup task.

vs.folder – .vscode folder creation

This task creates the .vscode folder in the project, if it doesn’t exist yet.

Property	Value/description
builder	nmk_base.common.MkdirBuilder
output	${vscodeFolder} folder

vs.settings – VSCode settings generation

This task generates the VSCode workspace settings file, from provided settings fragments and items.

Property	Value/description
builder	nmk_vscode.builders.SettingsBuilder
input	${vscodeSettingsFiles} fragment files
output	${vscodeSettings} file
deps	vs.folder task

The builder is called with the following parameters mapping:

Name	Value
files	${vscodeSettingsFiles}
items	${vscodeSettingsItems}

vs.extensions – VSCode recommended extensions generation

This task generates the VSCode workspace recommended extensions file, from provided config items.

Property	Value/description
builder	nmk_vscode.builders.ExtensionsBuilder
input	${BASEDIR}/extensions.yml
output	${vscodeExtensions} file
deps	vs.folder task

The builder is called with the following parameters mapping:

Name	Value
names	${vscodeExtensionsNames}

vs.tasks – VSCode automated tasks generation

This task generates the VSCode workspace custom tasks file, from provided config items.

Property	Value/description
builder	nmk_vscode.builders.TasksBuilder
inputs	${vscodeTasksFiles} files ${vscodeNmkTaskTemplate} file
output	${vscodeTasks} file
deps	vs.folder task

The builder is called with the following parameters mapping:

Name	Value
files	${vscodeTasksFiles}
nmk_task_template	${vscodeNmkTaskTemplate}
nmk_tasks	${vscodeNmkTasks}
default_task	${vscodeDefaultBuildTask}

vs.launch – VSCode launch configurations generation

This task generates the VSCode workspace launch configurations file, from provided config items.

Property	Value/description
builder	nmk_vscode.builders.LaunchBuilder
input	${vscodeLaunchFiles} files
output	${vscodeLaunch} file
deps	vs.folder task
if	${vscodeLaunchFiles} item is not empty

The builder is called with the following parameters mapping:

Name	Value
files	${vscodeLaunchFiles}