-
Notifications
You must be signed in to change notification settings - Fork 14
CLOUDP-272000: Boolean field names avoid "is" prefix #593
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
180 changes: 180 additions & 0 deletions
180
tools/spectral/ipa/__tests__/IPA112BooleanFieldNamesAvoidIsPrefix.test.js
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,180 @@ | ||
| import testRule from './__helpers__/testRule'; | ||
| import { DiagnosticSeverity } from '@stoplight/types'; | ||
|
|
||
| testRule('xgen-IPA-112-boolean-field-names-avoid-is-prefix', [ | ||
| { | ||
| name: 'valid schema - no "is" prefix in boolean fields', | ||
| document: { | ||
| components: { | ||
| schemas: { | ||
| SchemaName: { | ||
| properties: { | ||
| enabled: { type: 'boolean' }, | ||
| active: { type: 'boolean' }, | ||
| disabled: { type: 'boolean' }, | ||
| isString: { type: 'string' }, | ||
| visible: { type: 'boolean' }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| paths: { | ||
| '/users': { | ||
| post: { | ||
| requestBody: { | ||
| content: { | ||
| 'application/vnd.atlas.2024-01-01+json': { | ||
| schema: { | ||
| type: 'object', | ||
| properties: { | ||
| available: { type: 'boolean' }, | ||
| paused: { type: 'boolean' }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| responses: { | ||
| 201: { | ||
| content: { | ||
| 'application/vnd.atlas.2024-01-01+json': { | ||
| schema: { | ||
| type: 'object', | ||
| properties: { | ||
| valid: { type: 'boolean' }, | ||
| hidden: { type: 'boolean' }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| errors: [], | ||
| }, | ||
| { | ||
| name: 'invalid schema - with "is" prefix in boolean fields', | ||
| document: { | ||
| components: { | ||
| schemas: { | ||
| SchemaName: { | ||
| properties: { | ||
| isEnabled: { type: 'boolean' }, | ||
| isActive: { type: 'boolean' }, | ||
| isError: { type: 'boolean' }, | ||
| isString: { type: 'string' }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| paths: { | ||
| '/users': { | ||
| post: { | ||
| requestBody: { | ||
| content: { | ||
| 'application/vnd.atlas.2024-01-01+json': { | ||
| schema: { | ||
| type: 'object', | ||
| properties: { | ||
| isAvailable: { type: 'boolean' }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| responses: { | ||
| 201: { | ||
| content: { | ||
| 'application/vnd.atlas.2024-01-01+json': { | ||
| schema: { | ||
| type: 'object', | ||
| properties: { | ||
| isValid: { type: 'boolean' }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| errors: [ | ||
| { | ||
| code: 'xgen-IPA-112-boolean-field-names-avoid-is-prefix', | ||
| message: 'Boolean field "isEnabled" should not use the "is" prefix. Use "enabled" instead.', | ||
| path: ['components', 'schemas', 'SchemaName', 'properties', 'isEnabled'], | ||
| severity: DiagnosticSeverity.Warning, | ||
| }, | ||
| { | ||
| code: 'xgen-IPA-112-boolean-field-names-avoid-is-prefix', | ||
| message: 'Boolean field "isActive" should not use the "is" prefix. Use "active" instead.', | ||
| path: ['components', 'schemas', 'SchemaName', 'properties', 'isActive'], | ||
| severity: DiagnosticSeverity.Warning, | ||
| }, | ||
| { | ||
| code: 'xgen-IPA-112-boolean-field-names-avoid-is-prefix', | ||
| message: 'Boolean field "isError" should not use the "is" prefix. Use "error" instead.', | ||
| path: ['components', 'schemas', 'SchemaName', 'properties', 'isError'], | ||
| severity: DiagnosticSeverity.Warning, | ||
| }, | ||
| { | ||
| code: 'xgen-IPA-112-boolean-field-names-avoid-is-prefix', | ||
| message: 'Boolean field "isAvailable" should not use the "is" prefix. Use "available" instead.', | ||
| path: [ | ||
| 'paths', | ||
| '/users', | ||
| 'post', | ||
| 'requestBody', | ||
| 'content', | ||
| 'application/vnd.atlas.2024-01-01+json', | ||
| 'schema', | ||
| 'properties', | ||
| 'isAvailable', | ||
| ], | ||
| severity: DiagnosticSeverity.Warning, | ||
| }, | ||
| { | ||
| code: 'xgen-IPA-112-boolean-field-names-avoid-is-prefix', | ||
| message: 'Boolean field "isValid" should not use the "is" prefix. Use "valid" instead.', | ||
| path: [ | ||
| 'paths', | ||
| '/users', | ||
| 'post', | ||
| 'responses', | ||
| '201', | ||
| 'content', | ||
| 'application/vnd.atlas.2024-01-01+json', | ||
| 'schema', | ||
| 'properties', | ||
| 'isValid', | ||
| ], | ||
| severity: DiagnosticSeverity.Warning, | ||
| }, | ||
| ], | ||
| }, | ||
| { | ||
| name: 'schema with exception - "is" prefix with exception', | ||
| document: { | ||
| components: { | ||
| schemas: { | ||
| SchemaName: { | ||
| properties: { | ||
| isEnabled: { | ||
| type: 'boolean', | ||
| 'x-xgen-IPA-exception': { | ||
| 'xgen-IPA-112-boolean-field-names-avoid-is-prefix': 'Reason', | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| errors: [], | ||
| }, | ||
| ]); |
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
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
26 changes: 26 additions & 0 deletions
26
tools/spectral/ipa/rulesets/functions/IPA112BooleanFieldNamesAvoidIsPrefix.js
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| import { collectAdoption, collectAndReturnViolation, collectException } from './utils/collectionUtils.js'; | ||
| import { hasException } from './utils/exceptions.js'; | ||
| import { resolveObject } from './utils/componentUtils.js'; | ||
|
|
||
| const RULE_NAME = 'xgen-IPA-112-boolean-field-names-avoid-is-prefix'; | ||
| const IS_PREFIX_REGEX = /^is[A-Z]/; | ||
|
|
||
| export default (input, options, { path, documentInventory }) => { | ||
| const oas = documentInventory.resolved; | ||
| const property = resolveObject(oas, path); | ||
|
|
||
| if (hasException(property, RULE_NAME)) { | ||
| collectException(property, RULE_NAME, path); | ||
| return; | ||
| } | ||
|
|
||
| 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); | ||
| }; | ||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Right now it would collect adoption for all properties that aren't booleans
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's correct, nice catch!