@redocly/openapi-core 1.2.1 → 1.4.0

package/src/config/__tests__/__snapshots__/config.test.ts.snap

@@ -5,160 +5,160 @@ StyleguideConfig {
   "_usedRules": Set {},
   "_usedVersions": Set {},
   "configFile": undefined,
-  "decorators": Object {
-    "async2": Object {
-      "oas2": Object {},
-      "oas3_0": Object {},
-      "oas3_1": Object {},
-    },
-    "oas2": Object {
-      "oas2": Object {},
-      "oas3_0": Object {},
-      "oas3_1": Object {},
-    },
-    "oas3_0": Object {
-      "oas2": Object {},
-      "oas3_0": Object {},
-      "oas3_1": Object {},
-    },
-    "oas3_1": Object {
-      "oas2": Object {},
-      "oas3_0": Object {},
-      "oas3_1": Object {},
+  "decorators": {
+    "async2": {
+      "oas2": {},
+      "oas3_0": {},
+      "oas3_1": {},
+    },
+    "oas2": {
+      "oas2": {},
+      "oas3_0": {},
+      "oas3_1": {},
+    },
+    "oas3_0": {
+      "oas2": {},
+      "oas3_0": {},
+      "oas3_1": {},
+    },
+    "oas3_1": {
+      "oas2": {},
+      "oas3_0": {},
+      "oas3_1": {},
     },
   },
   "doNotResolveExamples": false,
-  "extendPaths": Array [],
-  "ignore": Object {
-    "https://some-path.yaml": Object {
+  "extendPaths": [],
+  "ignore": {
+    "https://some-path.yaml": {
       "no-unused-components": Set {
         "#/components/schemas/Foo",
       },
     },
-    "some-path/openapi.yaml": Object {
+    "some-path/openapi.yaml": {
       "no-unused-components": Set {
         "#/components/schemas/Foo",
       },
     },
   },
-  "pluginPaths": Array [],
-  "plugins": Array [],
-  "preprocessors": Object {
-    "async2": Object {
-      "oas2": Object {},
-      "oas3_0": Object {},
-      "oas3_1": Object {},
-    },
-    "oas2": Object {
-      "oas2": Object {},
-      "oas3_0": Object {},
-      "oas3_1": Object {},
-    },
-    "oas3_0": Object {
-      "oas2": Object {},
-      "oas3_0": Object {},
-      "oas3_1": Object {},
-    },
-    "oas3_1": Object {
-      "oas2": Object {},
-      "oas3_0": Object {},
-      "oas3_1": Object {},
+  "pluginPaths": [],
+  "plugins": [],
+  "preprocessors": {
+    "async2": {
+      "oas2": {},
+      "oas3_0": {},
+      "oas3_1": {},
+    },
+    "oas2": {
+      "oas2": {},
+      "oas3_0": {},
+      "oas3_1": {},
+    },
+    "oas3_0": {
+      "oas2": {},
+      "oas3_0": {},
+      "oas3_1": {},
+    },
+    "oas3_1": {
+      "oas2": {},
+      "oas3_0": {},
+      "oas3_1": {},
     },
   },
-  "rawConfig": Object {
+  "rawConfig": {
     "_usedRules": Set {},
     "_usedVersions": Set {},
     "configFile": "redocly.yaml",
-    "decorators": Object {
-      "oas2": Object {},
-      "oas3_0": Object {},
-      "oas3_1": Object {},
+    "decorators": {
+      "oas2": {},
+      "oas3_0": {},
+      "oas3_1": {},
     },
     "doNotResolveExamples": false,
-    "ignore": Object {},
-    "plugins": Array [],
-    "preprocessors": Object {
-      "oas2": Object {},
-      "oas3_0": Object {},
-      "oas3_1": Object {},
+    "ignore": {},
+    "plugins": [],
+    "preprocessors": {
+      "oas2": {},
+      "oas3_0": {},
+      "oas3_1": {},
     },
-    "rawConfig": Object {
-      "plugins": Array [],
-      "rules": Object {
+    "rawConfig": {
+      "plugins": [],
+      "rules": {
         "no-empty-servers": "error",
         "operation-summary": "error",
       },
     },
     "recommendedFallback": false,
-    "rules": Object {
-      "oas2": Object {
+    "rules": {
+      "oas2": {
         "no-empty-servers": "error",
         "operation-summary": "error",
       },
-      "oas3_0": Object {
+      "oas3_0": {
         "no-empty-servers": "error",
         "operation-summary": "error",
       },
-      "oas3_1": Object {
+      "oas3_1": {
         "no-empty-servers": "error",
         "operation-summary": "error",
       },
     },
   },
   "recommendedFallback": false,
-  "rules": Object {
-    "async2": Object {
-      "oas2": Object {
+  "rules": {
+    "async2": {
+      "oas2": {
         "no-empty-servers": "error",
         "operation-summary": "error",
       },
-      "oas3_0": Object {
+      "oas3_0": {
         "no-empty-servers": "error",
         "operation-summary": "error",
       },
-      "oas3_1": Object {
+      "oas3_1": {
         "no-empty-servers": "error",
         "operation-summary": "error",
       },
     },
-    "oas2": Object {
-      "oas2": Object {
+    "oas2": {
+      "oas2": {
         "no-empty-servers": "error",
         "operation-summary": "error",
       },
-      "oas3_0": Object {
+      "oas3_0": {
         "no-empty-servers": "error",
         "operation-summary": "error",
       },
-      "oas3_1": Object {
+      "oas3_1": {
         "no-empty-servers": "error",
         "operation-summary": "error",
       },
     },
-    "oas3_0": Object {
-      "oas2": Object {
+    "oas3_0": {
+      "oas2": {
         "no-empty-servers": "error",
         "operation-summary": "error",
       },
-      "oas3_0": Object {
+      "oas3_0": {
         "no-empty-servers": "error",
         "operation-summary": "error",
       },
-      "oas3_1": Object {
+      "oas3_1": {
         "no-empty-servers": "error",
         "operation-summary": "error",
       },
     },
-    "oas3_1": Object {
-      "oas2": Object {
+    "oas3_1": {
+      "oas2": {
         "no-empty-servers": "error",
         "operation-summary": "error",
       },
-      "oas3_0": Object {
+      "oas3_0": {
         "no-empty-servers": "error",
         "operation-summary": "error",
       },
-      "oas3_1": Object {
+      "oas3_1": {
         "no-empty-servers": "error",
         "operation-summary": "error",
       },

package/src/config/__tests__/config-resolvers.test.ts

@@ -1,9 +1,11 @@
 import { colorize } from '../../logger';
 import { Asserts, asserts } from '../../rules/common/assertions/asserts';
 import { resolveStyleguideConfig, resolveApis, resolveConfig } from '../config-resolvers';
+import recommended from '../recommended';
+
 const path = require('path');
 
-import type { StyleguideRawConfig, RawConfig } from '../types';
+import type { StyleguideRawConfig, RawConfig, PluginStyleguideConfig } from '../types';
 
 const configPath = path.join(__dirname, 'fixtures/resolve-config/redocly.yaml');
 const baseStyleguideConfig: StyleguideRawConfig = {
@@ -220,6 +222,33 @@ describe('resolveStyleguideConfig', () => {
     ]);
     expect(styleguide.pluginPaths!.map(removeAbsolutePath)).toEqual([]);
   });
+  it('should resolve `recommended-strict` ruleset correctly', async () => {
+    const expectedStrict = JSON.parse(
+      JSON.stringify(recommended)
+    ) as PluginStyleguideConfig<'built-in'>;
+    for (const section of Object.values(expectedStrict)) {
+      for (let ruleName in section as any) {
+        // @ts-ignore
+        if (section[ruleName] === 'warn') {
+          // @ts-ignore
+          section[ruleName] = 'error';
+        }
+        // @ts-ignore
+        if (section[ruleName]?.severity === 'warn') {
+          // @ts-ignore
+          section[ruleName].severity = 'error';
+        }
+      }
+    }
+    const recommendedStrictPreset = JSON.parse(
+      JSON.stringify(
+        await resolveStyleguideConfig({
+          styleguideConfig: { extends: ['recommended-strict'] },
+        })
+      )
+    );
+    expect(recommendedStrictPreset).toMatchObject(expectedStrict);
+  });
 });
 
 describe('resolveApis', () => {

package/src/config/__tests__/config.test.ts

@@ -69,95 +69,95 @@ describe('getMergedConfig', () => {
   it('should get styleguide defined in "apis" section', () => {
     expect(getMergedConfig(testConfig, 'test@v1')).toMatchInlineSnapshot(`
       Config {
-        "apis": Object {
-          "test@v1": Object {
+        "apis": {
+          "test@v1": {
             "root": "resources/pets.yaml",
-            "styleguide": Object {
-              "rules": Object {
+            "styleguide": {
+              "rules": {
                 "operation-summary": "warn",
               },
             },
           },
         },
         "configFile": "redocly.yaml",
-        "files": Array [],
+        "files": [],
         "organization": "redocly-test",
-        "rawConfig": Object {
-          "apis": Object {
-            "test@v1": Object {
+        "rawConfig": {
+          "apis": {
+            "test@v1": {
               "root": "resources/pets.yaml",
-              "styleguide": Object {
-                "rules": Object {
+              "styleguide": {
+                "rules": {
                   "operation-summary": "warn",
                 },
               },
             },
           },
-          "files": Array [],
+          "files": [],
           "organization": "redocly-test",
-          "styleguide": Object {
-            "extendPaths": Array [],
-            "pluginPaths": Array [],
-            "rules": Object {
+          "styleguide": {
+            "extendPaths": [],
+            "pluginPaths": [],
+            "rules": {
               "operation-summary": "warn",
             },
           },
           "telemetry": "on",
-          "theme": Object {},
+          "theme": {},
         },
         "region": undefined,
-        "resolve": Object {
-          "http": Object {
+        "resolve": {
+          "http": {
             "customFetch": undefined,
-            "headers": Array [],
+            "headers": [],
           },
         },
         "styleguide": StyleguideConfig {
           "_usedRules": Set {},
           "_usedVersions": Set {},
           "configFile": "redocly.yaml",
-          "decorators": Object {
-            "async2": Object {},
-            "oas2": Object {},
-            "oas3_0": Object {},
-            "oas3_1": Object {},
+          "decorators": {
+            "async2": {},
+            "oas2": {},
+            "oas3_0": {},
+            "oas3_1": {},
           },
           "doNotResolveExamples": false,
-          "extendPaths": Array [],
-          "ignore": Object {},
-          "pluginPaths": Array [],
-          "plugins": Array [],
-          "preprocessors": Object {
-            "async2": Object {},
-            "oas2": Object {},
-            "oas3_0": Object {},
-            "oas3_1": Object {},
+          "extendPaths": [],
+          "ignore": {},
+          "pluginPaths": [],
+          "plugins": [],
+          "preprocessors": {
+            "async2": {},
+            "oas2": {},
+            "oas3_0": {},
+            "oas3_1": {},
           },
-          "rawConfig": Object {
-            "extendPaths": Array [],
-            "pluginPaths": Array [],
-            "rules": Object {
+          "rawConfig": {
+            "extendPaths": [],
+            "pluginPaths": [],
+            "rules": {
               "operation-summary": "warn",
             },
           },
           "recommendedFallback": false,
-          "rules": Object {
-            "async2": Object {
+          "rules": {
+            "async2": {
               "operation-summary": "warn",
             },
-            "oas2": Object {
+            "oas2": {
               "operation-summary": "warn",
             },
-            "oas3_0": Object {
+            "oas3_0": {
               "operation-summary": "warn",
             },
-            "oas3_1": Object {
+            "oas3_1": {
               "operation-summary": "warn",
             },
           },
         },
         "telemetry": "on",
-        "theme": Object {},
+        "theme": {},
       }
     `);
   });
@@ -172,103 +172,103 @@ describe('getMergedConfig', () => {
   it('should handle wrong alias - return the same styleguide, empty features', () => {
     expect(getMergedConfig(testConfig, 'wrong-alias')).toMatchInlineSnapshot(`
       Config {
-        "apis": Object {
-          "test@v1": Object {
+        "apis": {
+          "test@v1": {
             "root": "resources/pets.yaml",
-            "styleguide": Object {
-              "rules": Object {
+            "styleguide": {
+              "rules": {
                 "operation-summary": "warn",
               },
             },
           },
         },
         "configFile": "redocly.yaml",
-        "files": Array [],
+        "files": [],
         "organization": "redocly-test",
-        "rawConfig": Object {
-          "apis": Object {
-            "test@v1": Object {
+        "rawConfig": {
+          "apis": {
+            "test@v1": {
               "root": "resources/pets.yaml",
-              "styleguide": Object {
-                "rules": Object {
+              "styleguide": {
+                "rules": {
                   "operation-summary": "warn",
                 },
               },
             },
           },
-          "files": Array [],
+          "files": [],
           "organization": "redocly-test",
-          "styleguide": Object {
-            "extendPaths": Array [],
-            "pluginPaths": Array [],
-            "plugins": Array [],
-            "rules": Object {
+          "styleguide": {
+            "extendPaths": [],
+            "pluginPaths": [],
+            "plugins": [],
+            "rules": {
               "no-empty-servers": "error",
               "operation-summary": "error",
             },
           },
           "telemetry": "on",
-          "theme": Object {},
+          "theme": {},
         },
         "region": undefined,
-        "resolve": Object {
-          "http": Object {
+        "resolve": {
+          "http": {
             "customFetch": undefined,
-            "headers": Array [],
+            "headers": [],
           },
         },
         "styleguide": StyleguideConfig {
           "_usedRules": Set {},
           "_usedVersions": Set {},
           "configFile": "redocly.yaml",
-          "decorators": Object {
-            "async2": Object {},
-            "oas2": Object {},
-            "oas3_0": Object {},
-            "oas3_1": Object {},
+          "decorators": {
+            "async2": {},
+            "oas2": {},
+            "oas3_0": {},
+            "oas3_1": {},
           },
           "doNotResolveExamples": false,
-          "extendPaths": Array [],
-          "ignore": Object {},
-          "pluginPaths": Array [],
-          "plugins": Array [],
-          "preprocessors": Object {
-            "async2": Object {},
-            "oas2": Object {},
-            "oas3_0": Object {},
-            "oas3_1": Object {},
+          "extendPaths": [],
+          "ignore": {},
+          "pluginPaths": [],
+          "plugins": [],
+          "preprocessors": {
+            "async2": {},
+            "oas2": {},
+            "oas3_0": {},
+            "oas3_1": {},
           },
-          "rawConfig": Object {
-            "extendPaths": Array [],
-            "pluginPaths": Array [],
-            "plugins": Array [],
-            "rules": Object {
+          "rawConfig": {
+            "extendPaths": [],
+            "pluginPaths": [],
+            "plugins": [],
+            "rules": {
               "no-empty-servers": "error",
               "operation-summary": "error",
             },
           },
           "recommendedFallback": false,
-          "rules": Object {
-            "async2": Object {
+          "rules": {
+            "async2": {
               "no-empty-servers": "error",
               "operation-summary": "error",
             },
-            "oas2": Object {
+            "oas2": {
               "no-empty-servers": "error",
               "operation-summary": "error",
             },
-            "oas3_0": Object {
+            "oas3_0": {
               "no-empty-servers": "error",
               "operation-summary": "error",
             },
-            "oas3_1": Object {
+            "oas3_1": {
               "no-empty-servers": "error",
               "operation-summary": "error",
             },
           },
         },
         "telemetry": "on",
-        "theme": Object {},
+        "theme": {},
       }
     `);
   });

package/src/config/__tests__/load.test.ts

@@ -172,17 +172,21 @@ function verifyExtendedConfig(
   const recommendedRules = defaultPlugin?.configs?.[extendsRuleSet];
   expect(recommendedRules).toBeDefined();
 
-  verifyOasRules(config.styleguide.rules.oas2, overridesRules, recommendedRules?.rules || {});
   verifyOasRules(
-    config.styleguide.rules.oas3_0,
+    config.styleguide.rules.oas2,
     overridesRules,
-    Object.assign({}, recommendedRules?.rules, recommendedRules?.oas3_0Rules)
-  );
-  verifyOasRules(
-    config.styleguide.rules.oas3_1,
-    overridesRules,
-    Object.assign({}, recommendedRules?.rules, recommendedRules?.oas3_1Rules)
+    { ...recommendedRules?.rules, ...recommendedRules?.oas2Rules } || {}
   );
+
+  verifyOasRules(config.styleguide.rules.oas3_0, overridesRules, {
+    ...recommendedRules?.rules,
+    ...recommendedRules?.oas3_0Rules,
+  });
+
+  verifyOasRules(config.styleguide.rules.oas3_1, overridesRules, {
+    ...recommendedRules?.rules,
+    ...recommendedRules?.oas3_1Rules,
+  });
 }
 
 function verifyOasRules(

package/src/config/__tests__/utils.test.ts

@@ -78,25 +78,25 @@ describe('transformConfig', () => {
       makeTestRawConfig('styleguide', 'styleguide')
     );
     expect(transformedRawConfig).toMatchInlineSnapshot(`
-      Object {
-        "apis": Object {
-          "test@v1": Object {
+      {
+        "apis": {
+          "test@v1": {
             "root": "root.yaml",
-            "styleguide": Object {
-              "rules": Object {
+            "styleguide": {
+              "rules": {
                 "operation-2xx-response": "error",
               },
             },
           },
         },
-        "styleguide": Object {
-          "rules": Object {
+        "styleguide": {
+          "rules": {
             "operation-4xx-response": "warn",
           },
         },
-        "theme": Object {
-          "mockServer": Object {},
-          "openapi": Object {},
+        "theme": {
+          "mockServer": {},
+          "openapi": {},
         },
       }
     `);
@@ -111,20 +111,20 @@ describe('transformConfig', () => {
     testRawConfig.apis = undefined;
     testRawConfig.apiDefinitions = { legacyApiDefinition: 'file.yaml' };
     expect(utils.transformConfig(testRawConfig)).toMatchInlineSnapshot(`
-      Object {
-        "apis": Object {
-          "legacyApiDefinition": Object {
+      {
+        "apis": {
+          "legacyApiDefinition": {
             "root": "file.yaml",
           },
         },
-        "styleguide": Object {
-          "rules": Object {
+        "styleguide": {
+          "rules": {
             "operation-4xx-response": "warn",
           },
         },
-        "theme": Object {
-          "mockServer": Object {},
-          "openapi": Object {},
+        "theme": {
+          "mockServer": {},
+          "openapi": {},
         },
       }
     `);