feat: ✨ add functions to check required and blank fields [3/7] #963
+408
−0
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
martonvago
commented
Jan 10, 2025
Comment on lines
+28
to
+31
| errors += check_list_item_field_not_blank(properties, "contributors", "title") | ||
| errors += check_list_item_field_not_blank(properties, "sources", "title") | ||
| errors += check_list_item_field_not_blank(properties, "licenses", "name") | ||
| errors += check_list_item_field_not_blank(properties, "licenses", "path") |
There was a problem hiding this comment.
These are nested package properties fields (so, technically, fields on contributor properties, source properties, etc.). It would be nice if they were also coming from a constant like the top-level fields from PACKAGE_SPROUT_REQUIRED_FIELDS. Something to keep in mind / return to when we look at these nested properties more closely?
martonvago
changed the title
…/sprout-checks-3-required-and-blank-checks
…/sprout-checks-3-required-and-blank-checks
lwjohnst86
requested changes
Jan 20, 2025
seedcase_sprout/core/sprout_checks/check_list_item_field_not_blank.py
Outdated
Show resolved
Hide resolved
signekb
reviewed
Jan 20, 2025
| A list of errors. An empty list if no errors were found. | ||
| """ | ||
| errors = check_fields_not_blank(properties, PACKAGE_SPROUT_REQUIRED_FIELDS) | ||
| errors += check_list_item_field_not_blank(properties, "contributors", "title") |
There was a problem hiding this comment.
Isn't contributor title just recommended and not required as described here?
Same with sources title?
They are required to have one property, but which property it is isn't specified.
There was a problem hiding this comment.
Yeah, but we have checks for recommendations turned on in Sprout. At least, I turned them on :P
…/sprout-checks-3-required-and-blank-checks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR adds functions for checking that (Sprout-specific) required fields are present and not blank.
This PR needs an in-depth review.
Checklist
just run-all