-
Notifications
You must be signed in to change notification settings - Fork 17
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(apidom-ls): create schema rule for missing core keywords
fix #3549
- Loading branch information
Showing
13 changed files
with
467 additions
and
0 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
export const AsyncAPI200 = [{ namespace: 'asyncapi', version: '2.0.0' }]; | ||
export const AsyncAPI210 = [{ namespace: 'asyncapi', version: '2.1.0' }]; | ||
export const AsyncAPI220 = [{ namespace: 'asyncapi', version: '2.2.0' }]; | ||
export const AsyncAPI230 = [{ namespace: 'asyncapi', version: '2.3.0' }]; | ||
export const AsyncAPI240 = [{ namespace: 'asyncapi', version: '2.4.0' }]; | ||
export const AsyncAPI250 = [{ namespace: 'asyncapi', version: '2.5.0' }]; | ||
export const AsyncAPI260 = [{ namespace: 'asyncapi', version: '2.6.0' }]; | ||
|
||
export const AsyncAPI2 = [ | ||
...AsyncAPI200, | ||
...AsyncAPI210, | ||
...AsyncAPI220, | ||
...AsyncAPI230, | ||
...AsyncAPI240, | ||
...AsyncAPI250, | ||
...AsyncAPI260, | ||
]; |
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
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
73 changes: 73 additions & 0 deletions
73
packages/apidom-ls/src/config/common/schema/lint/missing-core-fields-asyncapi-2.ts
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,73 @@ | ||
import { DiagnosticSeverity } from 'vscode-languageserver-types'; | ||
|
||
import ApilintCodes from '../../../codes'; | ||
import { LinterMeta } from '../../../../apidom-language-types'; | ||
import { AsyncAPI2 } from '../../../asyncapi/target-specs'; | ||
|
||
// eslint-disable-next-line @typescript-eslint/naming-convention | ||
const missingCoreFieldsAsyncAPI2Lint: LinterMeta = { | ||
code: ApilintCodes.SCHEMA_MISSING_CORE_FIELDS, | ||
source: 'apilint', | ||
message: 'Schema does not include any Schema Object keywords', | ||
severity: DiagnosticSeverity.Hint, | ||
linterFunction: 'existAnyOfFields', | ||
linterParams: [ | ||
[ | ||
'$id', | ||
'$schema', | ||
'$comment', | ||
'$ref', | ||
'if', | ||
'then', | ||
'else', | ||
'contentEncoding', | ||
'contentMediaType', | ||
'contains', | ||
'propertyNames', | ||
'const', | ||
'examples', | ||
'multipleOf', | ||
'maximum', | ||
'exclusiveMaximum', | ||
'minimum', | ||
'exclusiveMinimum', | ||
'maxLength', | ||
'minLength', | ||
'pattern', | ||
'additionalItems', | ||
'items', | ||
'maxItems', | ||
'minItems', | ||
'uniqueItems', | ||
'patternProperties', | ||
'dependencies', | ||
'definitions', | ||
'maxProperties', | ||
'minProperties', | ||
'required', | ||
'properties', | ||
'additionalProperties', | ||
'enum', | ||
'type', | ||
'allOf', | ||
'anyOf', | ||
'oneOf', | ||
'not', | ||
'title', | ||
'description', | ||
'default', | ||
'format', | ||
'readOnly', | ||
'writeOnly', | ||
'discriminator', | ||
'externalDocs', | ||
'deprecated', | ||
], | ||
true, | ||
'boolean', | ||
], | ||
marker: 'key', | ||
targetSpecs: [...AsyncAPI2], | ||
}; | ||
|
||
export default missingCoreFieldsAsyncAPI2Lint; |
55 changes: 55 additions & 0 deletions
55
packages/apidom-ls/src/config/common/schema/lint/missing-core-fields-openapi-2-0.ts
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
import { DiagnosticSeverity } from 'vscode-languageserver-types'; | ||
|
||
import ApilintCodes from '../../../codes'; | ||
import { LinterMeta } from '../../../../apidom-language-types'; | ||
import { OpenAPI2 } from '../../../openapi/target-specs'; | ||
|
||
// eslint-disable-next-line @typescript-eslint/naming-convention | ||
const missingCoreFieldsOpenAPI2Lint: LinterMeta = { | ||
code: ApilintCodes.SCHEMA_MISSING_CORE_FIELDS, | ||
source: 'apilint', | ||
message: 'Schema does not include any Schema Object keywords', | ||
severity: DiagnosticSeverity.Hint, | ||
linterFunction: 'existAnyOfFields', | ||
linterParams: [ | ||
[ | ||
'$ref', | ||
'multipleOf', | ||
'maximum', | ||
'exclusiveMaximum', | ||
'minimum', | ||
'exclusiveMinimum', | ||
'maxLength', | ||
'minLength', | ||
'pattern', | ||
'additionalItems', | ||
'items', | ||
'maxItems', | ||
'minItems', | ||
'uniqueItems', | ||
'maxProperties', | ||
'minProperties', | ||
'required', | ||
'properties', | ||
'additionalProperties', | ||
'enum', | ||
'type', | ||
'allOf', | ||
'title', | ||
'description', | ||
'default', | ||
'format', | ||
'readOnly', | ||
'discriminator', | ||
'externalDocs', | ||
'xml', | ||
'example', | ||
], | ||
true, | ||
'boolean', | ||
], | ||
marker: 'key', | ||
targetSpecs: [...OpenAPI2], | ||
}; | ||
|
||
export default missingCoreFieldsOpenAPI2Lint; |
61 changes: 61 additions & 0 deletions
61
packages/apidom-ls/src/config/common/schema/lint/missing-core-fields-openapi-3-0.ts
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
import { DiagnosticSeverity } from 'vscode-languageserver-types'; | ||
|
||
import ApilintCodes from '../../../codes'; | ||
import { LinterMeta } from '../../../../apidom-language-types'; | ||
import { OpenAPI30 } from '../../../openapi/target-specs'; | ||
|
||
// eslint-disable-next-line @typescript-eslint/naming-convention | ||
const missingCoreFieldsOpenAPI3_0Lint: LinterMeta = { | ||
code: ApilintCodes.SCHEMA_MISSING_CORE_FIELDS, | ||
source: 'apilint', | ||
message: 'Schema does not include any Schema Object keywords', | ||
severity: DiagnosticSeverity.Hint, | ||
linterFunction: 'existAnyOfFields', | ||
linterParams: [ | ||
[ | ||
'$ref', | ||
'multipleOf', | ||
'maximum', | ||
'exclusiveMaximum', | ||
'minimum', | ||
'exclusiveMinimum', | ||
'maxLength', | ||
'minLength', | ||
'pattern', | ||
'additionalItems', | ||
'items', | ||
'maxItems', | ||
'minItems', | ||
'uniqueItems', | ||
'maxProperties', | ||
'minProperties', | ||
'required', | ||
'properties', | ||
'additionalProperties', | ||
'enum', | ||
'type', | ||
'allOf', | ||
'anyOf', | ||
'oneOf', | ||
'not', | ||
'title', | ||
'description', | ||
'default', | ||
'format', | ||
'readOnly', | ||
'nullable', | ||
'discriminator', | ||
'externalDocs', | ||
'writeOnly', | ||
'xml', | ||
'example', | ||
'deprecated', | ||
], | ||
true, | ||
'boolean', | ||
], | ||
marker: 'key', | ||
targetSpecs: [...OpenAPI30], | ||
}; | ||
|
||
export default missingCoreFieldsOpenAPI3_0Lint; |
87 changes: 87 additions & 0 deletions
87
packages/apidom-ls/src/config/common/schema/lint/missing-core-fields-openapi-3-1.ts
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,87 @@ | ||
import { DiagnosticSeverity } from 'vscode-languageserver-types'; | ||
|
||
import ApilintCodes from '../../../codes'; | ||
import { LinterMeta } from '../../../../apidom-language-types'; | ||
import { OpenAPI31 } from '../../../openapi/target-specs'; | ||
|
||
// eslint-disable-next-line @typescript-eslint/naming-convention | ||
const missingCoreFieldsOpenAPI3_1Lint: LinterMeta = { | ||
code: ApilintCodes.SCHEMA_MISSING_CORE_FIELDS, | ||
source: 'apilint', | ||
message: 'Schema does not include any Schema Object keywords', | ||
severity: DiagnosticSeverity.Hint, | ||
linterFunction: 'existAnyOfFields', | ||
linterParams: [ | ||
[ | ||
'$ref', | ||
'$schema', | ||
'$id', | ||
'$vocabulary', | ||
'$anchor', | ||
'$dynamicAnchor', | ||
'$defs', | ||
'$comment', | ||
'if', | ||
'then', | ||
'else', | ||
'dependentSchemas', | ||
'prefixItems', | ||
'contains', | ||
'patternProperties', | ||
'propertyNames', | ||
'unevaluatedProperties', | ||
'unevaluatedItems', | ||
'const', | ||
'maxContains', | ||
'minContains', | ||
'dependencies', | ||
'dependentRequired', | ||
'examples', | ||
'contentEncoding', | ||
'contentMediaType', | ||
'contentSchema', | ||
'definitions', | ||
'multipleOf', | ||
'maximum', | ||
'exclusiveMaximum', | ||
'minimum', | ||
'exclusiveMinimum', | ||
'maxLength', | ||
'minLength', | ||
'pattern', | ||
'additionalItems', | ||
'items', | ||
'maxItems', | ||
'minItems', | ||
'uniqueItems', | ||
'maxProperties', | ||
'minProperties', | ||
'required', | ||
'properties', | ||
'additionalProperties', | ||
'enum', | ||
'type', | ||
'allOf', | ||
'anyOf', | ||
'oneOf', | ||
'not', | ||
'title', | ||
'description', | ||
'default', | ||
'format', | ||
'readOnly', | ||
'discriminator', | ||
'externalDocs', | ||
'writeOnly', | ||
'xml', | ||
'example', | ||
'deprecated', | ||
], | ||
true, | ||
'boolean', | ||
], | ||
marker: 'key', | ||
targetSpecs: [...OpenAPI31], | ||
}; | ||
|
||
export default missingCoreFieldsOpenAPI3_1Lint; |
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
Oops, something went wrong.