feat(ls): add schema validation rules (#4992)

Author: robert-hebel-sb

packages/apidom-ls/src/config/codes.ts

@@ -69,6 +69,16 @@ enum ApilintCodes {
   SCHEMA_MISSING_CORE_FIELDS,
   SCHEMA_NULLABLE,
   SCHEMA_XML,
+  SCHEMA_ENUM_TYPE,
+  SCHEMA_ENUM_DEFAULT_VALUE,
+  SCHEMA_MINIMUM_VALUE,
+  SCHEMA_MIN_LENGTH_VALUE,
+  SCHEMA_MIN_PROPERTIES_VALUE,
+  SCHEMA_MIN_ITEMS_VALUE,
+  SCHEMA_READONLY_WRITEONLY,
+  SCHEMA_READONLY_REQUIRED,
+  SCHEMA_PATTERN_REG_EXP_ANCHORS,
+  SCHEMA_ITEMS_REQUIRED,
 
   DUPLICATE_KEYS = 14999,
   NOT_ALLOWED_FIELDS = 15000,
@@ -739,6 +749,8 @@ enum ApilintCodes {
   OPENAPI2_PARAMETER_FIELD_MIN_LENGTH_TYPE = 3101600,
   OPENAPI2_PARAMETER_FIELD_UNIQUE_ITEMS_TYPE = 3101700,
   OPENAPI2_PARAMETER_FIELD_ENUM_TYPE = 3101800,
+  OPENAPI2_PARAMETER_FIELD_ENUM_TYPE_VALUE,
+  OPENAPI2_PARAMETER_FIELD_ENUM_DEFAULT_VALUE,
   OPENAPI2_PARAMETER_FIELD_MULTIPLE_OF_TYPE = 3101900,
   OPENAPI2_PARAMETER_FIELD_IN_PATH_TEMPLATE = 3102000,
   OPENAPI2_PARAMETER_FIELD_NAME_UNIQUE = 3103000,
@@ -753,12 +765,15 @@ enum ApilintCodes {
   OPENAPI2_ITEMS_FIELD_MAXIMUM_TYPE = 3110500,
   OPENAPI2_ITEMS_FIELD_EXCLUSIVE_MAXIMUM_TYPE = 3110600,
   OPENAPI2_ITEMS_FIELD_MINIMUM_TYPE = 3110700,
+  OPENAPI2_ITEMS_FIELD_MINIMUM_VALUE = 3110701,
   OPENAPI2_ITEMS_FIELD_EXCLUSIVE_MINIMUM_TYPE = 3110800,
   OPENAPI2_ITEMS_FIELD_MAX_LENGTH_TYPE = 3110900,
   OPENAPI2_ITEMS_FIELD_MIN_LENGTH_TYPE = 3111000,
+  OPENAPI2_ITEMS_FIELD_MIN_LENGTH_VALUE,
   OPENAPI2_ITEMS_FIELD_PATTERN_TYPE = 3111100,
   OPENAPI2_ITEMS_FIELD_MAX_ITEMS_TYPE = 3111200,
   OPENAPI2_ITEMS_FIELD_MIN_ITEMS_TYPE = 3111300,
+  OPENAPI2_ITEMS_FIELD_MIN_ITEMS_VALUE,
   OPENAPI2_ITEMS_FIELD_UNIQUE_ITEMS_TYPE = 3111400,
   OPENAPI2_ITEMS_FIELD_ENUM_TYPE = 3111500,
   OPENAPI2_ITEMS_FIELD_MULTIPLE_OF_TYPE = 3111600,

packages/apidom-ls/src/config/common/schema/lint/enum--default-value.ts

@@ -0,0 +1,19 @@
+import { DiagnosticSeverity } from 'vscode-languageserver-types';
+
+import ApilintCodes from '../../../codes.ts';
+import { LinterMeta } from '../../../../apidom-language-types.ts';
+import { OpenAPI2, OpenAPI30 } from '../../../openapi/target-specs.ts';
+
+const enumDefaultValueLint: LinterMeta = {
+  code: ApilintCodes.SCHEMA_ENUM_DEFAULT_VALUE,
+  source: 'apilint',
+  message: 'Default values must be present in enum',
+  severity: DiagnosticSeverity.Error,
+  linterFunction: 'apilintContainsDefaultValue',
+  marker: 'value',
+  target: 'enum',
+  data: {},
+  targetSpecs: [...OpenAPI2, ...OpenAPI30],
+};
+
+export default enumDefaultValueLint;

packages/apidom-ls/src/config/common/schema/lint/enum--type.ts

@@ -0,0 +1,20 @@
+import { DiagnosticSeverity } from 'vscode-languageserver-types';
+
+import ApilintCodes from '../../../codes.ts';
+import { LinterMeta } from '../../../../apidom-language-types.ts';
+import { OpenAPI2, OpenAPI30 } from '../../../openapi/target-specs.ts';
+
+const enumTypeLint: LinterMeta = {
+  code: ApilintCodes.SCHEMA_ENUM_TYPE,
+  source: 'apilint',
+  message: "enum value should conform to its schema's type",
+  severity: DiagnosticSeverity.Warning,
+  linterFunction: 'apilintArrayOfType',
+  linterParams: ['', false, true],
+  marker: 'value',
+  target: 'enum',
+  data: {},
+  targetSpecs: [...OpenAPI2, ...OpenAPI30],
+};
+
+export default enumTypeLint;

packages/apidom-ls/src/config/common/schema/lint/index.ts

@@ -4,6 +4,7 @@ import $idFormatURILint from './$id--format-uri.ts';
 import $refValidLint from './$ref--valid.ts';
 import $refNoSiblingsLint from './$ref--no-siblings.ts';
 import $ref3RequestBodiesLint from './$ref-3-0--request-bodies.ts';
+import $refNotUsedLint from './$ref--not-used.ts';
 import additionalItemsNonArrayLint from './additional-items--non-array.ts';
 import additionalItemsTypeLint from './additional-items--type.ts';
 import additionalItemsTypeOpenAPI3_1__AsyncAPI2Lint from './additional-items--type-openapi-3-1--asyncapi-2.ts';
@@ -34,7 +35,9 @@ import formatTypeLint from './format--type.ts';
 import ifNonThenLint from './if--non-then.ts';
 import ifTypeLint from './if--type.ts';
 import itemsNonArrayLint from './items--non-array.ts';
-import itemsTypeLint from './items--type.ts';
+import itemsRequiredLint from './items--required.ts';
+import itemsTypeOpenAPI31AsyncAPI2Lint from './items--type-3-1-asyncapi-2.ts';
+import itemsTypeOpenAPI2OpenAPI30Lint from './items--type-2-0-3-0.ts';
 import maxItemsNonArrayLint from './max-items--non-array.ts';
 import maxItemsTypeLint from './max-items--type.ts';
 import maxLengthNonStringLint from './max-length--non-string.ts';
@@ -82,7 +85,15 @@ import uniqueItemsNonArrayLint from './unique-items--non-array.ts';
 import uniqueItemsTypeLint from './unique-items--type.ts';
 import writeOnlyTypeLint from './write-only--type.ts';
 import exampleDeprecatedLint from './example--deprecated.ts';
-import $refNotUsedLint from './$ref--not-used.ts';
+import enumTypeLint from './enum--type.ts';
+import enumDefaultValueLint from './enum--default-value.ts';
+import minimumValueLint from './minimum-maximum--value.ts';
+import minLengthValueLint from './min-length-max-length--value.ts';
+import minPropertiesValueLint from './min-properties-max-properties--value.ts';
+import minItemsValueLint from './min-items-max-items--value.ts';
+import readOnlyWriteOnlyLint from './read-only-write-only-3-0.ts';
+import readOnlyRequiredLint from './required--read-only-2.ts';
+import patternValueLint from './pattern--value-2.ts';
 
 const schemaLints = [
   allowedFieldsOpenAPI2_0Lint,
@@ -111,6 +122,8 @@ const schemaLints = [
   elseNonIfLint,
   elseTypeLint,
   enumUniqueLint,
+  enumDefaultValueLint,
+  enumTypeLint,
   examplesTypeLint,
   exclusiveMaximumTypeNumberLint,
   exclusiveMaximumTypeBooleanLint,
@@ -122,7 +135,9 @@ const schemaLints = [
   ifNonThenLint,
   ifTypeLint,
   itemsNonArrayLint,
-  itemsTypeLint,
+  itemsRequiredLint,
+  itemsTypeOpenAPI31AsyncAPI2Lint,
+  itemsTypeOpenAPI2OpenAPI30Lint,
   maxItemsNonArrayLint,
   maxItemsTypeLint,
   maxLengthNonStringLint,
@@ -135,6 +150,10 @@ const schemaLints = [
   minPropertiesNonObjectLint,
   minPropertiesTypeLint,
   minimumTypeLint,
+  minimumValueLint,
+  minLengthValueLint,
+  minPropertiesValueLint,
+  minItemsValueLint,
   missingCoreFieldsOpenAPI2_0Lint,
   missingCoreFieldsOpenAPI3_0Lint,
   missingCoreFieldsOpenAPI3_1Lint,
@@ -150,13 +169,16 @@ const schemaLints = [
   patternPropertiesKeysRegexpLint,
   patternPropertiesNonObjectLint,
   patternPropertiesTypeLint,
+  patternValueLint,
   patternPropertiesValuesTypeLint,
   propertiesTypeLint,
   propertiesValuesTypeLint,
   propertiesValuesTypeOpenAPI3_1__AsyncAPI2Lint,
   propertyNamesNonObjectLint,
   propertyNamesTypeLint,
   readOnlyTypeLint,
+  readOnlyWriteOnlyLint,
+  readOnlyRequiredLint,
   requiredDefinedLint,
   requiredNonObjectLint,
   requiredTypeLint,

packages/apidom-ls/src/config/common/schema/lint/items--required.ts

@@ -0,0 +1,39 @@
+import { DiagnosticSeverity } from 'vscode-languageserver-types';
+
+import ApilintCodes from '../../../codes.ts';
+import { LinterMeta } from '../../../../apidom-language-types.ts';
+import { OpenAPI2, OpenAPI30 } from '../../../openapi/target-specs.ts';
+
+const itemsRequiredLint: LinterMeta = {
+  code: ApilintCodes.SCHEMA_ITEMS_REQUIRED,
+  source: 'apilint',
+  message: "should have an 'items' if 'type'=array",
+  severity: DiagnosticSeverity.Error,
+  linterFunction: 'hasRequiredField',
+  linterParams: ['items'],
+  marker: 'key',
+  conditions: [
+    {
+      targets: [{ path: 'type' }],
+      function: 'apilintContainsValue',
+      params: ['array'],
+    },
+    {
+      function: 'missingField',
+      params: ['$ref'],
+    },
+  ],
+  data: {
+    quickFix: [
+      {
+        message: "add 'items' field",
+        action: 'addChild',
+        snippetYaml: 'items: \n  \n',
+        snippetJson: '"items": {\n  \n  },\n',
+      },
+    ],
+  },
+  targetSpecs: [...OpenAPI2, ...OpenAPI30],
+};
+
+export default itemsRequiredLint;

packages/apidom-ls/src/config/common/schema/lint/items--type-2-0-3-0.ts

@@ -0,0 +1,20 @@
+import { DiagnosticSeverity } from 'vscode-languageserver-types';
+
+import ApilintCodes from '../../../codes.ts';
+import { LinterMeta } from '../../../../apidom-language-types.ts';
+import { OpenAPI30, OpenAPI2 } from '../../../openapi/target-specs.ts';
+
+const itemsTypeOpenAPI2OpenAPI30Lint: LinterMeta = {
+  code: ApilintCodes.SCHEMA_ITEMS,
+  source: 'apilint',
+  message: "'items' must be an object",
+  severity: DiagnosticSeverity.Error,
+  linterFunction: 'apilintElementOrClass',
+  linterParams: [['schema']],
+  marker: 'value',
+  target: 'items',
+  data: {},
+  targetSpecs: [...OpenAPI2, ...OpenAPI30],
+};
+
+export default itemsTypeOpenAPI2OpenAPI30Lint;

packages/apidom-ls/src/config/common/schema/lint/items--type.ts renamed to packages/apidom-ls/src/config/common/schema/lint/items--type-3-1-asyncapi-2.ts

@@ -3,9 +3,9 @@ import { DiagnosticSeverity } from 'vscode-languageserver-types';
 import ApilintCodes from '../../../codes.ts';
 import { LinterMeta } from '../../../../apidom-language-types.ts';
 import { AsyncAPI2 } from '../../../asyncapi/target-specs.ts';
-import { OpenAPI2, OpenAPI3 } from '../../../openapi/target-specs.ts';
+import { OpenAPI31 } from '../../../openapi/target-specs.ts';
 
-const itemsTypeLint: LinterMeta = {
+const itemsTypeOpenAPI31AsyncAPI2Lint: LinterMeta = {
   code: ApilintCodes.SCHEMA_ITEMS,
   source: 'apilint',
   message: 'items must be a schema or array of schemas',
@@ -15,7 +15,7 @@ const itemsTypeLint: LinterMeta = {
   marker: 'value',
   target: 'items',
   data: {},
-  targetSpecs: [...AsyncAPI2, ...OpenAPI2, ...OpenAPI3],
+  targetSpecs: [...AsyncAPI2, ...OpenAPI31],
 };
 
-export default itemsTypeLint;
+export default itemsTypeOpenAPI31AsyncAPI2Lint;

packages/apidom-ls/src/config/common/schema/lint/min-items-max-items--value.ts

@@ -0,0 +1,20 @@
+import { DiagnosticSeverity } from 'vscode-languageserver-types';
+
+import ApilintCodes from '../../../codes.ts';
+import { LinterMeta } from '../../../../apidom-language-types.ts';
+import { OpenAPI2, OpenAPI30 } from '../../../openapi/target-specs.ts';
+
+const minItemsValueLint: LinterMeta = {
+  code: ApilintCodes.SCHEMA_MIN_ITEMS_VALUE,
+  source: 'apilint',
+  message: "'minItems' must be a lower value than 'maxItems'",
+  severity: DiagnosticSeverity.Error,
+  linterFunction: 'apilintSchemaMinimumMaximum',
+  linterParams: ['minItems', 'maxItems'],
+  marker: 'value',
+  target: 'minItems',
+  data: {},
+  targetSpecs: [...OpenAPI2, ...OpenAPI30],
+};
+
+export default minItemsValueLint;

packages/apidom-ls/src/config/common/schema/lint/min-length-max-length--value.ts

@@ -0,0 +1,20 @@
+import { DiagnosticSeverity } from 'vscode-languageserver-types';
+
+import ApilintCodes from '../../../codes.ts';
+import { LinterMeta } from '../../../../apidom-language-types.ts';
+import { OpenAPI2, OpenAPI30 } from '../../../openapi/target-specs.ts';
+
+const minLengthValueLint: LinterMeta = {
+  code: ApilintCodes.SCHEMA_MIN_LENGTH_VALUE,
+  source: 'apilint',
+  message: "'minLength' must be a lower value than 'maxLength'",
+  severity: DiagnosticSeverity.Error,
+  linterFunction: 'apilintSchemaMinimumMaximum',
+  linterParams: ['minLength', 'maxLength'],
+  marker: 'value',
+  target: 'minLength',
+  data: {},
+  targetSpecs: [...OpenAPI2, ...OpenAPI30],
+};
+
+export default minLengthValueLint;

packages/apidom-ls/src/config/common/schema/lint/min-properties-max-properties--value.ts

@@ -0,0 +1,20 @@
+import { DiagnosticSeverity } from 'vscode-languageserver-types';
+
+import ApilintCodes from '../../../codes.ts';
+import { LinterMeta } from '../../../../apidom-language-types.ts';
+import { OpenAPI2, OpenAPI30 } from '../../../openapi/target-specs.ts';
+
+const minPropertiesValueLint: LinterMeta = {
+  code: ApilintCodes.SCHEMA_MIN_PROPERTIES_VALUE,
+  source: 'apilint',
+  message: "'minProperties' must be a lower value than 'maxProperties'",
+  severity: DiagnosticSeverity.Error,
+  linterFunction: 'apilintSchemaMinimumMaximum',
+  linterParams: ['minProperties', 'maxProperties'],
+  marker: 'value',
+  target: 'minProperties',
+  data: {},
+  targetSpecs: [...OpenAPI2, ...OpenAPI30],
+};
+
+export default minPropertiesValueLint;