Mads::PluginSkill Namespace Reference

Typedefs
using	json = nlohmann::json

Functions
const char *	skill_rel_dir ()
	Where the skill lands inside a plugin project.
int	install (const fs::path &skills_dir, const fs::path &project_dir, const json &data, bool overwrite, bool verbose=true)
	Renders/copies the mads-plugin skill into a plugin project.

Typedef Documentation

json

using Mads::PluginSkill::json = typedef nlohmann::json

Definition at line 42 of file plugin_skill.hpp.

Function Documentation

install()

int Mads::PluginSkill::install ( const fs::path &  skills_dir, const fs::path &  project_dir, const json &  data, bool  overwrite, bool  verbose = true  )

inline

Renders/copies the mads-plugin skill into a plugin project.

Parameters

skills_dir	source directory (<prefix>/share/skills/mads-plugin)
project_dir	the plugin project to write into
data	inja data (mads_version, plugin_protocol, ...)
overwrite	replace files that already exist
verbose	report each file on stdout

Returns

the number of files written; 0 also means "nothing to do"

Definition at line 57 of file plugin_skill.hpp.

References skill_rel_dir().

skill_rel_dir()

const char * Mads::PluginSkill::skill_rel_dir ( )

inline

Where the skill lands inside a plugin project.

Definition at line 45 of file plugin_skill.hpp.

Referenced by install().