feat(rulesets): support AsyncAPI 2.4 (#2146)

stoplightio · May 2, 2022 · 4332508 · 4332508
1 parent 0445b8a
commit 4332508
Show file tree

Hide file tree

Showing 6 changed files with 27 additions and 5 deletions.
diff --git a/docs/getting-started/3-rulesets.md b/docs/getting-started/3-rulesets.md
@@ -80,6 +80,7 @@ Formats are an optional way to specify which API description formats a rule, or
 - `aas2_1` (AsyncAPI v2.1.0)
 - `aas2_2` (AsyncAPI v2.2.0)
 - `aas2_3` (AsyncAPI v2.3.0)
+- `aas2_4` (AsyncAPI v2.4.0)
 - `oas2` (OpenAPI v2.0)
 - `oas3` (OpenAPI v3.x)
 - `oas3.0` (OpenAPI v3.0.x)

diff --git a/packages/formats/src/__tests__/asyncapi.test.ts b/packages/formats/src/__tests__/asyncapi.test.ts
@@ -1,4 +1,4 @@
-import { aas2, aas2_0, aas2_1, aas2_2, aas2_3 } from '../asyncapi';
+import { aas2, aas2_0, aas2_1, aas2_2, aas2_3, aas2_4 } from '../asyncapi';
 
 describe('AsyncAPI format', () => {
   describe('AsyncAPI 2.x', () => {
@@ -75,4 +75,17 @@ describe('AsyncAPI format', () => {
       },
     );
   });
+
+  describe('AsyncAPI 2.4', () => {
+    it.each(['2.4.0', '2.4.3'])('recognizes %s version correctly', version => {
+      expect(aas2_4({ asyncapi: version }, null)).toBe(true);
+    });
+
+    it.each(['2', '2.3', '2.0.0', '2.1.0', '2.1.37', '2.2.0', '2.3.0', '2.5.0', '2.5.3'])(
+      'does not recognize %s version',
+      version => {
+        expect(aas2_4({ asyncapi: version }, null)).toBe(false);
+      },
+    );
+  });
 });
diff --git a/packages/formats/src/asyncapi.ts b/packages/formats/src/asyncapi.ts
@@ -8,6 +8,7 @@ const aas2_0Regex = /^2\.0(?:\.[0-9]*)?$/;
 const aas2_1Regex = /^2\.1(?:\.[0-9]*)?$/;
 const aas2_2Regex = /^2\.2(?:\.[0-9]*)?$/;
 const aas2_3Regex = /^2\.3(?:\.[0-9]*)?$/;
+const aas2_4Regex = /^2\.4(?:\.[0-9]*)?$/;
 
 const isAas2 = (document: unknown): document is { asyncapi: string } & Record<string, unknown> =>
   isPlainObject(document) && 'asyncapi' in document && aas2Regex.test(String((document as MaybeAAS2).asyncapi));
@@ -34,3 +35,7 @@ aas2_2.displayName = 'AsyncAPI 2.2.x';
 export const aas2_3: Format = (document: unknown): boolean =>
   isAas2(document) && aas2_3Regex.test(String((document as MaybeAAS2).asyncapi));
 aas2_3.displayName = 'AsyncAPI 2.3.x';
+
+export const aas2_4: Format = (document: unknown): boolean =>
+  isAas2(document) && aas2_4Regex.test(String((document as MaybeAAS2).asyncapi));
+aas2_4.displayName = 'AsyncAPI 2.4.x';
diff --git a/packages/rulesets/package.json b/packages/rulesets/package.json
@@ -21,7 +21,7 @@
     "release": "semantic-release -e semantic-release-monorepo"
   },
   "dependencies": {
-    "@asyncapi/specs": "^2.13.0",
+    "@asyncapi/specs": "^2.14.0",
     "@stoplight/better-ajv-errors": "1.0.1",
     "@stoplight/json": "^3.17.0",
     "@stoplight/spectral-core": "^1.8.1",

diff --git a/packages/rulesets/src/asyncapi/functions/asyncApi2DocumentSchema.ts b/packages/rulesets/src/asyncapi/functions/asyncApi2DocumentSchema.ts
@@ -1,6 +1,6 @@
 import { createRulesetFunction } from '@stoplight/spectral-core';
 import { schema as schemaFn } from '@stoplight/spectral-functions';
-import { aas2_0, aas2_1, aas2_2, aas2_3 } from '@stoplight/spectral-formats';
+import { aas2_0, aas2_1, aas2_2, aas2_3, aas2_4 } from '@stoplight/spectral-formats';
 
 import type { ErrorObject } from 'ajv';
 import type { IFunctionResult, Format } from '@stoplight/spectral-core';
@@ -10,6 +10,7 @@ import * as asyncAPI2_0_0Schema from '@asyncapi/specs/schemas/2.0.0.json';
 import * as asyncAPI2_1_0Schema from '@asyncapi/specs/schemas/2.1.0.json';
 import * as asyncAPI2_2_0Schema from '@asyncapi/specs/schemas/2.2.0.json';
 import * as asyncAPI2_3_0Schema from '@asyncapi/specs/schemas/2.3.0.json';
+import * as asyncAPI2_4_0Schema from '@asyncapi/specs/schemas/2.4.0.json';
 
 function shouldIgnoreError(error: ErrorObject): boolean {
   return (
@@ -81,6 +82,8 @@ function getSchema(formats: Set<Format>): Record<string, unknown> | void {
       return asyncAPI2_2_0Schema;
     case formats.has(aas2_3):
       return asyncAPI2_3_0Schema;
+    case formats.has(aas2_4):
+      return asyncAPI2_4_0Schema;
     default:
       return;
   }

diff --git a/packages/rulesets/src/asyncapi/index.ts b/packages/rulesets/src/asyncapi/index.ts
@@ -1,4 +1,4 @@
-import { aas2_0, aas2_1, aas2_2, aas2_3 } from '@stoplight/spectral-formats';
+import { aas2_0, aas2_1, aas2_2, aas2_3, aas2_4 } from '@stoplight/spectral-formats';
 import {
   truthy,
   pattern,
@@ -14,7 +14,7 @@ import asyncApi2PayloadValidation from './functions/asyncApi2PayloadValidation';
 
 export default {
   documentationUrl: 'https://meta.stoplight.io/docs/spectral/docs/reference/asyncapi-rules.md',
-  formats: [aas2_0, aas2_1, aas2_2, aas2_3],
+  formats: [aas2_0, aas2_1, aas2_2, aas2_3, aas2_4],
   rules: {
     'asyncapi-channel-no-empty-parameter': {
       description: 'Channel path must not have empty parameter substitution pattern.',