@redocly/openapi-core 1.1.0 → 1.2.0

package/src/rules/async2/__tests__/no-channel-trailing-slash.test.ts

@@ -0,0 +1,97 @@
+import { outdent } from 'outdent';
+import { lintDocument } from '../../../lint';
+import { parseYamlToDocument, replaceSourceWithRef, makeConfig } from '../../../../__tests__/utils';
+import { BaseResolver } from '../../../resolve';
+
+describe('no-channel-trailing-slash', () => {
+  it('should report on trailing slash in a channel path', async () => {
+    const document = parseYamlToDocument(
+      outdent`
+          asyncapi: '2.6.0'
+          info:
+            title: Excellent API
+            version: 1.0.0
+          channels:
+            /trailing/:
+              subscribe:
+                message:
+                  messageId: Message1
+        `,
+      'asyncapi.yaml'
+    );
+
+    const results = await lintDocument({
+      externalRefResolver: new BaseResolver(),
+      document,
+      config: await makeConfig({ 'no-channel-trailing-slash': 'error' }),
+    });
+
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
+      Array [
+        Object {
+          "location": Array [
+            Object {
+              "pointer": "#/channels/~1trailing~1",
+              "reportOnKey": true,
+              "source": "asyncapi.yaml",
+            },
+          ],
+          "message": "\`/trailing/\` should not have a trailing slash.",
+          "ruleId": "no-channel-trailing-slash",
+          "severity": "error",
+          "suggest": Array [],
+        },
+      ]
+    `);
+  });
+
+  it('should not report on if no trailing slash in path', async () => {
+    const document = parseYamlToDocument(
+      outdent`
+          asyncapi: '2.6.0'
+          info:
+            title: Excellent API
+            version: 1.0.0
+          channels:
+            /expected:
+              subscribe:
+                message:
+                  messageId: Message1
+        `,
+      'asyncapi.yaml'
+    );
+
+    const results = await lintDocument({
+      externalRefResolver: new BaseResolver(),
+      document,
+      config: await makeConfig({ 'no-channel-trailing-slash': 'error' }),
+    });
+
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
+  });
+
+  it('should not report on trailing slash in path if the path is root', async () => {
+    const document = parseYamlToDocument(
+      outdent`
+          asyncapi: '2.6.0'
+          info:
+            title: Excellent API
+            version: 1.0.0
+          channels:
+            /:
+              subscribe:
+                message:
+                  messageId: Message1
+        `,
+      'foobar.yaml'
+    );
+
+    const results = await lintDocument({
+      externalRefResolver: new BaseResolver(),
+      document,
+      config: await makeConfig({ 'no-channel-trailing-slash': 'error' }),
+    });
+
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
+  });
+});

package/src/rules/async2/channels-kebab-case.ts

@@ -0,0 +1,18 @@
+import { Async2Rule } from '../../visitors';
+import { UserContext } from '../../walk';
+
+export const ChannelsKebabCase: Async2Rule = () => {
+  return {
+    Channel(_channel: object, { report, key }: UserContext) {
+      const segments = (key as string)
+        .split(/[/.:]/) // split on / or : as likely channel namespacers
+        .filter((s) => s !== ''); // filter out empty segments
+      if (!segments.every((segment) => /^{.+}$/.test(segment) || /^[a-z0-9-.]+$/.test(segment))) {
+        report({
+          message: `\`${key}\` does not use kebab-case.`,
+          location: { reportOnKey: true },
+        });
+      }
+    },
+  };
+};

package/src/rules/async2/index.ts

@@ -0,0 +1,22 @@
+import { Async2Rule } from '../../visitors';
+import { Assertions } from '../common/assertions';
+import { Spec } from '../common/spec';
+import { InfoContact } from '../common/info-contact';
+import { OperationOperationId } from '../common/operation-operationId';
+import { TagDescription } from '../common/tag-description';
+import { TagsAlphabetical } from '../common/tags-alphabetical';
+import { ChannelsKebabCase } from './channels-kebab-case';
+import { NoChannelTrailingSlash } from './no-channel-trailing-slash';
+
+export const rules = {
+  spec: Spec as Async2Rule,
+  assertions: Assertions,
+  'info-contact': InfoContact,
+  'operation-operationId': OperationOperationId,
+  'channels-kebab-case': ChannelsKebabCase,
+  'no-channel-trailing-slash': NoChannelTrailingSlash,
+  'tag-description': TagDescription,
+  'tags-alphabetical': TagsAlphabetical,
+};
+
+export const preprocessors = {};

