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

Refs #2033

Author: char0n

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

@@ -627,6 +627,12 @@ enum ApilintCodes {
   OPENAPI3_0_COMPONENTS_FIELD_LINKS_VALUES_TYPE = 5060800,
   OPENAPI3_0_COMPONENTS_FIELD_CALLBACKS_VALUES_TYPE = 5060900,
 
+  OPENAPI3_O_SERVER = 5070000,
+  OPENAPI3_O_SERVER_FIELD_URL_FORMAT_URI = 5070100,
+  OPENAPI3_O_SERVER_FIELD_URL_REQUIRED,
+  OPENAPI3_O_SERVER_FIELD_DESCRIPTION_TYPE = 5070200,
+  OPENAPI3_O_SERVER_FIELD_VARIABLES_VALUES_TYPE = 5070300,
+
   OPENAPI3_1 = 7000000,
 
   OPENAPI3_1_OPENAPI_VALUE_PATTERN_3_1_0 = 7000100,

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

@@ -3,6 +3,6 @@ import emailFormatEmailLint from './email--format-email';
 import nameTypeLint from './name--type';
 import urlFormatURILint from './url--format-uri';
 
-const contactLints = [emailFormatEmailLint, nameTypeLint, urlFormatURILint, allowedFieldsLint];
+const lints = [emailFormatEmailLint, nameTypeLint, urlFormatURILint, allowedFieldsLint];
 
-export default contactLints;
+export default lints;

packages/apidom-ls/src/config/openapi/external-documentation/lint/index.ts

@@ -3,6 +3,6 @@ import descriptionTypeLint from './description--type';
 import urlRequiredLint from './url--required';
 import urlFormatURILint from './url--format-uri';
 
-const contactLints = [descriptionTypeLint, urlRequiredLint, urlFormatURILint, allowedFieldsLint];
+const lints = [descriptionTypeLint, urlRequiredLint, urlFormatURILint, allowedFieldsLint];
 
-export default contactLints;
+export default lints;

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

@@ -11,7 +11,7 @@ import licenseTypeLint from './license--type';
 import versionTypeLint from './version--type';
 import versionRequiredLint from './version--required';
 
-const infoLints = [
+const lints = [
   titleTypeLint,
   titleRequiredLint,
   summaryTypeLint,
@@ -26,4 +26,4 @@ const infoLints = [
   allowedFields3_1Lint,
 ];
 
-export default infoLints;
+export default lints;

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

@@ -3,6 +3,6 @@ import nameTypeLint from './name--type';
 import nameRequiredLint from './name--required';
 import urlFormatURILint from './url--format-uri';
 
-const contactLints = [nameTypeLint, nameRequiredLint, urlFormatURILint, allowedFields3_0Lint];
+const lints = [nameTypeLint, nameRequiredLint, urlFormatURILint, allowedFields3_0Lint];
 
-export default contactLints;
+export default lints;

packages/apidom-ls/src/config/openapi/server/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: [['url', 'description', 'variables'], '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/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_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/lint/index.ts

@@ -0,0 +1,15 @@
+import allowedFieldsLint from './allowed-fields';
+import urlFormatURILint from './url--format-uri';
+import urlRequiredLint from './url--required';
+import descriptionTypeLint from './description--type';
+import variablesValuesTypeLint from './variables--values-type';
+
+const lints = [
+  urlFormatURILint,
+  urlRequiredLint,
+  descriptionTypeLint,
+  variablesValuesTypeLint,
+  allowedFieldsLint,
+];
+
+export default lints;

packages/apidom-ls/src/config/openapi/server/lint/url--format-uri.ts

@@ -0,0 +1,22 @@
+import ApilintCodes from '../../../codes';
+import { LinterMeta } from '../../../../apidom-language-types';
+
+const urlFormatURILint: LinterMeta = {
+  code: ApilintCodes.OPENAPI3_O_SERVER_FIELD_URL_FORMAT_URI,
+  source: 'apilint',
+  message: 'url MUST be in the format of an URL.',
+  severity: 1,
+  linterFunction: 'apilintValidURI',
+  marker: 'value',
+  target: 'url',
+  data: {},
+  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 urlFormatURILint;

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

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

packages/apidom-ls/src/config/openapi/server/lint/variables--values-type.ts

@@ -0,0 +1,17 @@
+import ApilintCodes from '../../../codes';
+import { LinterMeta } from '../../../../apidom-language-types';
+
+const variablesValuesTypeLint: LinterMeta = {
+  code: ApilintCodes.OPENAPI3_O_SERVER_FIELD_VARIABLES_VALUES_TYPE,
+  source: 'apilint',
+  message: '"varialbes" members must be Server Variable Object',
+  severity: 1,
+  linterFunction: 'apilintChildrenOfElementsOrClasses',
+  linterParams: [['serverVariable']],
+  marker: 'key',
+  markerTarget: 'variables',
+  target: 'variables',
+  data: {},
+};
+
+export default variablesValuesTypeLint;

packages/apidom-ls/src/config/openapi/server/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,
 };