feat(apidom-ls): docs & config of compatible properties in AsyncAPI3 (#5095)

Author: cka121

packages/apidom-ls/src/config/asyncapi/async-api-version/completion.ts

@@ -61,6 +61,14 @@ const completion: ApidomCompletionItem[] = [
     type: CompletionType.VALUE,
     insertTextFormat: 2,
   },
+  {
+    label: '3.0.0',
+    insertText: '3.0.0',
+    kind: 12,
+    format: CompletionFormat.QUOTED_FORCED,
+    type: CompletionType.VALUE,
+    insertTextFormat: 2,
+  },
 ];
 
 export default completion;

packages/apidom-ls/src/config/asyncapi/async-api-version/documentation.ts

@@ -1,6 +1,13 @@
+import { AsyncAPI2, AsyncAPI3 } from '../target-specs.ts';
+
 const documentation = [
   {
     docs: '#### [AsyncAPI Version String](https://www.asyncapi.com/docs/reference/specification/v2.6.0#A2SVersionString)\n\nThe version string signifies the version of the AsyncAPI Specification that the document complies to.\nThe format for this string _must_ be `major`.`minor`.`patch`.  The `patch` _may_ be suffixed by a hyphen and extra alphanumeric characters.\n\\\n\\\nA `major`.`minor` shall be used to designate the AsyncAPI Specification version, and will be considered compatible with the AsyncAPI Specification specified by that `major`.`minor` version.\nThe patch version will not be considered by tooling, making no distinction between `1.0.0` and `1.0.1`.\n\\\n\\\nIn subsequent versions of the AsyncAPI Specification, care will be given such that increments of the `minor` version should not interfere with operations of tooling developed to a lower minor version. Thus a hypothetical `1.1.0` specification should be usable with tooling designed for `1.0.0`.',
+    targetSpecs: AsyncAPI2,
+  },
+  {
+    docs: '#### [AsyncAPI Version String](https://www.asyncapi.com/docs/reference/specification/v3.0.0#A2SVersionString)\n\nThe version string signifies the version of the AsyncAPI Specification that the document complies to. The format for this string must be `major`.`minor`.`patch`. The `patch` may be suffixed by a hyphen and extra alphanumeric characters.\n\\\n\\\nA `major`.`minor` shall be used to designate the AsyncAPI Specification version, and will be considered compatible with the AsyncAPI Specification specified by that `major`.`minor` version. The patch version will not be considered by tooling, making no distinction between `1.0.0` and `1.0.1`.\n\\\n\\\nIn subsequent versions of the AsyncAPI Specification, care will be given such that increments of the `minor` version should not interfere with operations of tooling developed to a lower minor version. Thus a hypothetical `1.1.0` specification should be usable with tooling designed for `1.0.0`.',
+    targetSpecs: AsyncAPI3,
   },
 ];
 

packages/apidom-ls/src/config/asyncapi/async-api-version/lint/index.ts

@@ -5,6 +5,7 @@ import valuePattern2_3_0Lint from './value--pattern-2-3-0.ts';
 import valuePattern2_4_0Lint from './value--pattern-2-4-0.ts';
 import valuePattern2_5_0Lint from './value--pattern-2-5-0.ts';
 import valuePattern2_6_0Lint from './value--pattern-2-6-0.ts';
