You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
When a top-level sushi-config property is incorrectly indented in the YAML file, SUSHI will not process it correctly. This is because it is technically still valid YAML, but the results are likely not what the user intended. For example, something like this is not processed how it it was likely intended:
Consider adding a warning in SUSHI if an item that is expected at the top level of the config file is present but not at the top level.
Some things to consider:
This may be an intentional choice. The YAML is valid so it could be exactly what the user intended. Should we be warning on a case that could be intentional and there will be no way to resolve the warning?
Is this even a case that is feasible to detect with the YAML library we are using?
This is only an issue when a property is incorrectly indented underneath a list because it is grouped with that list. In the above example, without the pages property, SUSHI will already report an error because the YAML is not valid ("All collection items must start at the same column.").
The text was updated successfully, but these errors were encountered:
I'd suggest that maybe we should just warn on any property (in any place) that we don't know how to handle. The case above is a little trickier since it is in the pages object, but even then, a page entry should end in .md or .xml -- so we can still generally detect this.
When a top-level
sushi-config
property is incorrectly indented in the YAML file, SUSHI will not process it correctly. This is because it is technically still valid YAML, but the results are likely not what the user intended. For example, something like this is not processed how it it was likely intended:menu
is considered apage
.Consider adding a warning in SUSHI if an item that is expected at the top level of the config file is present but not at the top level.
Some things to consider:
pages
property, SUSHI will already report an error because the YAML is not valid ("All collection items must start at the same column."
).The text was updated successfully, but these errors were encountered: