feat(apidom-ls): - improve logic and update config

* Improve/fix completion, validation and documentation logic
* Move asyncapi config from swagger-ide to apidom-ls
* Complete rules for asyncapi schema section

Author: frantuma

.editorconfig

@@ -28,3 +28,9 @@ trim_trailing_whitespace = true
 # Denotes whether file should end with a newline
 # Possible values - true, false
 insert_final_newline = true
+
+[packages/apidom-ls/test/fixtures/**/*.json]
+trim_trailing_whitespace = false
+
+[packages/apidom-ls/test/fixtures/**/*.yaml]
+trim_trailing_whitespace = false

packages/apidom-ls/src/apidom-language-service.ts

@@ -25,6 +25,7 @@ import { DefaultDerefService } from './services/deref/deref-service';
 import { DefaultDefinitionService } from './services/definition/definition-service';
 import { getDocumentCache } from './document-cache';
 import { parse } from './parser-factory';
+import { config } from './config/config';
 
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 export default function getLanguageService(context: LanguageServiceContext): LanguageService {
@@ -46,20 +47,21 @@ export default function getLanguageService(context: LanguageServiceContext): Lan
     definitionService.configure(languageSettings);
   }
 
+  let metadata = config();
+  if (context?.metadata) {
+    metadata = context.metadata;
+  }
   const documentCache = getDocumentCache<ParseResultElement>(10, 60, (document) =>
-    parse(document, context?.metadata?.metadataMaps),
+    parse(document, metadata.metadataMaps),
   );
 
-  // TODO solve init and config
-  if (context.metadata) {
-    const languageSettings: LanguageSettings = {
-      metadata: context.metadata,
-      validate: true,
-      validatorProviders: context.validatorProviders,
-      documentCache,
-    };
-    configureServices(languageSettings);
-  }
+  const languageSettings: LanguageSettings = {
+    metadata,
+    validate: true,
+    validatorProviders: context?.validatorProviders,
+    documentCache,
+  };
+  configureServices(languageSettings);
 
   return {
     // eslint-disable-next-line @typescript-eslint/no-unused-vars

packages/apidom-ls/src/apidom-language-types.ts

@@ -28,13 +28,12 @@ import { Element, ParseResultElement } from '@swagger-api/apidom-core';
 
 import { DocumentCache } from './document-cache';
 
-// eslint-disable-next-line @typescript-eslint/naming-convention
-export enum SUPPORTED_LANGUAGES {
+export enum SupportedLanguages {
   OPENAPI_31,
   ASYNCAPI_20,
 }
 
-export enum FORMAT {
+export enum Format {
   JSON,
   YAML,
 }
@@ -95,7 +94,7 @@ export interface CompletionContext {
 }
 
 export interface DerefContext {
-  format?: FORMAT;
+  format?: Format;
   baseURI?: string;
 }
 
@@ -112,9 +111,32 @@ export interface WorkspaceContextService {
   resolveRelativePath(relativePath: string, resource: string): string;
 }
 
+export enum CompletionType {
+  PROPERTY,
+  VALUE,
+  UNDEFINED,
+}
+
+export enum CompletionFormat {
+  UNQUOTED,
+  QUOTED,
+  QUOTED_FORCED,
+  OBJECT,
+  ARRAY,
+  UNDEFINED,
+}
+
 export interface ApidomCompletionItem extends CompletionItem {
   targetSpecs?: NamespaceVersion[];
   target?: string;
+  arrayMember?: boolean;
+  type?: CompletionType;
+  format?: CompletionFormat;
+  insertTextJson?: string;
+  insertTextYaml?: string;
+  conditions?: LinterCondition[];
+  function?: string;
+  functionParams?: [unknown] | undefined | unknown;
 }
 
 export interface DocumentationMeta {
@@ -125,11 +147,6 @@ export interface DocumentationMeta {
   conditions?: LinterCondition[];
 }
 
-export interface ElementMeta {
-  completion?: ApidomCompletionItem[];
-  validation?: string[];
-}
-
 export interface QuickFixData {
   message: string;
   function?: string;
@@ -149,7 +166,7 @@ export interface LinterMeta {
   source?: string;
   severity?: 1 | 2 | 3 | 4 | undefined;
   linterFunction?: string;
-  linterParams?: [any];
+  linterParams?: [unknown] | undefined | unknown;
   marker?: string;
   markerTarget?: string;
   target?: string;
@@ -160,10 +177,10 @@ export interface LinterMeta {
 }
 
 export interface LinterCondition {
-  targets: LinterConditionTarget[];
+  targets?: LinterConditionTarget[];
   function: string;
   negate?: boolean;
-  params: [any];
+  params?: [unknown] | undefined | unknown;
 }
 
 export interface LinterConditionTarget {
@@ -172,7 +189,9 @@ export interface LinterConditionTarget {
 }
 
 export interface FormatMeta {
-  [index: string]: ElementMeta | LinterMeta[] | DocumentationMeta[];
+  documentation?: DocumentationMeta[];
+  lint?: LinterMeta[];
+  completion?: ApidomCompletionItem[];
 }
 
 export interface MetadataMap {
@@ -192,8 +211,17 @@ export interface LinterFunctionsMap {
   [index: string]: LinterFunctions;
 }
 
+export type LinterFunction = ((...args: any[]) => boolean) | undefined;
+export type CompletionFunction = ((...args: any[]) => CompletionItem[]) | undefined;
+export type ConditionFunction = ((...args: any[]) => boolean) | undefined;
+
+export interface FunctionItem {
+  functionName: string;
+  function: LinterFunction | CompletionFunction | ConditionFunction;
+}
+
 export interface LinterFunctions {
-  [index: string]: (element: Element) => boolean;
+  [index: string]: LinterFunction;
 }
 
 export interface LanguageService {

packages/apidom-ls/src/config/asyncapi/asyncApiVersion/complete/asyncapiversion.ts

@@ -0,0 +1,34 @@
+import {
+  ApidomCompletionItem,
+  CompletionFormat,
+  CompletionType,
+} from '../../../../apidom-language-types';
+
+const asyncapiVersionComplete: ApidomCompletionItem[] = [
+  {
+    label: '2.0.0',
+    insertText: '2.0.0',
+    kind: 12,
+    format: CompletionFormat.QUOTED_FORCED,
+    type: CompletionType.VALUE,
+    insertTextFormat: 2,
+  },
+  {
+    label: '2.1.0',
+    insertText: '2.1.0',
+    kind: 12,
+    format: CompletionFormat.QUOTED_FORCED,
+    type: CompletionType.VALUE,
+    insertTextFormat: 2,
+  },
+  {
+    label: '2.2.0',
+    insertText: '2.2.0',
+    kind: 12,
+    format: CompletionFormat.QUOTED_FORCED,
+    type: CompletionType.VALUE,
+    insertTextFormat: 2,
+  },
+];
+
+export default asyncapiVersionComplete;

packages/apidom-ls/src/config/asyncapi/asyncApiVersion/lint/asyncapi-20.ts

@@ -0,0 +1,24 @@
+import ApilintCodes from '../../../codes';
+import { LinterMeta } from '../../../../apidom-language-types';
+
+const asyncapiVersionLint20: LinterMeta = {
+  code: ApilintCodes.ASYNCAPI_ASYNCAPIVERSION_20,
+  source: 'apilint',
+  message: "'asyncapi' value must be 2.0.0",
+  severity: 1,
+  linterFunction: 'apilintValueRegex',
+  linterParams: ['2\\.0\\.0'],
+  marker: 'value',
+  targetSpecs: [{ namespace: 'asyncapi', version: '2.0.0' }],
+  data: {
+    quickFix: [
+      {
+        message: "update to '2.0.0'",
+        action: 'updateValue',
+        functionParams: ['2.0.0'],
+      },
+    ],
+  },
+};
+
+export default asyncapiVersionLint20;

packages/apidom-ls/src/config/asyncapi/asyncApiVersion/lint/asyncapi-21.ts

@@ -0,0 +1,24 @@
+import ApilintCodes from '../../../codes';
+import { LinterMeta } from '../../../../apidom-language-types';
+
+const asyncapiVersionLint21: LinterMeta = {
+  code: ApilintCodes.ASYNCAPI_ASYNCAPIVERSION_21,
+  source: 'apilint',
+  message: "'asyncapi' value must be 2.1.0",
+  severity: 1,
+  linterFunction: 'apilintValueRegex',
+  linterParams: ['2\\.1\\.0'],
+  marker: 'value',
+  targetSpecs: [{ namespace: 'asyncapi', version: '2.1.0' }],
+  data: {
+    quickFix: [
+      {
+        message: "update to '2.1.0'",
+        action: 'updateValue',
+        functionParams: ['2.1.0'],
+      },
+    ],
+  },
+};
+
+export default asyncapiVersionLint21;

packages/apidom-ls/src/config/asyncapi/asyncApiVersion/lint/asyncapi-22.ts

@@ -0,0 +1,24 @@
+import ApilintCodes from '../../../codes';
+import { LinterMeta } from '../../../../apidom-language-types';
+
+const asyncapiVersionLint22: LinterMeta = {
+  code: ApilintCodes.ASYNCAPI_ASYNCAPIVERSION_22,
+  source: 'apilint',
+  message: "'asyncapi' value must be 2.2.0",
+  severity: 1,
+  linterFunction: 'apilintValueRegex',
+  linterParams: ['2\\.2\\.0'],
+  marker: 'value',
+  targetSpecs: [{ namespace: 'asyncapi', version: '2.2.0' }],
+  data: {
+    quickFix: [
+      {
+        message: "update to '2.2.0'",
+        action: 'updateValue',
+        functionParams: ['2.2.0'],
+      },
+    ],
+  },
+};
+
+export default asyncapiVersionLint22;

packages/apidom-ls/src/config/asyncapi/asyncApiVersion/lint/lints.ts

@@ -0,0 +1,7 @@
+import asyncapiVersionLint20 from './asyncapi-20';
+import asyncapiVersionLint21 from './asyncapi-21';
+import asyncapiVersionLint22 from './asyncapi-22';
+
+const asyncapiVersionLints = [asyncapiVersionLint20, asyncapiVersionLint21, asyncapiVersionLint22];
+
+export default asyncapiVersionLints;

packages/apidom-ls/src/config/asyncapi/asyncApiVersion/meta.ts

@@ -0,0 +1,10 @@
+import asyncapiVersionLints from './lint/lints';
+// import asyncapiVersionComplete from './complete/asyncapiversion';
+import { FormatMeta } from '../../../apidom-language-types';
+
+const asyncApiVersionMeta: FormatMeta = {
+  lint: asyncapiVersionLints,
+  // completion: asyncapiVersionComplete,
+};
+
+export default asyncApiVersionMeta;