.ffizer.yaml

ffizer template configuration files

Type object
File match .ffizer.yaml
Schema URL https://catalog.lintel.tools/schemas/schemastore/ffizer-yaml/latest.json
Source https://ffizer.github.io/ffizer/ffizer.schema.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Properties

ignores string[]

list of path from the current template to ignore

Default:
[]
imports ImportCfg[]

list of template to import and to apply as part of this template

Default:
[]
scripts ScriptCfg[]

list of the scripts to apply at end of generation

Default:
[]
use_template_dir boolean

set to true if the template content is under a template folder (not mixed with metadata)

Default: false
variables VariableCfg[]

list of variables/parameters of the template

Default:
[]

Definitions

AnyValue boolean
ImportCfg object

define a template layer to import

uri string required
rev string | null
subfolder string | null
LabelValueCfg object
label string required

display of the value (in select)

value boolean required
ScriptCfg object
cmd string | null

command to execute

default_confirm_answer string | null

default answer for confirmation of execution

message string | null

message to display

VariableCfg object
name string required

name of variable used in the template

ask string | null

sentence to ask the value (default to the name on variable)

default_value AnyValue | null

optionnal default value

hidden string | null

is the variable hidden to the user (could be usefull to cache shared variable/data)

select_in_values VariableValuesCfg | null

if non-empty then the value should selected into the list of value

VariableValuesCfg LabelValueCfg[] | AnyValue[] | string