@redocly/openapi-core 1.0.0-beta.100

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

@@ -0,0 +1,56 @@
+const id = 'test-plugin';
+
+/** @type {import('../../config').PreprocessorsConfig} */
+const preprocessors = {
+  oas2: {
+    'description-preprocessor': () => {
+      return {
+        Info(info) {
+          const title = info.title || 'API title';
+          info.description = `# ${title}\n\n${info.description || ''}`;
+        },
+      };
+    },
+  },
+};
+
+/** @type {import('../../config').CustomRulesConfig} */
+const rules = {
+  oas3: {
+    'openid-connect-url-well-known': () => {
+      return {
+        SecurityScheme(scheme, { location, report }) {
+          if (scheme.type === 'openIdConnect') {
+            if (!scheme.openIdConnectUrl.endsWith('/.well-known/openid-configuration')) {
+              report({
+                message:
+                  'openIdConnectUrl must be a URL that ends with /.well-known/openid-configuration',
+                location: location.child('openIdConnectUrl'),
+              });
+            }
+          }
+        },
+      };
+    },
+  },
+};
+
+/** @type {import('../../config').DecoratorsConfig} */
+const decorators = {
+  oas3: {
+    'inject-x-stats': () => {
+      return {
+        Info(info) {
+          info['x-stats'] = { test: 1 };
+        },
+      };
+    },
+  },
+};
+
+module.exports = {
+  id,
+  preprocessors,
+  rules,
+  decorators,
+};

package/src/config/__tests__/fixtures/resolve-config/api/nested-config.yaml

@@ -0,0 +1,12 @@
+lint:
+  plugins:
+    - plugin.js
+  rules:
+    operation-2xx-response: error
+    assert/path-item-get-defined:
+      subject: PathItem
+      property: get
+      message: Every path item must have a GET operation.
+      defined: true
+  extends:
+    - test-plugin-nested/all

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

@@ -0,0 +1,67 @@
+const id = 'test-plugin-nested';
+
+/** @type {import('../../config').PreprocessorsConfig} */
+const preprocessors = {
+  oas2: {
+    'description-preprocessor': () => {
+      return {
+        Info(info) {
+          const title = info.title || 'API title';
+          info.description = `# ${title}\n\n${info.description || ''}`;
+        },
+      };
+    },
+  },
+};
+
+/** @type {import('../../config').CustomRulesConfig} */
+const rules = {
+  oas3: {
+    'openid-connect-url-well-known': () => {
+      return {
+        SecurityScheme(scheme, { location, report }) {
+          if (scheme.type === 'openIdConnect') {
+            if (scheme.openIdConnectUrl && !scheme.openIdConnectUrl.endsWith('/.well-known/openid-configuration')) {
+              report({
+                message:
+                  'openIdConnectUrl must be a URL that ends with /.well-known/openid-configuration',
+                location: location.child('openIdConnectUrl'),
+              });
+            }
+          }
+        },
+      };
+    },
+  },
+};
+
+/** @type {import('../../config').DecoratorsConfig} */
+const decorators = {
+  oas3: {
+    'inject-x-stats': () => {
+      return {
+        Info(info) {
+          info['x-stats'] = { test: 1 };
+        },
+      };
+    },
+  },
+};
+
+const configs = {
+  all: {
+    rules: {
+      'local/operation-id-not-test': 'error',
+      'boolean-parameter-prefixes': 'error',
+    },
+  },
+};
+
+
+module.exports = {
+  id,
+  preprocessors,
+  rules,
+  decorators,
+  configs,
+};

package/src/config/__tests__/fixtures/resolve-config/local-config-with-circular.yaml

@@ -0,0 +1,8 @@
+lint:
+  extends:
+    - local-config-with-circular.yaml
+  rules:
+    no-invalid-media-type-examples: error
+    operation-description: error
+    path-http-verbs-order: error
+    operation-2xx-response: off

package/src/config/__tests__/fixtures/resolve-config/local-config-with-file.yaml

@@ -0,0 +1,19 @@
+lint:
+  rules:
+    no-invalid-media-type-examples: warn
+    operation-4xx-response: off
+    assert/tag-description:
+      subject: Tag
+      property: description
+      message: Tag description must be at least 13 characters and end with a full stop.
+      severity: error
+      minLength: 13
+      pattern: /\.$/
+  plugins:
+    - plugin.js
+    - api/plugin.js
+  extends:
+    - recommended
+    - api/nested-config.yaml
+    - test-plugin-nested/all
+    - test-plugin/all

package/src/config/__tests__/fixtures/resolve-config/local-config.yaml

@@ -0,0 +1,10 @@
+lint:
+  plugins:
+    - plugin.js
+  extends:
+    - test-plugin/all
+  rules:
+    no-invalid-media-type-examples: error
+    operation-description: error
+    path-http-verbs-order: error
+    operation-2xx-response: off

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

