Skip to content

Latest commit

 

History

History
19 lines (16 loc) · 3.87 KB

RULES.md

File metadata and controls

19 lines (16 loc) · 3.87 KB

Lints

This file contains a list of all lints checked by yml2block.

Rule Name Rule id Level Test
unique_names b001 ERROR Ensure that within a block (e.g. DatasetField) all names are unique.
block_is_list b002 ERROR Ensure that each block content is a valid yaml list.
unique_titles b003 ERROR Ensure that within the DatasetField block all titles are unique.
keywords_valid k001 ERROR Ensure top level keywords (i.e. block names) are present and contain no typos.
keywords_unique k002 ERROR Ensure no top level keyword occurs multiple times.
keys_valid e001 ERROR Ensure that no invalid keys are present, e.g. through typos.
required_keys_present e002 ERROR Ensure that all required keys for the block entry are present (e.g. DatasetField has a name, etc. ...).
no_substructures e003 ERROR Ensure entries in yaml format have no unexpected substructures but adhere to dataverse-compatible format.
no_trailing_spaces e004 WARNING Ensure that block entries do not have trailing white spaces.
nested_compound_metadata e005 WARNING Ensure no nested compound metadata are present (cf. IQSS/dataverse#9911). Entries with controlled vocabs are more dangerous (ERROR), entries without are acceptable (WARNING).
nested_compound_metadata e006 ERROR Ensure no nested compound metadata using controlled vocabs are present (cf. IQSS/dataverse#9911). Entries with controlled vocabs are more dangerous (ERROR), entries without are acceptable (WARNING).