feat(rulesets): more consistent messages in AsyncAPI ruleset (#1714)

* feat(rulesets): more consistent messages in AsyncAPI ruleset * chore: add ruleset-migrator to tsconfig.json
stoplightio · Jul 6, 2021 · 514bb28 · 514bb28
1 parent 2a1d2d3
commit 514bb28
Show file tree

Hide file tree

Showing 22 changed files with 58 additions and 60 deletions.
diff --git a/packages/rulesets/src/asyncapi/__tests__/asyncapi-channel-no-empty-parameter.test.ts b/packages/rulesets/src/asyncapi/__tests__/asyncapi-channel-no-empty-parameter.test.ts
@@ -24,7 +24,7 @@ testRule('asyncapi-channel-no-empty-parameter', [
     },
     errors: [
       {
-        message: 'Channel path should not have empty parameter substitution pattern.',
+        message: 'Channel path must not have empty parameter substitution pattern.',
         path: ['channels', 'users/{}/signedOut'],
         severity: DiagnosticSeverity.Warning,
       },

diff --git a/packages/rulesets/src/asyncapi/__tests__/asyncapi-channel-no-query-nor-fragment.test.ts b/packages/rulesets/src/asyncapi/__tests__/asyncapi-channel-no-query-nor-fragment.test.ts
@@ -24,7 +24,7 @@ testRule('asyncapi-channel-no-query-nor-fragment', [
     },
     errors: [
       {
-        message: 'Channel path should not include a query (`?`) or a fragment (`#`) delimiter.',
+        message: 'Channel path must not include query ("?") or fragment ("#") delimiter.',
         path: ['channels', 'users/{userId}/signedOut?byMistake={didFatFingerTheSignOutButton}'],
         severity: DiagnosticSeverity.Warning,
       },
@@ -42,7 +42,7 @@ testRule('asyncapi-channel-no-query-nor-fragment', [
     },
     errors: [
       {
-        message: 'Channel path should not include a query (`?`) or a fragment (`#`) delimiter.',
+        message: 'Channel path must not include query ("?") or fragment ("#") delimiter.',
         path: ['channels', 'users/{userId}/signedOut#onPurpose'],
         severity: DiagnosticSeverity.Warning,
       },

diff --git a/packages/rulesets/src/asyncapi/__tests__/asyncapi-channel-no-trailing-slash.test.ts b/packages/rulesets/src/asyncapi/__tests__/asyncapi-channel-no-trailing-slash.test.ts
@@ -24,7 +24,7 @@ testRule('asyncapi-channel-no-trailing-slash', [
     },
     errors: [
       {
-        message: 'Channel path should not end with a slash.',
+        message: 'Channel path must not end with slash.',
         path: ['channels', 'users/{userId}/signedOut/'],
         severity: DiagnosticSeverity.Warning,
       },

diff --git a/packages/rulesets/src/asyncapi/__tests__/asyncapi-headers-schema-type-object.test.ts b/packages/rulesets/src/asyncapi/__tests__/asyncapi-headers-schema-type-object.test.ts
@@ -52,7 +52,7 @@ testRule('asyncapi-headers-schema-type-object', [
     errors: [
       {
         message:
-          'Headers schema type must be `object` (`type` property must be equal to one of the allowed values: `object`. Did you mean `object`?).',
+          'Headers schema type must be "object" (`type` property must be equal to one of the allowed values: `object`. Did you mean `object`?).',
         path: ['components', 'messages', 'aMessage', 'headers', 'type'],
         severity: DiagnosticSeverity.Error,
       },
@@ -66,7 +66,7 @@ testRule('asyncapi-headers-schema-type-object', [
     }),
     errors: [
       {
-        message: 'Headers schema type must be `object` (`headers` property must have required property `type`).',
+        message: 'Headers schema type must be "object" (`headers` property must have required property `type`).',
         path: ['components', 'messages', 'aMessage', 'headers'],
         severity: DiagnosticSeverity.Error,
       },
@@ -81,7 +81,7 @@ testRule('asyncapi-headers-schema-type-object', [
     errors: [
       {
         message:
-          'Headers schema type must be `object` (`type` property must be equal to one of the allowed values: `object`. Did you mean `object`?).',
+          'Headers schema type must be "object" (`type` property must be equal to one of the allowed values: `object`. Did you mean `object`?).',
         path: ['components', 'messageTraits', 'aTrait', 'headers', 'type'],
         severity: DiagnosticSeverity.Error,
       },
@@ -95,7 +95,7 @@ testRule('asyncapi-headers-schema-type-object', [
     }),
     errors: [
       {
-        message: 'Headers schema type must be `object` (`headers` property must have required property `type`).',
+        message: 'Headers schema type must be "object" (`headers` property must have required property `type`).',
         path: ['components', 'messageTraits', 'aTrait', 'headers'],
         severity: DiagnosticSeverity.Error,
       },
@@ -110,7 +110,7 @@ testRule('asyncapi-headers-schema-type-object', [
       }),
       errors: [
         {
-          message: 'Headers schema type must be `object` (`headers` property must have required property `type`).',
+          message: 'Headers schema type must be "object" (`headers` property must have required property `type`).',
           path: ['channels', 'users/{userId}/signedUp', property, 'message', 'headers'],
           severity: DiagnosticSeverity.Error,
         },
@@ -125,7 +125,7 @@ testRule('asyncapi-headers-schema-type-object', [
       errors: [
         {
           message:
-            'Headers schema type must be `object` (`type` property must be equal to one of the allowed values: `object`. Did you mean `object`?).',
+            'Headers schema type must be "object" (`type` property must be equal to one of the allowed values: `object`. Did you mean `object`?).',
           path: ['channels', 'users/{userId}/signedUp', property, 'message', 'headers', 'type'],
           severity: DiagnosticSeverity.Error,
         },

diff --git a/packages/rulesets/src/asyncapi/__tests__/asyncapi-info-contact-properties.test.ts b/packages/rulesets/src/asyncapi/__tests__/asyncapi-info-contact-properties.test.ts
@@ -27,7 +27,7 @@ testRule('asyncapi-info-contact-properties', [
     }),
     errors: [
       {
-        message: 'Contact object should have `name`, `url` and `email`.',
+        message: 'Contact object must have "name", "url" and "email".',
         path: ['info', 'contact'],
         severity: DiagnosticSeverity.Warning,
       },

diff --git a/packages/rulesets/src/asyncapi/__tests__/asyncapi-info-contact.test.ts b/packages/rulesets/src/asyncapi/__tests__/asyncapi-info-contact.test.ts
@@ -25,7 +25,7 @@ testRule('asyncapi-info-contact', [
     },
     errors: [
       {
-        message: 'Info object should contain `contact` object.',
+        message: 'Info object must have "contact" object.',
         path: ['info'],
         severity: DiagnosticSeverity.Warning,
       },

diff --git a/packages/rulesets/src/asyncapi/__tests__/asyncapi-info-description.test.ts b/packages/rulesets/src/asyncapi/__tests__/asyncapi-info-description.test.ts
@@ -20,7 +20,7 @@ testRule('asyncapi-info-description', [
     },
     errors: [
       {
-        message: 'AsyncAPI object info `description` must be present and non-empty string.',
+        message: 'Info "description" must be present and non-empty string.',
         path: ['info'],
         severity: DiagnosticSeverity.Warning,
       },

diff --git a/packages/rulesets/src/asyncapi/__tests__/asyncapi-info-license-url.test.ts b/packages/rulesets/src/asyncapi/__tests__/asyncapi-info-license-url.test.ts
@@ -25,7 +25,7 @@ testRule('asyncapi-info-license-url', [
     },
     errors: [
       {
-        message: 'License object should include `url`.',
+        message: 'License object must include "url".',
         path: ['info', 'license'],
         severity: DiagnosticSeverity.Warning,
       },

diff --git a/packages/rulesets/src/asyncapi/__tests__/asyncapi-info-license.test.ts b/packages/rulesets/src/asyncapi/__tests__/asyncapi-info-license.test.ts
@@ -23,7 +23,7 @@ testRule('asyncapi-info-license', [
     },
     errors: [
       {
-        message: 'AsyncAPI object should contain `license` object.',
+        message: 'Info object must have "license" object.',
         path: ['info'],
         severity: DiagnosticSeverity.Warning,
       },

diff --git a/packages/rulesets/src/asyncapi/__tests__/asyncapi-operation-description.test.ts b/packages/rulesets/src/asyncapi/__tests__/asyncapi-operation-description.test.ts
@@ -30,7 +30,7 @@ testRule('asyncapi-operation-description', [
     }),
     errors: [
       {
-        message: 'Operation `description` must be present and non-empty string.',
+        message: 'Operation "description" must be present and non-empty string.',
         path: ['channels', 'one', property],
         severity: DiagnosticSeverity.Warning,
       },

diff --git a/packages/rulesets/src/asyncapi/__tests__/asyncapi-operation-operationId.test.ts b/packages/rulesets/src/asyncapi/__tests__/asyncapi-operation-operationId.test.ts
@@ -30,7 +30,7 @@ testRule('asyncapi-operation-operationId', [
     }),
     errors: [
       {
-        message: 'Operation should have an `operationId`.',
+        message: 'Operation must have "operationId".',
         path: ['channels', 'one', property],
         severity: DiagnosticSeverity.Error,
       },

diff --git a/packages/rulesets/src/asyncapi/__tests__/asyncapi-parameter-description.test.ts b/packages/rulesets/src/asyncapi/__tests__/asyncapi-parameter-description.test.ts
@@ -36,7 +36,7 @@ testRule('asyncapi-parameter-description', [
     }),
     errors: [
       {
-        message: 'Parameter objects should have a `description`.',
+        message: 'Parameter objects must have "description".',
         path: ['channels', 'users/{userId}/signedUp', 'parameters', 'userId'],
         severity: DiagnosticSeverity.Warning,
       },
@@ -50,7 +50,7 @@ testRule('asyncapi-parameter-description', [
     }),
     errors: [
       {
-        message: 'Parameter objects should have a `description`.',
+        message: 'Parameter objects must have "description".',
         path: ['components', 'parameters', 'orphanParameter'],
         severity: DiagnosticSeverity.Warning,
       },

diff --git a/packages/rulesets/src/asyncapi/__tests__/asyncapi-payload-unsupported-schemaFormat.test.ts b/packages/rulesets/src/asyncapi/__tests__/asyncapi-payload-unsupported-schemaFormat.test.ts
@@ -38,7 +38,7 @@ testRule('asyncapi-payload-unsupported-schemaFormat', [
     }),
     errors: [
       {
-        message: 'Message schema validation is only supported with default unspecified `schemaFormat`.',
+        message: 'Message schema validation is only supported with default unspecified "schemaFormat".',
         path: ['components', 'messages', 'aMessage', 'schemaFormat'],
         severity: DiagnosticSeverity.Information,
       },
@@ -52,7 +52,7 @@ testRule('asyncapi-payload-unsupported-schemaFormat', [
     }),
     errors: [
       {
-        message: 'Message schema validation is only supported with default unspecified `schemaFormat`.',
+        message: 'Message schema validation is only supported with default unspecified "schemaFormat".',
         path: ['components', 'messageTraits', 'aTrait', 'schemaFormat'],
         severity: DiagnosticSeverity.Information,
       },
@@ -66,7 +66,7 @@ testRule('asyncapi-payload-unsupported-schemaFormat', [
     }),
     errors: [
       {
-        message: 'Message schema validation is only supported with default unspecified `schemaFormat`.',
+        message: 'Message schema validation is only supported with default unspecified "schemaFormat".',
         path: ['channels', 'users/{userId}/signedUp', property, 'message', 'schemaFormat'],
         severity: DiagnosticSeverity.Information,
       },

diff --git a/packages/rulesets/src/asyncapi/__tests__/asyncapi-server-no-empty-variable.test.ts b/packages/rulesets/src/asyncapi/__tests__/asyncapi-server-no-empty-variable.test.ts
@@ -28,7 +28,7 @@ testRule('asyncapi-server-no-empty-variable', [
     },
     errors: [
       {
-        message: 'Server URL should not have empty variable substitution pattern.',
+        message: 'Server URL must not have empty variable substitution pattern.',
         path: ['servers', 'production', 'url'],
         severity: DiagnosticSeverity.Warning,
       },

diff --git a/packages/rulesets/src/asyncapi/__tests__/asyncapi-server-no-trailing-slash.test.ts b/packages/rulesets/src/asyncapi/__tests__/asyncapi-server-no-trailing-slash.test.ts
@@ -29,7 +29,7 @@ testRule('asyncapi-server-no-trailing-slash', [
     },
     errors: [
       {
-        message: 'Server URL should not end with a slash.',
+        message: 'Server URL must not end with slash.',
         path: ['servers', 'production', 'url'],
         severity: DiagnosticSeverity.Warning,
       },

diff --git a/packages/rulesets/src/asyncapi/__tests__/asyncapi-server-not-example-com.test.ts b/packages/rulesets/src/asyncapi/__tests__/asyncapi-server-not-example-com.test.ts
@@ -29,7 +29,7 @@ testRule('asyncapi-server-not-example-com', [
     },
     errors: [
       {
-        message: 'Server URL should not point at example.com.',
+        message: 'Server URL must not point at example.com.',
         path: ['servers', 'production', 'url'],
         severity: DiagnosticSeverity.Warning,
       },

diff --git a/packages/rulesets/src/asyncapi/__tests__/asyncapi-servers.test.ts b/packages/rulesets/src/asyncapi/__tests__/asyncapi-servers.test.ts
@@ -23,7 +23,7 @@ testRule('asyncapi-servers', [
     },
     errors: [
       {
-        message: 'AsyncAPI object should contain a non empty `servers` object.',
+        message: 'AsyncAPI object must have non-empty "servers" object.',
         path: [],
         severity: DiagnosticSeverity.Warning,
       },
@@ -38,7 +38,7 @@ testRule('asyncapi-servers', [
     },
     errors: [
       {
-        message: 'AsyncAPI object should contain a non empty `servers` object.',
+        message: 'AsyncAPI object must have non-empty "servers" object.',
         path: ['servers'],
         severity: DiagnosticSeverity.Warning,
       },

diff --git a/packages/rulesets/src/asyncapi/__tests__/asyncapi-tag-description.test.ts b/packages/rulesets/src/asyncapi/__tests__/asyncapi-tag-description.test.ts
@@ -28,7 +28,7 @@ testRule('asyncapi-tag-description', [
     },
     errors: [
       {
-        message: 'Tag object should have a `description`.',
+        message: 'Tag object must have "description".',
         path: ['tags', '0'],
         severity: DiagnosticSeverity.Warning,
       },

diff --git a/packages/rulesets/src/asyncapi/__tests__/asyncapi-tags-alphabetical.test.ts b/packages/rulesets/src/asyncapi/__tests__/asyncapi-tags-alphabetical.test.ts
@@ -19,7 +19,7 @@ testRule('asyncapi-tags-alphabetical', [
     },
     errors: [
       {
-        message: 'AsyncAPI object should have alphabetical `tags`.',
+        message: 'AsyncAPI object must have alphabetical "tags".',
         path: ['tags'],
         severity: DiagnosticSeverity.Warning,
       },

diff --git a/packages/rulesets/src/asyncapi/__tests__/asyncapi-tags.test.ts b/packages/rulesets/src/asyncapi/__tests__/asyncapi-tags.test.ts
@@ -18,7 +18,7 @@ testRule('asyncapi-tags', [
     },
     errors: [
       {
-        message: 'AsyncAPI object should have non-empty `tags` array.',
+        message: 'AsyncAPI object must have non-empty "tags" array.',
         path: [],
         severity: DiagnosticSeverity.Warning,
       },