@@ -0,0 +1,66 @@
+const id = 'test-plugin';
+
+/** @type {import('../../config').PreprocessorsConfig} */
+const preprocessors = {
+  oas2: {
+    'description-preprocessor': () => {
+      return {
+        Info(info) {
+          const title = info.title || 'API title';
+          info.description = `# ${title}\n\n${info.description || ''}`;
+        },
+      };
+    },
+  },
+};
+
+/** @type {import('../../config').CustomRulesConfig} */
+const rules = {
+  oas3: {
+    'openid-connect-url-well-known': () => {
+      return {
+        SecurityScheme(scheme, { location, report }) {
+          if (scheme.type === 'openIdConnect') {
+            if (scheme.openIdConnectUrl && !scheme.openIdConnectUrl.endsWith('/.well-known/openid-configuration')) {
+              report({
+                message:
+                  'openIdConnectUrl must be a URL that ends with /.well-known/openid-configuration',
+                location: location.child('openIdConnectUrl'),
+              });
+            }
+          }
+        },
+      };
+    },
+  },
+};
+
+/** @type {import('../../config').DecoratorsConfig} */
+const decorators = {
+  oas3: {
+    'inject-x-stats': () => {
+      return {
+        Info(info) {
+          info['x-stats'] = { test: 1 };
+        },
+      };
+    },
+  },
+};
+
+const configs = {
+  all: {
+    rules: {
+      'local/operation-id-not-test': 'error',
+      'boolean-parameter-prefixes': 'error',
+    },
+  },
+};
+
+module.exports = {
+  id,
+  preprocessors,
+  rules,
+  decorators,
+  configs,
+};

package/src/config/__tests__/fixtures/resolve-remote-configs/nested-remote-config.yaml

@@ -0,0 +1,4 @@
+lint:
+  rules:
+    operation-2xx-response: off
+    operation-4xx-response: error

package/src/config/__tests__/fixtures/resolve-remote-configs/remote-config.yaml

@@ -0,0 +1,5 @@
+lint:
+  extends:
+    - nested-remote-config.yaml
+  rules:
+    operation-2xx-response: error

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

@@ -0,0 +1,83 @@
+import { loadConfig, findConfig, getConfig } from '../load';
+import { RedoclyClient } from '../../redocly';
+
+const fs = require('fs');
+const path = require('path');
+
+describe('loadConfig', () => {
+  it('should resolve config http header by US region', async () => {
+    jest
+      .spyOn(RedoclyClient.prototype, 'getTokens')
+      .mockImplementation(() =>
+        Promise.resolve([{ region: 'us', token: 'accessToken', valid: true }]),
+      );
+    const config = await loadConfig();
+    expect(config.resolve.http.headers).toStrictEqual([
+      {
+        matches: 'https://api.redocly.com/registry/**',
+        name: 'Authorization',
+        envVariable: undefined,
+        value: 'accessToken',
+      },
+      {
+        matches: 'https://api.redoc.ly/registry/**',
+        name: 'Authorization',
+        envVariable: undefined,
+        value: 'accessToken',
+      },
+    ]);
+  });
+
+  it('should resolve config http header by EU region', async () => {
+    jest
+      .spyOn(RedoclyClient.prototype, 'getTokens')
+      .mockImplementation(() =>
+        Promise.resolve([{ region: 'eu', token: 'accessToken', valid: true }]),
+      );
+    const config = await loadConfig();
+    expect(config.resolve.http.headers).toStrictEqual([
+      {
+        matches: 'https://api.eu.redocly.com/registry/**',
+        name: 'Authorization',
+        envVariable: undefined,
+        value: 'accessToken',
+      },
+    ]);
+  });
+});
+
+describe('findConfig', () => {
+  it('should find redocly.yaml', async () => {
+    jest.spyOn(fs, 'existsSync').mockImplementation((name) => name === 'redocly.yaml');
+    const configName = findConfig();
+    expect(configName).toStrictEqual('redocly.yaml');
+  });
+  it('should find .redocly.yaml', async () => {
+    jest.spyOn(fs, 'existsSync').mockImplementation((name) => name === '.redocly.yaml');
+    const configName = findConfig();
+    expect(configName).toStrictEqual('.redocly.yaml');
+  });
+  it('should throw an error when found multiple config files', async () => {
+    jest
+      .spyOn(fs, 'existsSync')
+      .mockImplementation((name) => name === 'redocly.yaml' || name === '.redocly.yaml');
+    expect(findConfig).toThrow(`
+      Multiple configuration files are not allowed. 
+      Found the following files: redocly.yaml, .redocly.yaml. 
+      Please use 'redocly.yaml' instead.
+    `);
+  });
+  it('should find a nested config ', async () => {
+    jest.spyOn(fs, 'existsSync').mockImplementation((name) => name === 'dir/redocly.yaml');
+    jest.spyOn(path, 'resolve').mockImplementationOnce((dir, name) => `${dir}/${name}`);
+    const configName = findConfig('dir');
+    expect(configName).toStrictEqual('dir/redocly.yaml');
+  });
+});
+
+describe('getConfig', () => {
+  jest.spyOn(fs, 'hasOwnProperty').mockImplementation(() => false);
+  it('should return empty object if there is no configPath and config file is not found', () => {
+    expect(getConfig()).toEqual(Promise.resolve({}));
+  });
+});

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

