fix(ls): process schema 'null' / 'nullable' depending on spec version #2982
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
char0n
added
enhancement
char0n
reviewed
Jul 25, 2023
| @@ -56,6 +57,7 @@ import thenNonIfLint from './then--non-if'; | |||
| import thenTypeLint from './then--type'; | |||
| import titleTypeLint from './title--type'; | |||
| import typeTypeLint from './type--type'; | |||
| import typeTypeLintOpenApi30 from './type--type-openapi-3-0'; | |||
There was a problem hiding this comment.
Just consistent naming with the rest of config
Suggested change
| import typeTypeLintOpenApi30 from './type--type-openapi-3-0'; | |
| import typeTypeOpenAPI3_0Lint from './type--type-openapi-3-0'; |
There was a problem hiding this comment.
@char0n
this doesn't seem to be liked by linter:
Variable name typeTypeOpenAPI3_0Lint must match one of the following formats: camelCase, PascalCase, UPPER_CASE
There was a problem hiding this comment.
Yep, we disable it inline as in
We use this convention for element names containing version numbers as well.
char0n
reviewed
Jul 25, 2023
| import { LinterMeta } from '../../../../apidom-language-types'; | ||
|
|
||
| const nullableNotRecommendedLint: LinterMeta = { | ||
| code: ApilintCodes.SCHEMA_EXAMPLE_DEPRECATED, |
There was a problem hiding this comment.
new code needs to be created and assigned here
char0n
reviewed
Jul 25, 2023
| const nullableNotRecommendedLint: LinterMeta = { | ||
| code: ApilintCodes.SCHEMA_EXAMPLE_DEPRECATED, | ||
| source: 'apilint', | ||
| message: 'nullable has no special meaning, if not set on purpose use "type=null" instead', |
There was a problem hiding this comment.
value of type must always be string even in case of the null type. This will avoid some confusion that this message might trigger
Suggested change
| message: 'nullable has no special meaning, if not set on purpose use "type=null" instead', | |
| message: 'nullable has no special meaning, if not set on purpose use `type="null"` instead', |
char0n
reviewed
Jul 25, 2023
| @@ -120,6 +123,7 @@ const schemaLints = [ | |||
| thenTypeLint, | |||
| titleTypeLint, | |||
| typeTypeLint, | |||
| typeTypeLintOpenApi30, | |||
There was a problem hiding this comment.
Suggested change
| typeTypeLintOpenApi30, | |
| typeTypeOpenAPI3_0Lint, |
char0n
reviewed
Jul 25, 2023
| import ApilintCodes from '../../../codes'; | ||
| import { LinterMeta } from '../../../../apidom-language-types'; | ||
|
|
||
| const typeTypeLintOpenApi30: LinterMeta = { |
There was a problem hiding this comment.
Suggested change
| const typeTypeLintOpenApi30: LinterMeta = { | |
| const typeTypeOpenAPI3_0Lint: LinterMeta = { |
frantuma
force-pushed
the
fix-null-nullable
branch
from
32def07
to
b83f9ea
Compare
frankkilcommins
pushed a commit
to frankkilcommins/apidom
that referenced
this pull request
Sep 19, 2023
Error code duplicates were uncovered by eslint related libs update. Closes swagger-api#2982 Closes swagger-api#2923
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.
Differentiates behavior for type
nullvalidation/completion depending on spec/version, also add validation rule fornullableadding hint for all asyncapi and openapi spec versions except openapi 3.0.x. AsyncAPI also included as users can typically come from openapi 3.0 when designing an AsyncAPI spec