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

Refs #2033

Author: char0n

packages/apidom-ls/src/config/openapi/example/lint/$ref--no-siblings.ts

@@ -0,0 +1,21 @@
+import ApilintCodes from '../../../codes';
+import { LinterMeta } from '../../../../apidom-language-types';
+
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const allowedFields3_0Lint: LinterMeta = {
+  code: ApilintCodes.NOT_ALLOWED_FIELDS,
+  source: 'apilint',
+  message: 'Object includes not allowed fields',
+  severity: 1,
+  linterFunction: 'allowedFields',
+  linterParams: [['summary', 'description', 'value', 'externalValue', '$ref'], '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' },
+  ],
+};
+
+export default allowedFields3_0Lint;

packages/apidom-ls/src/config/openapi/example/lint/$ref--valid.ts

@@ -1,6 +1,4 @@
-import allowedFieldsLint from './allowed-fields';
-import $refValidLint from './$ref--valid';
-import $refNoSiblingsLint from './$ref--no-siblings';
+import allowedFields3_0Lint from './allowed-fields-3-0';
 import summaryTypeLint from './summary--type';
 import descriptionTypeLint from './description--type';
 import valueMutuallyExclusiveLint from './value--mutually-exclusive';
@@ -11,9 +9,7 @@ const lints = [
   descriptionTypeLint,
   valueMutuallyExclusiveLint,
   externalValueFormatURILint,
-  $refValidLint,
-  $refNoSiblingsLint,
-  allowedFieldsLint,
+  allowedFields3_0Lint,
 ];
 
 export default lints;

packages/apidom-ls/src/config/openapi/example/lint/allowed-fields-3-0.ts

@@ -1,14 +1,21 @@
 import ApilintCodes from '../../../codes';
 import { LinterMeta } from '../../../../apidom-language-types';
 
-const allowedFieldsLint: LinterMeta = {
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const allowedFields3_0Lint: LinterMeta = {
   code: ApilintCodes.NOT_ALLOWED_FIELDS,
   source: 'apilint',
   message: 'Object includes not allowed fields',
   severity: 1,
   linterFunction: 'allowedFields',
   linterParams: [['description', 'content', 'required', '$ref'], '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' },
+  ],
 };
 
-export default allowedFieldsLint;
+export default allowedFields3_0Lint;

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

@@ -1,19 +1,15 @@
-import allowedFieldsLint from './allowed-fields';
-import $refNoSiblingsLint from './$ref--no-siblings';
-import $refValidLint from './$ref--valid';
+import allowedFields3_0Lint from './allowed-fields-3-0';
 import descriptionTypeLint from './description--type';
 import contentValuesTypeLint from './content--values-type';
 import contentRequiredLint from './content--required';
 import requiredTypeLint from './required--type';
 
 const lints = [
-  allowedFieldsLint,
-  $refNoSiblingsLint,
-  $refValidLint,
   descriptionTypeLint,
   contentRequiredLint,
   contentValuesTypeLint,
   requiredTypeLint,
+  allowedFields3_0Lint,
 ];
 
 export default lints;

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

@@ -0,0 +1,21 @@
+import ApilintCodes from '../../../codes';
+import { LinterMeta } from '../../../../apidom-language-types';
+
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const allowedFields3_0Lint: LinterMeta = {
+  code: ApilintCodes.NOT_ALLOWED_FIELDS,
+  source: 'apilint',
+  message: 'Object includes not allowed fields',
+  severity: 1,
+  linterFunction: 'allowedFields',
+  linterParams: [['description', 'headers', 'content', 'links', '$ref'], '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' },
+  ],
+};
+
+export default allowedFields3_0Lint;

packages/apidom-ls/src/config/openapi/request-body/lint/$ref--no-siblings.ts

@@ -1,4 +1,4 @@
-import allowedFieldsLint from './allowed-fields';
+import allowedFields3_0Lint from './allowed-fields-3-0';
 import descriptionTypeLint from './description--type';
 import descriptionRequiredLint from './description--required';
 import headersValuesTypeLint from './headers--values-type';
@@ -11,7 +11,7 @@ const lints = [
   headersValuesTypeLint,
   contentValuesTypeLint,
   linksValuesTypeLint,
-  allowedFieldsLint,
+  allowedFields3_0Lint,
 ];
 
 export default lints;

packages/apidom-ls/src/config/openapi/request-body/lint/$ref--valid.ts

@@ -0,0 +1,34 @@
+import ApilintCodes from '../../../codes';
+import { LinterMeta } from '../../../../apidom-language-types';
+
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const allowedFields3_0Lint: LinterMeta = {
+  code: ApilintCodes.NOT_ALLOWED_FIELDS,
+  source: 'apilint',
+  message: 'Object includes not allowed fields',
+  severity: 1,
+  linterFunction: 'allowedFields',
+  linterParams: [
+    [
+      'type',
+      'description',
+      'name',
+      'in',
+      'scheme',
+      'bearerFormat',
+      'flows',
+      'openIdConnectUrl',
+      '$ref',
+    ],
+    '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' },
+  ],
+};
+
+export default allowedFields3_0Lint;

packages/apidom-ls/src/config/openapi/request-body/lint/allowed-fields.ts renamed to packages/apidom-ls/src/config/openapi/request-body/lint/allowed-fields-3-0.ts

@@ -1,4 +1,4 @@
-import allowedFieldsLint from './allowed-fields';
+import allowedFields3_0Lint from './allowed-fields-3-0';
 import typeEquals3_0Lint from './type--equals-3-0';
 import descriptionTypeLint from './description--type';
 import nameTypeLint from './name--type';
@@ -27,7 +27,7 @@ const lints = [
   flowsRequiredLint,
   openIdConnectUrlFormatURILint,
   openIdConnectUrlRequiredLint,
-  allowedFieldsLint,
+  allowedFields3_0Lint,
 ];
 
 export default lints;