feat: add new rule no-illogical-any-of-usage

Author: AlbinaBlazhko17

packages/core/src/config/all.ts

@@ -118,6 +118,7 @@ const all: RawGovernanceConfig<'built-in'> = {
     'tags-alphabetical': 'error',
     'no-duplicated-tag-names': 'error',
     'no-illogical-one-of-usage': 'error',
+    'no-illogical-any-of-usage': 'error',
   },
   oas3_1Rules: {
     'array-parameter-serialization': 'error',
@@ -181,6 +182,7 @@ const all: RawGovernanceConfig<'built-in'> = {
     'tags-alphabetical': 'error',
     'no-duplicated-tag-names': 'error',
     'no-illogical-one-of-usage': 'error',
+    'no-illogical-any-of-usage': 'error',
   },
   oas3_2Rules: {
     'array-parameter-serialization': 'error',
@@ -244,6 +246,7 @@ const all: RawGovernanceConfig<'built-in'> = {
     'tags-alphabetical': 'error',
     'no-duplicated-tag-names': 'error',
     'no-illogical-one-of-usage': 'error',
+    'no-illogical-any-of-usage': 'error',
   },
   async2Rules: {
     'channels-kebab-case': 'error',

packages/core/src/config/minimal.ts

@@ -109,6 +109,7 @@ const minimal: RawGovernanceConfig<'built-in'> = {
     'tags-alphabetical': 'off',
     'no-duplicated-tag-names': 'off',
     'no-illogical-one-of-usage': 'off',
+    'no-illogical-any-of-usage': 'off',
   },
   oas3_1Rules: {
     'array-parameter-serialization': 'off',
@@ -166,6 +167,7 @@ const minimal: RawGovernanceConfig<'built-in'> = {
     'tags-alphabetical': 'off',
     'no-duplicated-tag-names': 'off',
     'no-illogical-one-of-usage': 'off',
+    'no-illogical-any-of-usage': 'off',
   },
   oas3_2Rules: {
     'array-parameter-serialization': 'off',
@@ -223,6 +225,7 @@ const minimal: RawGovernanceConfig<'built-in'> = {
     'tags-alphabetical': 'off',
     'no-duplicated-tag-names': 'off',
     'no-illogical-one-of-usage': 'off',
+    'no-illogical-any-of-usage': 'off',
   },
   async2Rules: {
     'channels-kebab-case': 'off',

packages/core/src/config/recommended-strict.ts

@@ -109,6 +109,7 @@ const recommendedStrict: RawGovernanceConfig<'built-in'> = {
     'tags-alphabetical': 'off',
     'no-duplicated-tag-names': 'error',
     'no-illogical-one-of-usage': 'error',
+    'no-illogical-any-of-usage': 'error',
   },
   oas3_1Rules: {
     'array-parameter-serialization': 'off',
@@ -166,6 +167,7 @@ const recommendedStrict: RawGovernanceConfig<'built-in'> = {
     'tags-alphabetical': 'off',
     'no-duplicated-tag-names': 'error',
     'no-illogical-one-of-usage': 'error',
+    'no-illogical-any-of-usage': 'error',
   },
   oas3_2Rules: {
     'array-parameter-serialization': 'off',
@@ -223,6 +225,7 @@ const recommendedStrict: RawGovernanceConfig<'built-in'> = {
     'tags-alphabetical': 'off',
     'no-duplicated-tag-names': 'error',
     'no-illogical-one-of-usage': 'error',
+    'no-illogical-any-of-usage': 'error',
   },
   async2Rules: {
     'channels-kebab-case': 'off',

packages/core/src/config/recommended.ts

@@ -109,6 +109,7 @@ const recommended: RawGovernanceConfig<'built-in'> = {
     'tags-alphabetical': 'off',
     'no-duplicated-tag-names': 'warn',
     'no-illogical-one-of-usage': 'warn',
+    'no-illogical-any-of-usage': 'warn',
   },
   oas3_1Rules: {
     'array-parameter-serialization': 'off',
@@ -166,6 +167,7 @@ const recommended: RawGovernanceConfig<'built-in'> = {
     'tags-alphabetical': 'off',
     'no-duplicated-tag-names': 'warn',
     'no-illogical-one-of-usage': 'warn',
+    'no-illogical-any-of-usage': 'warn',
   },
   oas3_2Rules: {
     'array-parameter-serialization': 'off',
@@ -223,6 +225,7 @@ const recommended: RawGovernanceConfig<'built-in'> = {
     'tags-alphabetical': 'off',
     'no-duplicated-tag-names': 'warn',
     'no-illogical-one-of-usage': 'warn',
+    'no-illogical-any-of-usage': 'warn',
   },
   async2Rules: {
     'channels-kebab-case': 'off',

packages/core/src/config/spec.ts

@@ -109,6 +109,7 @@ const spec: RawGovernanceConfig<'built-in'> = {
     'tags-alphabetical': 'off',
     'nullable-type-sibling': 'error',
     'no-illogical-one-of-usage': 'off',
+    'no-illogical-any-of-usage': 'off',
   },
   oas3_1Rules: {
     'array-parameter-serialization': 'off',
@@ -166,6 +167,7 @@ const spec: RawGovernanceConfig<'built-in'> = {
     'tag-description': 'off',
     'tags-alphabetical': 'off',
     'no-illogical-one-of-usage': 'error',
+    'no-illogical-any-of-usage': 'error',
   },
   oas3_2Rules: {
     'array-parameter-serialization': 'off',
@@ -223,6 +225,7 @@ const spec: RawGovernanceConfig<'built-in'> = {
     'tag-description': 'off',
     'tags-alphabetical': 'off',
     'no-illogical-one-of-usage': 'error',
+    'no-illogical-any-of-usage': 'error',
   },
   async2Rules: {
     'channels-kebab-case': 'off',

packages/core/src/rules/oas3/index.ts

@@ -56,6 +56,7 @@ import { NoSchemaTypeMismatch } from '../common/no-schema-type-mismatch.js';
 import { NoDuplicatedTagNames } from '../common/no-duplicated-tag-names.js';
 import { NullableTypeSibling } from './nullable-type-sibling.js';
 import { NoIllogicalOneOfUsage } from './no-illogical-one-of-usage.js';
+import { NoIllogicalAnyOfUsage } from './no-illogical-any-of-usage.js';
 
 import type { Oas3RuleSet } from '../../oas-types.js';
 import type { Oas3Rule } from '../../visitors.js';
@@ -120,6 +121,7 @@ export const rules: Oas3RuleSet<'built-in'> = {
   'no-duplicated-tag-names': NoDuplicatedTagNames as Oas3Rule,
   'nullable-type-sibling': NullableTypeSibling,
   'no-illogical-one-of-usage': NoIllogicalOneOfUsage as Oas3Rule,
+  'no-illogical-any-of-usage': NoIllogicalAnyOfUsage as Oas3Rule,
 };
 
 export const preprocessors = {};

packages/core/src/rules/oas3/no-illogical-any-of-usage.ts

@@ -0,0 +1,34 @@
+import { areDuplicatedSchemas } from '../utils.js';
+
+import type { Oas3Rule, Oas3Visitor } from '../../visitors.js';
+import type { Oas3Schema, Oas3_1Schema } from '../../typings/openapi.js';
+import type { UserContext } from '../../walk.js';
+
+export const NoIllogicalAnyOfUsage: Oas3Rule = (): Oas3Visitor => {
+  return {
+    Schema: {
+      skip(node) {
+        return !node.anyOf;
+      },
+      enter(schema: Oas3Schema | Oas3_1Schema, { report, location }: UserContext) {
+        if (!schema.anyOf) return;
+        if (!Array.isArray(schema.anyOf)) return;
+
+        if (schema.anyOf.length < 2) {
+          report({
+            message: '`anyOf` must have at least two items',
+            location,
+          });
+        } else {
+          const { isDuplicated, reason: duplicatedReason } = areDuplicatedSchemas(schema.anyOf);
+          if (isDuplicated && duplicatedReason) {
+            report({
+              message: duplicatedReason,
+              location,
+            });
+          }
+        }
+      },
+    },
+  };
+};