feat(ibm-use-date-based-format): introduce new validation rule #706
+4,800
−8
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
|
Docs are updated 👍 |
padamstx
reviewed
Dec 19, 2024
dpopp07
force-pushed
the
dp/date-time-rule
branch
2 times, most recently
from
d2d9794 to
a6b5ee1
Compare
hudlow
requested changes
Dec 19, 2024
dpopp07
commented
Dec 20, 2024
dpopp07
force-pushed
the
dp/date-time-rule
branch
from
53d9653 to
0e16a95
Compare
hudlow
reviewed
Dec 30, 2024
hudlow
reviewed
Dec 30, 2024
hudlow
reviewed
Dec 30, 2024
hudlow
reviewed
Dec 30, 2024
hudlow
reviewed
Dec 30, 2024
hudlow
reviewed
Dec 30, 2024
hudlow
reviewed
Dec 30, 2024
6 tasks
hudlow
reviewed
Jan 7, 2025
hudlow
approved these changes
Jan 7, 2025
The comment noted that the rule was using the resolved API definition, when it was, in fact, using the unresolved definition. This wasn't a bug - the rule doesn't look at any locations that might include references - but the documentation was wrong and misleading. This commit fixes that. Signed-off-by: Dustin Popp <[email protected]>
I think this file was added around the same time that the tests were re-organized into folders. It must have been overlooked during the changes. This commit moves it to the right spot and corrects the copyright statement (this file was created in 2024). Signed-off-by: Dustin Popp <[email protected]>
hudlow
reviewed
Jan 7, 2025
This commit introduces the new 'ibm-use-date-based-format' rule, which will heuristically verify that schemas, with either a name or an example value indicating a date-based logical type, be strings and use either "date" or "date-time" as the format. Signed-off-by: Dustin Popp <[email protected]> Co-authored-by: Dan Hudlow <[email protected]>
dpopp07
force-pushed
the
dp/date-time-rule
branch
from
7bac905 to
9b07fb6
Compare
hudlow
reviewed
Jan 7, 2025
| // parses the object, looking for the value at that path. If it finds one, | ||
| // the value will be returned. If not, the function will return `undefined`. | ||
| function getObjectValueAtPath(obj, pathToValue) { | ||
| return pathToValue.reduce((value, field) => value[field], obj); |
There was a problem hiding this comment.
I think this is needed to keep this safe in the case that an undefined property is encountered before the last element of the path.
Suggested change
| return pathToValue.reduce((value, field) => value[field], obj); | |
| return pathToValue.reduce((value, field) => value?.[field], obj); |
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.
PR summary
This commit introduces the new 'ibm-use-date-based-format' rule,
which will heuristically verify that schemas, with either a name
or an example value indicating a date-based logical type, be
strings and use either "date" or "date-time" as the format.
PR Checklist
General checklist
Please make sure that your PR fulfills the following requirements:
.secrets.baselinehas been updated as needednpm run generate-utilities-docshas been run if any files inpackages/utilities/srchave been updatedChecklist for adding a new validation rule: