Migration Guide from v0.3.2.0
Configuration Changes¶
Following breaking changes needs to be done in your current .headroom.yaml
configuration file in order to make it compatible with version v0.4.0.0:
Bump Configuration Version¶
Because this version brings breaking changes to configuration, it's necessary to bump version (version
field ) or add the field if missing in the .headroom.yaml
to declare it's compatible with Headroom v0.4.0.0
:
version: 0.4.0.0
Rename margin-before
and margin-after
keys¶
Info
This change is part of feature #58, see also related documentation.
Configuration keys margin-before
and margin-after
configuration options were renamed as following:
margin-before
- must be renamed tomargin-top-code
in all occurencesmargin-after
- must be renamed tomargin-bottom-code
in all occurences
Change starts-with
, ends-with
and prefixed-by
to regular expressions¶
Info
This change is part of feature #61, see also related documentation.
Configuration keys starts-with
/ends-with
(under block-comment
key) and prefixed-by
(under line-comment
) now expects regular expressions instead of plain text. Therefore, if you use any of these keys in your custom configuration, you have to change them to regular expressions. Few examples are below:
- change
/*
to^\/\*
- change
*/
to\*\/$