+import valuePattern3_0_0Lint from './value--pattern-3-0-0.ts';
 
 const lints = [
   valuePattern2_0_0Lint,
@@ -14,6 +15,7 @@ const lints = [
   valuePattern2_4_0Lint,
   valuePattern2_5_0Lint,
   valuePattern2_6_0Lint,
+  valuePattern3_0_0Lint,
 ];
 
 export default lints;

packages/apidom-ls/src/config/asyncapi/async-api-version/lint/value--pattern-3-0-0.ts

@@ -0,0 +1,6 @@
+import { LinterMeta } from '../../../../apidom-language-types.ts';
+
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const valuePattern3_0_0Lint: LinterMeta = {};
+
+export default valuePattern3_0_0Lint;

packages/apidom-ls/src/config/asyncapi/asyncapi3/completion.ts

@@ -0,0 +1,5 @@
+import { ApidomCompletionItem } from '../../../apidom-language-types.ts';
+
+const completion: ApidomCompletionItem[] = [];
+
+export default completion;

packages/apidom-ls/src/config/asyncapi/asyncapi3/documentation.ts

@@ -0,0 +1,7 @@
+const documentation = [
+  {
+    docs: '', // Add all the allowed fields link here.
+  },
+];
+
+export default documentation;

packages/apidom-ls/src/config/asyncapi/asyncapi3/lint/allowed-fields.ts

@@ -0,0 +1,4 @@
+import { LinterMeta } from '../../../../apidom-language-types.ts';
+
+const allowedFieldsLint: LinterMeta = {};
+export default allowedFieldsLint;

packages/apidom-ls/src/config/asyncapi/asyncapi3/lint/index.ts

@@ -0,0 +1,8 @@
+import allowedFieldsLint from './allowed-fields.ts';
+
+const lints = [
+  allowedFieldsLint,
+  // add all the remaining lints here
+];
+
+export default lints;

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

@@ -0,0 +1,12 @@
+import { FormatMeta } from '../../../apidom-language-types.ts';
+import lint from './lint/index.ts';
+import completion from './completion.ts';
+import documentation from './documentation.ts';
+
+const meta: FormatMeta = {
+  lint,
+  completion,
+  documentation,
+};
+
+export default meta;

packages/apidom-ls/src/config/asyncapi/bindings/amqp/channel-binding/documentation.ts

@@ -13,7 +13,7 @@ const documentation = [
   },
   {
     target: 'bindingVersion',
-    docs: 'The version of this binding. If omitted, "0.2.0" MUST be assumed.',
+    docs: 'The version of this binding. If omitted, "0.3.0" MUST be assumed.',
   },
   {
     docs: '#### [Channel Binding Object](https://github.com/asyncapi/bindings/tree/master/amqp#channel)\n\nThis object contains information about the channel representation in AMQP.\n\n##### Fixed Fields\n\nField Name | Type | Description\n---|:---:|---\n`is` | string | Defines what type of channel is it. Can be either `queue` or `routingKey` (default).\n`exchange` | Map[string, any] | When `is`=`routingKey`, this object defines the exchange properties.\n`exchange.name` | string | The name of the exchange. It MUST NOT exceed 255 characters long.\n`exchange.type` | string | The type of the exchange. Can be either `topic`, `direct`, `fanout`, `default` or `headers`.\n`exchange.durable` | boolean | Whether the exchange should survive broker restarts or not.\n`exchange.autoDelete` | boolean | Whether the exchange should be deleted when the last queue is unbound from it.\n`exchange.vhost` | string | The virtual host of the exchange. Defaults to `/`.\n`queue` | Map[string, any] | When `is`=`queue`, this object defines the queue properties.\n`queue.name` | string | The name of the queue. It MUST NOT exceed 255 characters long.\n`queue.durable` | boolean | Whether the queue should survive broker restarts or not.\n`queue.exclusive` | boolean | Whether the queue should be used only by one connection or not.\n`queue.autoDelete` | boolean | Whether the queue should be deleted when the last consumer unsubscribes.\n`queue.vhost` | string | The virtual host of the queue. Defaults to `/`.\n`bindingVersion` | string | The version of this binding. If omitted, "0.2.0" MUST be assumed.\n\nThis object MUST contain only the properties defined above.\n\n##### Example\n\n\n\\\nYAML\n```yaml\nchannels:\n  user/signedup:\n    bindings:\n      amqp:\n        is: routingKey\n        queue:\n          name: my-queue-name\n          durable: true\n          exclusive: true\n          autoDelete: false\n          vhost: /\n        exchange:\n          name: myExchange\n          type: topic\n          durable: true\n          autoDelete: false\n          vhost: /\n        bindingVersion: 0.2.0\n```',