CLOUDP-272000: Boolean field names avoid "is" prefix #593
Conversation
This file contains hidden or 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
Comment on lines
17
to
25
| if (property.type === 'boolean') { | ||
| if (IS_PREFIX_REGEX.test(input)) { | ||
| const suggestedName = input.charAt(2).toLowerCase() + input.slice(3); | ||
| const errorMessage = `Boolean field "${input}" should not use the "is" prefix. Use "${suggestedName}" instead.`; | ||
| return collectAndReturnViolation(path, RULE_NAME, errorMessage); | ||
| } | ||
| } | ||
|
|
||
| collectAdoption(path, RULE_NAME); |
There was a problem hiding this comment.
Suggested change
| if (property.type === 'boolean') { | |
| if (IS_PREFIX_REGEX.test(input)) { | |
| const suggestedName = input.charAt(2).toLowerCase() + input.slice(3); | |
| const errorMessage = `Boolean field "${input}" should not use the "is" prefix. Use "${suggestedName}" instead.`; | |
| return collectAndReturnViolation(path, RULE_NAME, errorMessage); | |
| } | |
| } | |
| collectAdoption(path, RULE_NAME); | |
| if (property.type !== 'boolean') { | |
| return; | |
| } | |
| if (IS_PREFIX_REGEX.test(input)) { | |
| const suggestedName = input.charAt(2).toLowerCase() + input.slice(3); | |
| const errorMessage = `Boolean field "${input}" should not use the "is" prefix. Use "${suggestedName}" instead.`; | |
| return collectAndReturnViolation(path, RULE_NAME, errorMessage); | |
| } | |
| collectAdoption(path, RULE_NAME); |
Right now it would collect adoption for all properties that aren't booleans
There was a problem hiding this comment.
That's correct, nice catch!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Proposed changes
Jira ticket: CLOUDP-272000
Adds
xgen-IPA-112-boolean-field-names-avoid-is-prefixrule47 violations are found to be exempted in the MMS code
Checklist
Changes to Spectral
Further comments