package/src/rules/async2/no-channel-trailing-slash.ts

@@ -0,0 +1,15 @@
+import { Async2Rule } from '../../visitors';
+import { UserContext } from '../../walk';
+
+export const NoChannelTrailingSlash: Async2Rule = () => {
+  return {
+    Channel(_channel: any, { report, key, location }: UserContext) {
+      if ((key as string).endsWith('/') && key !== '/') {
+        report({
+          message: `\`${key}\` should not have a trailing slash.`,
+          location: location.key(),
+        });
+      }
+    },
+  };
+};

package/src/rules/common/scalar-property-missing-example.ts

@@ -2,7 +2,7 @@ import type { Oas2Rule, Oas3Rule } from '../../visitors';
 import type { UserContext } from '../../walk';
 import type { Oas2Schema } from '../../typings/swagger';
 import type { Oas3Schema, Oas3_1Schema } from '../../typings/openapi';
-import { OasVersion } from '../../oas-types';
+import { SpecVersion } from '../../oas-types';
 
 const SCALAR_TYPES = ['string', 'integer', 'number', 'boolean', 'null'];
 
@@ -25,7 +25,7 @@ export const ScalarPropertyMissingExample: Oas3Rule | Oas2Rule = () => {
         ) {
           report({
             message: `Scalar property should have "example"${
-              oasVersion === OasVersion.Version3_1 ? ' or "examples"' : ''
+              oasVersion === SpecVersion.OAS3_1 ? ' or "examples"' : ''
             } defined.`,
             location: location.child(propName).key(),
           });

package/src/rules/common/spec.ts

@@ -1,11 +1,11 @@
-import type { Oas3Rule, Oas2Rule } from '../../visitors';
+import type { Oas3Rule, Oas2Rule, Async2Rule } from '../../visitors';
 import { isNamedType, SpecExtension } from '../../types';
 import { oasTypeOf, matchesJsonSchemaType, getSuggest, validateSchemaEnumType } from '../utils';
 import { isRef } from '../../ref-utils';
 import { isPlainObject } from '../../utils';
 import { UserContext } from '../../walk';
 
-export const OasSpec: Oas3Rule | Oas2Rule = () => {
+export const Spec: Oas3Rule | Oas2Rule | Async2Rule = () => {
   return {
     any(
       node: any,

package/src/rules/oas2/index.ts

@@ -1,5 +1,5 @@
 import { Oas2Rule } from '../../visitors';
-import { OasSpec } from '../common/spec';
+import { Spec } from '../common/spec';
 import { NoInvalidSchemaExamples } from '../common/no-invalid-schema-examples';
 import { NoInvalidParameterExamples } from '../common/no-invalid-parameter-examples';
 import { InfoContact } from '../common/info-contact';
@@ -43,7 +43,7 @@ import { RequiredStringPropertyMissingMinLength } from '../common/required-strin
 import { SpecStrictRefs } from '../common/spec-strict-refs';
 
 export const rules = {
-  spec: OasSpec as Oas2Rule,
+  spec: Spec as Oas2Rule,
   'no-invalid-schema-examples': NoInvalidSchemaExamples,
   'no-invalid-parameter-examples': NoInvalidParameterExamples,
   'info-contact': InfoContact as Oas2Rule,

package/src/rules/oas3/index.ts

@@ -1,5 +1,5 @@
 import { Oas3RuleSet } from '../../oas-types';
-import { OasSpec } from '../common/spec';
+import { Spec } from '../common/spec';
 import { Operation2xxResponse } from '../common/operation-2xx-response';
 import { Operation4xxResponse } from '../common/operation-4xx-response';
 import { Assertions } from '../common/assertions';
@@ -54,7 +54,7 @@ import { SpecStrictRefs } from '../common/spec-strict-refs';
 import { ComponentNameUnique } from './component-name-unique';
 
 export const rules = {
-  spec: OasSpec,
+  spec: Spec,
   'info-contact': InfoContact,
   'info-license': InfoLicense,
   'info-license-url': InfoLicenseUrl,