@@ -0,0 +1,27 @@
+import * as path from 'path';
+import { loadConfig } from '../load';
+
+describe('resolving a plugin', () => {
+  const configPath = path.join(__dirname, 'fixtures/plugin-config.yaml');
+
+  it('should prefix rule names with the plugin id', async () => {
+    const config = await loadConfig(configPath);
+    const plugin = config.lint.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];
+
+    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];
+
+    expect(plugin.decorators?.oas3).toHaveProperty('test-plugin/inject-x-stats');
+  });
+});

package/src/config/all.ts

@@ -0,0 +1,66 @@
+import type { PluginLintConfig } from "./types";
+
+
+export default {
+  rules: {
+    'info-description': 'error',
+    'info-contact': 'error',
+    'info-license': 'error',
+    'info-license-url': 'error',
+    'tag-description': 'error',
+    'tags-alphabetical': 'error',
+    'parameter-description': 'error',
+    'no-identical-paths': 'error',
+    'no-ambiguous-paths': 'error',
+    'no-path-trailing-slash': 'error',
+    'path-segment-plural': 'error',
+    'path-declaration-must-exist': 'error',
+    'path-not-include-query': 'error',
+    'path-parameters-defined': 'error',
+    'operation-description': 'error',
+    'operation-2xx-response': 'error',
+    'operation-4xx-response': 'error',
+    'assertions': 'error',
+    'operation-operationId': 'error',
+    'operation-summary': 'error',
+    'operation-operationId-unique': 'error',
+    'operation-operationId-url-safe': 'error',
+    'operation-parameters-unique': 'error',
+    'operation-tag-defined': 'error',
+    'operation-security-defined': 'error',
+    'operation-singular-tag': 'error',
+    'no-unresolved-refs': 'error',
+    'no-enum-type-mismatch': 'error',
+    'boolean-parameter-prefixes': 'error',
+    'paths-kebab-case': 'error',
+    'no-http-verbs-in-paths': 'error',
+    'path-excludes-patterns': {
+      severity: 'error',
+      patterns: [],
+    },
+    'request-mime-type': 'error',
+    spec: 'error',
+    'no-invalid-schema-examples': 'error',
+    'no-invalid-parameter-examples': 'error',
+    'scalar-property-missing-example': 'error',
+  },
+  oas3_0Rules: {
+    'no-invalid-media-type-examples': 'error',
+    'no-server-example.com': 'error',
+    'no-server-trailing-slash': 'error',
+    'no-empty-servers': 'error',
+    'no-example-value-and-externalValue': 'error',
+    'no-unused-components': 'error',
+    'no-undefined-server-variable': 'error',
+    'no-servers-empty-enum': 'error',
+  },
+  oas3_1Rules: {
+    'no-server-example.com': 'error',
+    'no-server-trailing-slash': 'error',
+    'no-empty-servers': 'error',
+    'no-example-value-and-externalValue': 'error',
+    'no-unused-components': 'error',
+    'no-undefined-server-variable': 'error',
+    'no-servers-empty-enum': 'error',
+  },
+} as PluginLintConfig;

package/src/config/builtIn.ts

@@ -0,0 +1,37 @@
+import recommended from './recommended';
+import all from './all';
+import minimal from './minimal';
+import { rules as oas3Rules } from '../rules/oas3';
+import { rules as oas2Rules } from '../rules/oas2';
+import { preprocessors as oas3Preprocessors } from '../rules/oas3';
+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';
+
+export const builtInConfigs: Record<string, LintRawConfig> = {
+  recommended,
+  minimal,
+  all,
+  'redocly-registry': {
+    decorators: { 'registry-dependencies': 'on' }
+  }
+};
+
+export const defaultPlugin: Plugin = {
+  id: '', // default plugin doesn't have id
+  rules: {
+    oas3: oas3Rules,
+    oas2: oas2Rules,
+  } as CustomRulesConfig,
+  preprocessors: {
+    oas3: oas3Preprocessors,
+    oas2: oas2Preprocessors,
+  },
+  decorators: {
+    oas3: oas3Decorators,
+    oas2: oas2Decorators,
+  },
+  configs: builtInConfigs,
+}