Configuration Reference

The nmk-vscode plugin handles the configuration items listed in this page.

All of them are initiliazed with convenient default values, so that you don’t need to setup them for a default working behavior. You can anyway override them in your project if you need to fine tune the plugin behavior. Some items are specifically designed to be extended by nmk projects and plugins.

Settings

vscodeFolder – VSCode settings folder

Type	Default value
str	${PROJECTDIR}/.vscode

This is the path where VSCode reads its workspace configuration files.

vscodeSettings – VSCode generated settings file

Type	Default value
str	${vscodeFolder}/settings.json

This is the generated VSCode workspace settings file.

vscodeSettingsFiles – VSCode settings files fragments

Type	Default value
List[str]	[“${BASEDIR}/base_settings.json”]

This is a list of VSCode settings file fragments to be merged into the target ${vscodeSettings} generated one.

vscodeSettingsItems – VSCode settings items

Type	Default value
Dict[str,str]	{}

Dictionary of VSCode settings items to be merged into the target ${vscodeSettings} generated one (after all ${vscodeSettingsFiles} files have been merged).

Extensions

vscodeExtensions – VSCode generated recommended extensions file

Type	Default value
str	${vscodeFolder}/extensions.json

This is the generated VSCode workspace recommended extensions file.

vscodeExtensionsNames – VSCode recommended extensions list

Type	Default value
List[str]	[]

List of VSCode recommended extensions to be generated in target ${vscodeExtensions} file.

Automated tasks

vscodeTasks – VSCode generated automated tasks file

Type	Default value
str	${vscodeFolder}/tasks.json

This is the generated VSCode workspace custom tasks file.

vscodeTasksFiles – VSCode task files

Type	Default value
List[str]	[]

This is a list of VSCode task files to be merged into the target ${vscodeTasks} generated one.

vscodeTaskTemplate – nmk task template file

Type	Default value
str	${BASEDIR}/templates/nmk-tasks.json.jinja

This is the template file for generated nmk tasks.

vscodeNmkTasks – VSCode nmk tasks definition

Type	Default value
Dict[str,Dict[str,str]]	see tasks.yml

This a dictionary defining the nmk tasks to be generated into the target ${vscodeTasks} generated task file.

vscodeShellTasks – VSCode shell tasks definition

Type	Default value
Dict[str,Dict[str,str]]	see tasks.yml

This a dictionary defining the simple shell tasks to be generated into the target ${vscodeTasks} generated task file.

vscodeDefaultBuildTask – Default build task

Type	Default value
str	build

This is the name of the generated task to be declared as default (the one invoked when hitting Ctrl+shift+B in VSCode) in the target ${vscodeTasks} generated file.

Launch configurations

vscodeLaunch – VSCode generated launch configurations file

Type	Default value
str	${vscodeFolder}/launch.json

This is the generated VSCode workspace launch configurations file.

vscodeLaunchFiles – VSCode launch configuration files

Type	Default value
List[str]	[]

This is a list of VSCode launch configuration files to be merged into the target ${vscodeLaunch} generated one.