@redocly/openapi-core 1.0.0-beta.105 → 1.0.0-beta.108

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

@@ -1,4 +1,5 @@
-import { Config } from '../config';
+import { OasVersion } from '../../oas-types';
+import { Config, StyleguideConfig } from '../config';
 import { getMergedConfig } from '../utils';
 
 const testConfig: Config = {
@@ -6,11 +7,11 @@ const testConfig: Config = {
     apis: {
       'test@v1': {
         root: 'resources/pets.yaml',
-        lint: { rules: { 'operation-summary': 'warn' } },
+        styleguide: { rules: { 'operation-summary': 'warn' } },
       },
     },
     organization: 'redocly-test',
-    lint: {
+    styleguide: {
       rules: { 'operation-summary': 'error', 'no-empty-servers': 'error' },
       plugins: [],
     },
@@ -19,11 +20,11 @@ const testConfig: Config = {
   apis: {
     'test@v1': {
       root: 'resources/pets.yaml',
-      lint: { rules: { 'operation-summary': 'warn' } },
+      styleguide: { rules: { 'operation-summary': 'warn' } },
     },
   },
-  // @ts-ignore
-  lint: {
+
+  styleguide: {
     rawConfig: {
       rules: { 'operation-summary': 'error', 'no-empty-servers': 'error' },
       plugins: [],
@@ -42,7 +43,7 @@ const testConfig: Config = {
     },
     preprocessors: { oas2: {}, oas3_0: {}, oas3_1: {} },
     decorators: { oas2: {}, oas3_0: {}, oas3_1: {} },
-  },
+  } as unknown as StyleguideConfig,
   'features.openapi': {},
   'features.mockServer': {},
   resolve: { http: { headers: [] } },
@@ -50,23 +51,53 @@ const testConfig: Config = {
 };
 
 describe('getMergedConfig', () => {
-  it('should get lint defined in "apis" section', () => {
+  it('should get styleguide defined in "apis" section', () => {
     expect(getMergedConfig(testConfig, 'test@v1')).toMatchInlineSnapshot(`
       Config {
         "apis": Object {
           "test@v1": Object {
-            "lint": Object {
+            "root": "resources/pets.yaml",
+            "styleguide": Object {
               "rules": Object {
                 "operation-summary": "warn",
               },
             },
-            "root": "resources/pets.yaml",
           },
         },
         "configFile": "redocly.yaml",
         "features.mockServer": Object {},
         "features.openapi": Object {},
-        "lint": LintConfig {
+        "organization": "redocly-test",
+        "rawConfig": Object {
+          "apis": Object {
+            "test@v1": Object {
+              "root": "resources/pets.yaml",
+              "styleguide": Object {
+                "rules": Object {
+                  "operation-summary": "warn",
+                },
+              },
+            },
+          },
+          "features.mockServer": Object {},
+          "features.openapi": Object {},
+          "organization": "redocly-test",
+          "styleguide": Object {
+            "extendPaths": Array [],
+            "pluginPaths": Array [],
+            "rules": Object {
+              "operation-summary": "warn",
+            },
+          },
+        },
+        "region": undefined,
+        "resolve": Object {
+          "http": Object {
+            "customFetch": undefined,
+            "headers": Array [],
+          },
+        },
+        "styleguide": StyleguideConfig {
           "_usedRules": Set {},
           "_usedVersions": Set {},
           "configFile": "redocly.yaml",
@@ -105,28 +136,57 @@ describe('getMergedConfig', () => {
             },
           },
         },
+      }
+    `);
+  });
+  it('should take into account a config file', () => {
+    const result = getMergedConfig(testConfig, 'test@v1');
+    expect(result.configFile).toEqual('redocly.yaml');
+    expect(result.styleguide.configFile).toEqual('redocly.yaml');
+  });
+  it('should return the same config when there is no alias provided', () => {
+    expect(getMergedConfig(testConfig)).toEqual(testConfig);
+  });
+  it('should handle wrong alias - return the same styleguide, empty features', () => {
+    expect(getMergedConfig(testConfig, 'wrong-alias')).toMatchInlineSnapshot(`
+      Config {
+        "apis": Object {
+          "test@v1": Object {
+            "root": "resources/pets.yaml",
+            "styleguide": Object {
+              "rules": Object {
+                "operation-summary": "warn",
+              },
+            },
+          },
+        },
+        "configFile": "redocly.yaml",
+        "features.mockServer": Object {},
+        "features.openapi": Object {},
         "organization": "redocly-test",
         "rawConfig": Object {
           "apis": Object {
             "test@v1": Object {
-              "lint": Object {
+              "root": "resources/pets.yaml",
+              "styleguide": Object {
                 "rules": Object {
                   "operation-summary": "warn",
                 },
               },
-              "root": "resources/pets.yaml",
             },
           },
           "features.mockServer": Object {},
           "features.openapi": Object {},
-          "lint": Object {
+          "organization": "redocly-test",
+          "styleguide": Object {
             "extendPaths": Array [],
             "pluginPaths": Array [],
+            "plugins": Array [],
             "rules": Object {
-              "operation-summary": "warn",
+              "no-empty-servers": "error",
+              "operation-summary": "error",
             },
           },
-          "organization": "redocly-test",
         },
         "region": undefined,
         "resolve": Object {
@@ -135,34 +195,7 @@ describe('getMergedConfig', () => {
             "headers": Array [],
           },
         },
-      }
-    `);
-  });
-  it('should take into account a config file', () => {
-    const result = getMergedConfig(testConfig, 'test@v1');
-    expect(result.configFile).toEqual('redocly.yaml');
-    expect(result.lint.configFile).toEqual('redocly.yaml');
-  });
-  it('should return the same config when there is no alias provided', () => {
-    expect(getMergedConfig(testConfig)).toEqual(testConfig);
-  });
-  it('should handle wrong alias - return the same lint, empty features', () => {
-    expect(getMergedConfig(testConfig, 'wrong-alias')).toMatchInlineSnapshot(`
-      Config {
-        "apis": Object {
-          "test@v1": Object {
-            "lint": Object {
-              "rules": Object {
-                "operation-summary": "warn",
-              },
-            },
-            "root": "resources/pets.yaml",
-          },
-        },
-        "configFile": "redocly.yaml",
-        "features.mockServer": Object {},
-        "features.openapi": Object {},
-        "lint": LintConfig {
+        "styleguide": StyleguideConfig {
           "_usedRules": Set {},
           "_usedVersions": Set {},
           "configFile": "redocly.yaml",
@@ -206,39 +239,41 @@ describe('getMergedConfig', () => {
             },
           },
         },
-        "organization": "redocly-test",
-        "rawConfig": Object {
-          "apis": Object {
-            "test@v1": Object {
-              "lint": Object {
-                "rules": Object {
-                  "operation-summary": "warn",
-                },
-              },
-              "root": "resources/pets.yaml",
-            },
-          },
-          "features.mockServer": Object {},
-          "features.openapi": Object {},
-          "lint": Object {
-            "extendPaths": Array [],
-            "pluginPaths": Array [],
-            "plugins": Array [],
-            "rules": Object {
-              "no-empty-servers": "error",
-              "operation-summary": "error",
-            },
-          },
-          "organization": "redocly-test",
-        },
-        "region": undefined,
-        "resolve": Object {
-          "http": Object {
-            "customFetch": undefined,
-            "headers": Array [],
-          },
-        },
       }
     `);
   });
 });
+
+describe('StyleguideConfig.extendTypes', () => {
+  let oas3 = jest.fn();
+  let oas2 = jest.fn();
+  let testRawConfigStyleguide = {
+    plugins: [
+      {
+        id: 'test-types-plugin',
+        typeExtension: {
+          oas3,
+          oas2,
+        },
+      },
+    ],
+  };
+  it('should call only oas3 types extension', () => {
+    const styleguideConfig = new StyleguideConfig(testRawConfigStyleguide);
+    styleguideConfig.extendTypes({}, OasVersion.Version3_0);
+    expect(oas3).toHaveBeenCalledTimes(1);
+    expect(oas2).toHaveBeenCalledTimes(0);
+  });
+  it('should call only oas2 types extension', () => {
+    const styleguideConfig = new StyleguideConfig(testRawConfigStyleguide);
+    styleguideConfig.extendTypes({}, OasVersion.Version2);
+    expect(oas3).toHaveBeenCalledTimes(0);
+    expect(oas2).toHaveBeenCalledTimes(1);
+  });
+  it('should throw error if for oas version different from 2 and 3', () => {
+    const styleguideConfig = new StyleguideConfig(testRawConfigStyleguide);
+    expect(() => styleguideConfig.extendTypes({}, 'something else' as OasVersion)).toThrowError(
+      'Not implemented'
+    );
+  });
+});

package/src/config/__tests__/fixtures/resolve-config/api/plugin.js

@@ -21,7 +21,10 @@ const rules = {
       return {
         SecurityScheme(scheme, { location, report }) {
           if (scheme.type === 'openIdConnect') {
-            if (scheme.openIdConnectUrl && !scheme.openIdConnectUrl.endsWith('/.well-known/openid-configuration')) {
+            if (
+              scheme.openIdConnectUrl &&
+              !scheme.openIdConnectUrl.endsWith('/.well-known/openid-configuration')
+            ) {
               report({
                 message:
                   'openIdConnectUrl must be a URL that ends with /.well-known/openid-configuration',
@@ -57,7 +60,6 @@ const configs = {
   },
 };
 
-
 module.exports = {
   id,
   preprocessors,

package/src/config/__tests__/fixtures/resolve-config/plugin.js

@@ -21,7 +21,10 @@ const rules = {
       return {
         SecurityScheme(scheme, { location, report }) {
           if (scheme.type === 'openIdConnect') {
-            if (scheme.openIdConnectUrl && !scheme.openIdConnectUrl.endsWith('/.well-known/openid-configuration')) {
+            if (
+              scheme.openIdConnectUrl &&
+              !scheme.openIdConnectUrl.endsWith('/.well-known/openid-configuration')
+            ) {
               report({
                 message:
                   'openIdConnectUrl must be a URL that ends with /.well-known/openid-configuration',

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

@@ -1,5 +1,7 @@
-import { loadConfig, findConfig, getConfig } from '../load';
+import { loadConfig, findConfig, getConfig, createConfig } from '../load';
 import { RedoclyClient } from '../../redocly';
+import { RuleConfig, RawConfig } from './../types';
+import { Config } from '../config';
 
 const fs = require('fs');
 const path = require('path');
@@ -87,3 +89,79 @@ describe('getConfig', () => {
     expect(getConfig()).toEqual(Promise.resolve({}));
   });
 });
+
+describe('createConfig', () => {
+  it('should create config from string', async () => {
+    const config = await createConfig(`
+      styleguide:
+        extends:
+          - recommended
+        rules:
+          info-license: off
+    `);
+
+    verifyExtendedConfig(config, {
+      extendsRuleSet: 'recommended',
+      overridesRules: { 'info-license': 'off' },
+    });
+  });
+
+  it('should create config from object', async () => {
+    const rawConfig: RawConfig = {
+      styleguide: {
+        extends: ['minimal'],
+        rules: {
+          'info-license': 'off',
+          'tag-description': 'off',
+          'operation-2xx-response': 'off',
+        },
+      },
+    };
+    const config = await createConfig(rawConfig);
+
+    verifyExtendedConfig(config, {
+      extendsRuleSet: 'minimal',
+      overridesRules: rawConfig.styleguide!.rules as Record<string, RuleConfig>,
+    });
+  });
+});
+
+function verifyExtendedConfig(
+  config: Config,
+  {
+    extendsRuleSet,
+    overridesRules,
+  }: { extendsRuleSet: string; overridesRules: Record<string, RuleConfig> }
+) {
+  const defaultPlugin = config.styleguide.plugins.find((plugin) => plugin.id === '');
+  expect(defaultPlugin).toBeDefined();
+
+  const recommendedRules = defaultPlugin?.configs?.[extendsRuleSet];
+  expect(recommendedRules).toBeDefined();
+
+  verifyOasRules(config.styleguide.rules.oas2, overridesRules, recommendedRules?.rules || {});
+  verifyOasRules(
+    config.styleguide.rules.oas3_0,
+    overridesRules,
+    Object.assign({}, recommendedRules?.rules, recommendedRules?.oas3_0Rules)
+  );
+  verifyOasRules(
+    config.styleguide.rules.oas3_1,
+    overridesRules,
+    Object.assign({}, recommendedRules?.rules, recommendedRules?.oas3_1Rules)
+  );
+}
+
+function verifyOasRules(
+  finalRuleset: Record<string, RuleConfig>,
+  overridesRules: Record<string, RuleConfig>,
+  defaultRuleset: Record<string, RuleConfig>
+) {
+  Object.entries(finalRuleset).forEach(([ruleName, ruleValue]) => {
+    if (ruleName in overridesRules) {
+      expect(ruleValue).toBe(overridesRules[ruleName]);
+    } else {
+      expect(ruleValue).toBe(defaultRuleset[ruleName]);
+    }
+  });
+}

package/src/config/__tests__/resolve-plugins.test.ts

@@ -6,21 +6,21 @@ describe('resolving a plugin', () => {
 
   it('should prefix rule names with the plugin id', async () => {
     const config = await loadConfig(configPath);
-    const plugin = config.lint.plugins[0];
+    const plugin = config.styleguide.plugins[0];
 
     expect(plugin.rules?.oas3).toHaveProperty('test-plugin/openid-connect-url-well-known');
   });
 
   it('should prefix preprocessor names with the plugin id', async () => {
     const config = await loadConfig(configPath);
-    const plugin = config.lint.plugins[0];
+    const plugin = config.styleguide.plugins[0];
 
     expect(plugin.preprocessors?.oas2).toHaveProperty('test-plugin/description-preprocessor');
   });
 
   it('should prefix decorator names with the plugin id', async () => {
     const config = await loadConfig(configPath);
-    const plugin = config.lint.plugins[0];
+    const plugin = config.styleguide.plugins[0];
 
     expect(plugin.decorators?.oas3).toHaveProperty('test-plugin/inject-x-stats');
   });

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

@@ -0,0 +1,83 @@
+import { DeprecatedInRawConfig, RawConfig } from '../types';
+import * as utils from '../utils';
+
+const makeTestRawConfig = (
+  apiStyleguideName: string,
+  rootStyleguideName: string
+): RawConfig & DeprecatedInRawConfig => ({
+  apis: {
+    'test@v1': {
+      root: 'root.yaml',
+      [apiStyleguideName]: {
+        rules: {
+          'operation-2xx-response': 'error',
+        },
+      },
+    },
+  },
+  [rootStyleguideName]: {
+    rules: {
+      'operation-4xx-response': 'warn',
+    },
+  },
+});
+
+describe('transformConfig', () => {
+  it('should work for new syntax', () => {
+    const transformedRawConfig: RawConfig = utils.transformConfig(
+      makeTestRawConfig('styleguide', 'styleguide')
+    );
+    expect(transformedRawConfig).toMatchInlineSnapshot(`
+      Object {
+        "apis": Object {
+          "test@v1": Object {
+            "root": "root.yaml",
+            "styleguide": Object {
+              "rules": Object {
+                "operation-2xx-response": "error",
+              },
+            },
+          },
+        },
+        "features.openapi": undefined,
+        "styleguide": Object {
+          "rules": Object {
+            "operation-4xx-response": "warn",
+          },
+        },
+      }
+    `);
+  });
+  it('should be equal for both `lint` and `styleguide` names', () => {
+    expect(utils.transformConfig(makeTestRawConfig('lint', 'styleguide'))).toEqual(
+      utils.transformConfig(makeTestRawConfig('styleguide', 'lint'))
+    );
+  });
+  it('should work for `apiDefinitions`', () => {
+    const testRawConfig = makeTestRawConfig('styleguide', 'lint');
+    testRawConfig.apis = undefined;
+    testRawConfig.apiDefinitions = { legacyApiDefinition: 'file.yaml' };
+    expect(utils.transformConfig(testRawConfig)).toMatchInlineSnapshot(`
+      Object {
+        "apis": Object {
+          "legacyApiDefinition": Object {
+            "root": "file.yaml",
+          },
+        },
+        "features.openapi": undefined,
+        "styleguide": Object {
+          "rules": Object {
+            "operation-4xx-response": "warn",
+          },
+        },
+      }
+    `);
+  });
+  it('should throw an error if both new and old syntax used together', () => {
+    const testRawConfig = makeTestRawConfig('styleguide', 'lint');
+    testRawConfig.apiDefinitions = { legacyApiDefinition: 'file.yaml' };
+    expect(() => utils.transformConfig(testRawConfig)).toThrowError(
+      `Do not use 'apiDefinitions' field. Use 'apis' instead.`
+    );
+  });
+});

package/src/config/all.ts

@@ -1,5 +1,4 @@
-import type { PluginLintConfig } from "./types";
-
+import type { PluginStyleguideConfig } from './types';
 
 export default {
   rules: {
@@ -20,7 +19,7 @@ export default {
     'operation-description': 'error',
     'operation-2xx-response': 'error',
     'operation-4xx-response': 'error',
-    'assertions': 'error',
+    assertions: 'error',
     'operation-operationId': 'error',
     'operation-summary': 'error',
     'operation-operationId-unique': 'error',
@@ -52,7 +51,7 @@ export default {
     'no-example-value-and-externalValue': 'error',
     'no-unused-components': 'error',
     'no-undefined-server-variable': 'error',
-    'no-servers-empty-enum': 'error',
+    'no-server-variables-empty-enum': 'error',
   },
   oas3_1Rules: {
     'no-server-example.com': 'error',
@@ -61,6 +60,6 @@ export default {
     'no-example-value-and-externalValue': 'error',
     'no-unused-components': 'error',
     'no-undefined-server-variable': 'error',
-    'no-servers-empty-enum': 'error',
+    'no-server-variables-empty-enum': 'error',
   },
-} as PluginLintConfig;
+} as PluginStyleguideConfig;

package/src/config/builtIn.ts

@@ -8,15 +8,15 @@ import { preprocessors as oas2Preprocessors } from '../rules/oas2';
 import { decorators as oas3Decorators } from '../decorators/oas3';
 import { decorators as oas2Decorators } from '../decorators/oas2';
 
-import type { CustomRulesConfig, LintRawConfig, Plugin } from './types';
+import type { CustomRulesConfig, StyleguideRawConfig, Plugin } from './types';
 
-export const builtInConfigs: Record<string, LintRawConfig> = {
+export const builtInConfigs: Record<string, StyleguideRawConfig> = {
   recommended,
   minimal,
   all,
   'redocly-registry': {
-    decorators: { 'registry-dependencies': 'on' }
-  }
+    decorators: { 'registry-dependencies': 'on' },
+  },
 };
 
 export const defaultPlugin: Plugin = {
@@ -34,4 +34,4 @@ export const defaultPlugin: Plugin = {
     oas2: oas2Decorators,
   },
   configs: builtInConfigs,
-}
+};