feat(ls): provide OpenAPI 3.0.x Server Variable lint rules

Refs #2033

Author: char0n

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

@@ -633,6 +633,12 @@ enum ApilintCodes {
   OPENAPI3_O_SERVER_FIELD_DESCRIPTION_TYPE = 5070200,
   OPENAPI3_O_SERVER_FIELD_VARIABLES_VALUES_TYPE = 5070300,
 
+  OPENAPI3_O_SERVER_VARIABLE = 5080000,
+  OPENAPI3_O_SERVER_VARIABLE_FIELD_ENUM_TYPE = 5080100,
+  OPENAPI3_O_SERVER_VARIABLE_FIELD_DEFAULT_TYPE = 5080200,
+  OPENAPI3_O_SERVER_VARIABLE_FIELD_DEFAULT_REQUIRED,
+  OPENAPI3_O_SERVER_VARIABLE_FIELD_DESCRIPTION_TYPE = 5080300,
+
   OPENAPI3_1 = 7000000,
 
   OPENAPI3_1_OPENAPI_VALUE_PATTERN_3_1_0 = 7000100,

packages/apidom-ls/src/config/openapi/server-variable/lint/allowed-fields.ts

@@ -0,0 +1,21 @@
+import ApilintCodes from '../../../codes';
+import { LinterMeta } from '../../../../apidom-language-types';
+
+const allowedFieldsLint: LinterMeta = {
+  code: ApilintCodes.NOT_ALLOWED_FIELDS,
+  source: 'apilint',
+  message: 'Object includes not allowed fields',
+  severity: 1,
+  linterFunction: 'allowedFields',
+  linterParams: [['enum', 'default', 'description'], 'x-'],
+  marker: 'key',
+  targetSpecs: [
+    { namespace: 'openapi', version: '3.0.0' },
+    { namespace: 'openapi', version: '3.0.1' },
+    { namespace: 'openapi', version: '3.0.2' },
+    { namespace: 'openapi', version: '3.0.3' },
+    { namespace: 'openapi', version: '3.1.0' },
+  ],
+};
+
+export default allowedFieldsLint;

packages/apidom-ls/src/config/openapi/server-variable/lint/default--required.ts

@@ -0,0 +1,24 @@
+import ApilintCodes from '../../../codes';
+import { LinterMeta } from '../../../../apidom-language-types';
+
+const defaultRequiredLint: LinterMeta = {
+  code: ApilintCodes.OPENAPI3_O_SERVER_VARIABLE_FIELD_DEFAULT_REQUIRED,
+  source: 'apilint',
+  message: "should always have a 'default'",
+  severity: 1,
+  linterFunction: 'hasRequiredField',
+  linterParams: ['default'],
+  marker: 'key',
+  data: {
+    quickFix: [
+      {
+        message: "add 'default' field",
+        action: 'addChild',
+        snippetYaml: 'default: \n  ',
+        snippetJson: '"default": "",\n    ',
+      },
+    ],
+  },
+};
+
+export default defaultRequiredLint;

packages/apidom-ls/src/config/openapi/server-variable/lint/default--type.ts

@@ -0,0 +1,16 @@
+import ApilintCodes from '../../../codes';
+import { LinterMeta } from '../../../../apidom-language-types';
+
+const defaultTypeLint: LinterMeta = {
+  code: ApilintCodes.OPENAPI3_O_SERVER_VARIABLE_FIELD_DEFAULT_TYPE,
+  source: 'apilint',
+  message: "'default' must be a string",
+  severity: 1,
+  linterFunction: 'apilintType',
+  linterParams: ['string'],
+  marker: 'value',
+  target: 'default',
+  data: {},
+};
+
+export default defaultTypeLint;

packages/apidom-ls/src/config/openapi/server-variable/lint/description--type.ts

@@ -0,0 +1,16 @@
+import ApilintCodes from '../../../codes';
+import { LinterMeta } from '../../../../apidom-language-types';
+
+const descriptionTypeLint: LinterMeta = {
+  code: ApilintCodes.OPENAPI3_O_SERVER_VARIABLE_FIELD_DESCRIPTION_TYPE,
+  source: 'apilint',
+  message: "'description' must be a string",
+  severity: 1,
+  linterFunction: 'apilintType',
+  linterParams: ['string'],
+  marker: 'value',
+  target: 'description',
+  data: {},
+};
+
+export default descriptionTypeLint;

packages/apidom-ls/src/config/openapi/server-variable/lint/enum--type.ts

@@ -0,0 +1,16 @@
+import ApilintCodes from '../../../codes';
+import { LinterMeta } from '../../../../apidom-language-types';
+
+const enumTypeLint: LinterMeta = {
+  code: ApilintCodes.OPENAPI3_O_SERVER_VARIABLE_FIELD_ENUM_TYPE,
+  source: 'apilint',
+  message: "'enum' must be an array of strings",
+  severity: 1,
+  linterFunction: 'apilintArrayOfType',
+  linterParams: ['string'],
+  marker: 'key',
+  target: 'enum',
+  data: {},
+};
+
+export default enumTypeLint;

packages/apidom-ls/src/config/openapi/server-variable/lint/index.ts

@@ -0,0 +1,15 @@
+import allowedFieldsLint from './allowed-fields';
+import enumTypeLint from './enum--type';
+import defaultTypeLint from './default--type';
+import defaultRequiredLint from './default--required';
+import descriptionTypeLint from './description--type';
+
+const lints = [
+  enumTypeLint,
+  defaultTypeLint,
+  defaultRequiredLint,
+  descriptionTypeLint,
+  allowedFieldsLint,
+];
+
+export default lints;

packages/apidom-ls/src/config/openapi/server-variable/meta.ts

@@ -1,8 +1,10 @@
+import lint from './lint';
 import completion from './completion';
 import documentation from './documentation';
 import { FormatMeta } from '../../../apidom-language-types';
 
 const meta: FormatMeta = {
+  lint,
   completion,
   documentation,
 };