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

package/README.md

@@ -9,9 +9,9 @@ See https://github.com/Redocly/redocly-cli
 ```js
 import { formatProblems, lint, loadConfig } from '@redocly/openapi-core';
 
-const pathToEntryPoint = 'openapi.yaml';
+const pathToApi = 'openapi.yaml';
 const config = loadConfig('optional/path/to/.redocly.yaml');
-const lintResults = await lint({ ref: pathToEntryPoint, config });
+const lintResults = await lint({ ref: pathToApi, config });
 ```
 
 ### Bundle
@@ -19,7 +19,7 @@ const lintResults = await lint({ ref: pathToEntryPoint, config });
 ```js
 import { formatProblems, bundle, loadConfig } from '@redocly/openapi-core';
 
-const pathToEntryPoint = 'openapi.yaml';
+const pathToApi = 'openapi.yaml';
 const config = loadConfig('optional/path/to/.redocly.yaml');
-const { bundle, problems } = await bundle({ ref: pathToEntryPoint, config });
+const { bundle, problems } = await bundle({ ref: pathToApi, config });
 ```

package/__tests__/utils.ts

@@ -1,7 +1,7 @@
 import * as path from 'path';
 
 import { Document, Source, NormalizedProblem, parseYaml, stringifyYaml } from '../src';
-import { LintConfig, resolveLint, resolvePlugins } from '../src/config';
+import { StyleguideConfig, resolveStyleguideConfig, resolvePlugins } from '../src/config';
 import { Oas3RuleSet } from '../src/oas-types';
 
 import type { RuleConfig, Plugin, DecoratorConfig } from '../src/config';
@@ -63,7 +63,7 @@ export function makeConfigForRuleset(
     },
   ]);
 
-  return new LintConfig({
+  return new StyleguideConfig({
     plugins,
     rules: rulesConf,
   });
@@ -74,9 +74,9 @@ export async function makeConfig(
   decorators?: Record<string, DecoratorConfig>,
   configPath?: string
 ) {
-  return new LintConfig(
-    await resolveLint({
-      lintConfig: {
+  return new StyleguideConfig(
+    await resolveStyleguideConfig({
+      styleguideConfig: {
         plugins: [],
         extends: [],
         rules,

package/lib/benchmark/benches/lint-with-top-level-rule-report.bench.js

@@ -13,7 +13,6 @@ const rebillyDocument = utils_1.parseYamlToDocument(fs_1.readFileSync(rebillyDef
 const config = utils_1.makeConfigForRuleset({
     test: () => {
         return {
-            // @ts-ignore
             Schema(schema, ctx) {
                 if (schema.type === 'number') {
                     ctx.report({

package/lib/benchmark/benches/recommended-oas3.bench.js

@@ -15,7 +15,7 @@ function measureAsync() {
     return lint_1.lintDocument({
         externalRefResolver: new resolve_1.BaseResolver(),
         document: rebillyDocument,
-        config: new config_1.LintConfig(config_1.resolvePreset('recommended', [config_1.defaultPlugin])),
+        config: new config_1.StyleguideConfig(config_1.resolvePreset('recommended', [config_1.defaultPlugin])),
     });
 }
 exports.measureAsync = measureAsync;

package/lib/benchmark/utils.d.ts

@@ -1,6 +1,6 @@
 import { Document } from '../resolve';
 import { Oas3RuleSet } from '../oas-types';
-import { LintConfig } from '../config';
+import { StyleguideConfig } from '../config';
 import type { Plugin } from '../config/types';
 export declare function parseYamlToDocument(body: string, absoluteRef?: string): Document;
-export declare function makeConfigForRuleset(rules: Oas3RuleSet, plugin?: Partial<Plugin>): LintConfig;
+export declare function makeConfigForRuleset(rules: Oas3RuleSet, plugin?: Partial<Plugin>): StyleguideConfig;

package/lib/benchmark/utils.js

@@ -25,7 +25,7 @@ function makeConfigForRuleset(rules, plugin) {
     if (rules) {
         extendConfigs.push({ rules });
     }
-    const lint = config_1.mergeExtends(extendConfigs);
-    return new config_1.LintConfig(lint);
+    const styleguide = config_1.mergeExtends(extendConfigs);
+    return new config_1.StyleguideConfig(styleguide);
 }
 exports.makeConfigForRuleset = makeConfigForRuleset;

package/lib/bundle.d.ts

@@ -2,7 +2,7 @@ import { BaseResolver, Document } from './resolve';
 import { Oas3Rule } from './visitors';
 import { NormalizedNodeType, NodeType } from './types';
 import { OasMajorVersion } from './oas-types';
-import type { Config, LintConfig } from './config';
+import type { Config, StyleguideConfig } from './config';
 export declare type Oas3RuleSet = Record<string, Oas3Rule>;
 export declare enum OasVersion {
     Version2 = "oas2",
@@ -29,7 +29,7 @@ export declare function bundle(opts: {
 }>;
 export declare function bundleDocument(opts: {
     document: Document;
-    config: LintConfig;
+    config: StyleguideConfig;
     customTypes?: Record<string, NodeType>;
     externalRefResolver: BaseResolver;
     dereference?: boolean;

package/lib/bundle.js

@@ -42,7 +42,7 @@ function bundle(opts) {
         if (document instanceof Error) {
             throw document;
         }
-        return bundleDocument(Object.assign(Object.assign({ document }, opts), { config: opts.config.lint, externalRefResolver }));
+        return bundleDocument(Object.assign(Object.assign({ document }, opts), { config: opts.config.styleguide, externalRefResolver }));
     });
 }
 exports.bundle = bundle;
@@ -71,7 +71,7 @@ function bundleDocument(opts) {
                 ruleId: 'remove-unused-components',
                 visitor: oasMajorVersion === oas_types_1.OasMajorVersion.Version2
                     ? remove_unused_components_1.RemoveUnusedComponents({})
-                    : remove_unused_components_2.RemoveUnusedComponents({})
+                    : remove_unused_components_2.RemoveUnusedComponents({}),
             });
         }
         const resolvedRefMap = yield resolve_1.resolveDocument({
@@ -231,9 +231,12 @@ function makeBundleVisitor(version, dereference, skipRedoclyRegistryRefs, rootDo
             ctx.parent[ctx.key] = resolved.node;
         }
         else {
+            // TODO: why $ref isn't optional in OasRef?
+            // eslint-disable-next-line @typescript-eslint/ban-ts-comment
             // @ts-ignore
             delete ref.$ref;
-            Object.assign(ref, resolved.node);
+            const obj = Object.assign({}, resolved.node, ref);
+            Object.assign(ref, obj); // assign ref itself again so ref fields take precedence
         }
     }
     function saveComponent(componentType, target, ctx) {
@@ -259,7 +262,7 @@ function makeBundleVisitor(version, dereference, skipRedoclyRegistryRefs, rootDo
         const [fileRef, pointer] = [target.location.source.absoluteRef, target.location.pointer];
         const componentsGroup = components[componentType];
         let name = '';
-        const refParts = pointer.slice(2).split('/').filter(Boolean); // slice(2) removes "#/"
+        const refParts = pointer.slice(2).split('/').filter(utils_1.isTruthy); // slice(2) removes "#/"
         while (refParts.length > 0) {
             name = refParts.pop() + (name ? `-${name}` : '');
             if (!componentsGroup ||

package/lib/config/all.d.ts

@@ -1,3 +1,3 @@
-import type { PluginLintConfig } from "./types";
-declare const _default: PluginLintConfig;
+import type { PluginStyleguideConfig } from './types';
+declare const _default: PluginStyleguideConfig;
 export default _default;

package/lib/config/all.js

@@ -19,7 +19,7 @@ exports.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',
@@ -51,7 +51,7 @@ exports.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',
@@ -60,6 +60,6 @@ exports.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',
     },
 };

package/lib/config/builtIn.d.ts

@@ -1,3 +1,3 @@
-import type { LintRawConfig, Plugin } from './types';
-export declare const builtInConfigs: Record<string, LintRawConfig>;
+import type { StyleguideRawConfig, Plugin } from './types';
+export declare const builtInConfigs: Record<string, StyleguideRawConfig>;
 export declare const defaultPlugin: Plugin;

package/lib/config/builtIn.js

@@ -15,8 +15,8 @@ exports.builtInConfigs = {
     minimal: minimal_1.default,
     all: all_1.default,
     'redocly-registry': {
-        decorators: { 'registry-dependencies': 'on' }
-    }
+        decorators: { 'registry-dependencies': 'on' },
+    },
 };
 exports.defaultPlugin = {
     id: '',

package/lib/config/config-resolvers.d.ts

@@ -1,5 +1,5 @@
 import { BaseResolver } from '../resolve';
-import type { LintRawConfig, Plugin, RawConfig, ResolvedApi, ResolvedLintConfig } from './types';
+import type { StyleguideRawConfig, Plugin, RawConfig, ResolvedApi, ResolvedStyleguideConfig } from './types';
 import { Config } from './config';
 export declare function resolveConfig(rawConfig: RawConfig, configPath?: string): Promise<Config>;
 export declare function resolvePlugins(plugins: (string | Plugin)[] | null, configPath?: string): Plugin[];
@@ -8,9 +8,9 @@ export declare function resolveApis({ rawConfig, configPath, resolver, }: {
     configPath?: string;
     resolver?: BaseResolver;
 }): Promise<Record<string, ResolvedApi>>;
-export declare function resolveLint(lintOpts: {
-    lintConfig?: LintRawConfig;
+export declare function resolveStyleguideConfig(opts: {
+    styleguideConfig?: StyleguideRawConfig;
     configPath?: string;
     resolver?: BaseResolver;
-}, parentConfigPaths?: string[], extendPaths?: string[]): Promise<ResolvedLintConfig>;
-export declare function resolvePreset(presetName: string, plugins: Plugin[]): ResolvedLintConfig;
+}, parentConfigPaths?: string[], extendPaths?: string[]): Promise<ResolvedStyleguideConfig>;
+export declare function resolvePreset(presetName: string, plugins: Plugin[]): ResolvedStyleguideConfig;

package/lib/config/config-resolvers.js

@@ -20,62 +20,80 @@ var __rest = (this && this.__rest) || function (s, e) {
     return t;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.resolvePreset = exports.resolveLint = exports.resolveApis = exports.resolvePlugins = exports.resolveConfig = void 0;
+exports.resolvePreset = exports.resolveStyleguideConfig = exports.resolveApis = exports.resolvePlugins = exports.resolveConfig = void 0;
 const path = require("path");
-const colorette_1 = require("colorette");
 const ref_utils_1 = require("../ref-utils");
 const resolve_1 = require("../resolve");
 const builtIn_1 = require("./builtIn");
 const utils_1 = require("./utils");
+const env_1 = require("../env");
 const utils_2 = require("../utils");
 const config_1 = require("./config");
+const logger_1 = require("../logger");
 function resolveConfig(rawConfig, configPath) {
     var _a, _b, _c, _d, _e;
     return __awaiter(this, void 0, void 0, function* () {
-        if ((_b = (_a = rawConfig.lint) === null || _a === void 0 ? void 0 : _a.extends) === null || _b === void 0 ? void 0 : _b.some(utils_2.isNotString)) {
+        if ((_b = (_a = rawConfig.styleguide) === null || _a === void 0 ? void 0 : _a.extends) === null || _b === void 0 ? void 0 : _b.some(utils_2.isNotString)) {
             throw new Error(`Error configuration format not detected in extends value must contain strings`);
         }
         const resolver = new resolve_1.BaseResolver(utils_1.getResolveConfig(rawConfig.resolve));
-        const configExtends = (_d = (_c = rawConfig === null || rawConfig === void 0 ? void 0 : rawConfig.lint) === null || _c === void 0 ? void 0 : _c.extends) !== null && _d !== void 0 ? _d : ['recommended'];
-        const recommendedFallback = !((_e = rawConfig === null || rawConfig === void 0 ? void 0 : rawConfig.lint) === null || _e === void 0 ? void 0 : _e.extends);
-        const lintConfig = Object.assign(Object.assign({}, rawConfig === null || rawConfig === void 0 ? void 0 : rawConfig.lint), { extends: configExtends, recommendedFallback });
+        const configExtends = (_d = (_c = rawConfig === null || rawConfig === void 0 ? void 0 : rawConfig.styleguide) === null || _c === void 0 ? void 0 : _c.extends) !== null && _d !== void 0 ? _d : ['recommended'];
+        const recommendedFallback = !((_e = rawConfig === null || rawConfig === void 0 ? void 0 : rawConfig.styleguide) === null || _e === void 0 ? void 0 : _e.extends);
+        const styleguideConfig = Object.assign(Object.assign({}, rawConfig === null || rawConfig === void 0 ? void 0 : rawConfig.styleguide), { extends: configExtends, recommendedFallback });
         const apis = yield resolveApis({
-            rawConfig: Object.assign(Object.assign({}, rawConfig), { lint: lintConfig }),
+            rawConfig: Object.assign(Object.assign({}, rawConfig), { styleguide: styleguideConfig }),
             configPath,
             resolver,
         });
-        const lint = yield resolveLint({
-            lintConfig,
+        const styleguide = yield resolveStyleguideConfig({
+            styleguideConfig,
             configPath,
             resolver,
         });
         return new config_1.Config(Object.assign(Object.assign({}, rawConfig), { apis,
-            lint }), configPath);
+            styleguide }), configPath);
     });
 }
 exports.resolveConfig = resolveConfig;
 function resolvePlugins(plugins, configPath = '') {
     if (!plugins)
         return [];
-    // @ts-ignore
-    const requireFunc = typeof __webpack_require__ === 'function' ? __non_webpack_require__ : require;
+    // TODO: implement or reuse Resolver approach so it will work in node and browser envs
+    const requireFunc = (plugin) => {
+        if (env_1.isBrowser && utils_2.isString(plugin)) {
+            logger_1.logger.error(`Cannot load ${plugin}. Plugins aren't supported in browser yet.`);
+            return undefined;
+        }
+        if (utils_2.isString(plugin)) {
+            const absoltePluginPath = path.resolve(path.dirname(configPath), plugin);
+            // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+            // @ts-ignore
+            return typeof __webpack_require__ === 'function'
+                ? // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+                    // @ts-ignore
+                    __non_webpack_require__(absoltePluginPath)
+                : require(absoltePluginPath);
+        }
+        return plugin;
+    };
     const seenPluginIds = new Map();
     return plugins
         .map((p) => {
         if (utils_2.isString(p) && ref_utils_1.isAbsoluteUrl(p)) {
-            throw new Error(colorette_1.red(`We don't support remote plugins yet.`));
+            throw new Error(logger_1.colorize.red(`We don't support remote plugins yet.`));
         }
         // TODO: resolve npm packages similar to eslint
-        const pluginModule = utils_2.isString(p)
-            ? requireFunc(path.resolve(path.dirname(configPath), p))
-            : p;
+        const pluginModule = requireFunc(p);
+        if (!pluginModule) {
+            return;
+        }
         const id = pluginModule.id;
         if (typeof id !== 'string') {
-            throw new Error(colorette_1.red(`Plugin must define \`id\` property in ${colorette_1.blue(p.toString())}.`));
+            throw new Error(logger_1.colorize.red(`Plugin must define \`id\` property in ${logger_1.colorize.blue(p.toString())}.`));
         }
         if (seenPluginIds.has(id)) {
             const pluginPath = seenPluginIds.get(id);
-            throw new Error(colorette_1.red(`Plugin "id" must be unique. Plugin ${colorette_1.blue(p.toString())} uses id "${colorette_1.blue(id)}" already seen in ${colorette_1.blue(pluginPath)}`));
+            throw new Error(logger_1.colorize.red(`Plugin "id" must be unique. Plugin ${logger_1.colorize.blue(p.toString())} uses id "${logger_1.colorize.blue(id)}" already seen in ${logger_1.colorize.blue(pluginPath)}`));
         }
         seenPluginIds.set(id, p.toString());
         const plugin = Object.assign(Object.assign({ id }, (pluginModule.configs ? { configs: pluginModule.configs } : {})), (pluginModule.typeExtension ? { typeExtension: pluginModule.typeExtension } : {}));
@@ -123,36 +141,36 @@ exports.resolvePlugins = resolvePlugins;
 function resolveApis({ rawConfig, configPath = '', resolver, }) {
     var _a, _b;
     return __awaiter(this, void 0, void 0, function* () {
-        const { apis = {}, lint: lintConfig = {} } = rawConfig;
-        let resolvedApis = {};
+        const { apis = {}, styleguide: styleguideConfig = {} } = rawConfig;
+        const resolvedApis = {};
         for (const [apiName, apiContent] of Object.entries(apis || {})) {
-            if ((_b = (_a = apiContent.lint) === null || _a === void 0 ? void 0 : _a.extends) === null || _b === void 0 ? void 0 : _b.some(utils_2.isNotString)) {
+            if ((_b = (_a = apiContent.styleguide) === null || _a === void 0 ? void 0 : _a.extends) === null || _b === void 0 ? void 0 : _b.some(utils_2.isNotString)) {
                 throw new Error(`Error configuration format not detected in extends value must contain strings`);
             }
-            const rawLintConfig = getMergedLintRawConfig(lintConfig, apiContent.lint);
-            const apiLint = yield resolveLint({
-                lintConfig: rawLintConfig,
+            const rawStyleguideConfig = getMergedRawStyleguideConfig(styleguideConfig, apiContent.styleguide);
+            const resolvedApiConfig = yield resolveStyleguideConfig({
+                styleguideConfig: rawStyleguideConfig,
                 configPath,
                 resolver,
             });
-            resolvedApis[apiName] = Object.assign(Object.assign({}, apiContent), { lint: apiLint });
+            resolvedApis[apiName] = Object.assign(Object.assign({}, apiContent), { styleguide: resolvedApiConfig });
         }
         return resolvedApis;
     });
 }
 exports.resolveApis = resolveApis;
-function resolveAndMergeNestedLint({ lintConfig, configPath = '', resolver = new resolve_1.BaseResolver(), }, parentConfigPaths = [], extendPaths = []) {
+function resolveAndMergeNestedStyleguideConfig({ styleguideConfig, configPath = '', resolver = new resolve_1.BaseResolver(), }, parentConfigPaths = [], extendPaths = []) {
     var _a, _b, _c;
     return __awaiter(this, void 0, void 0, function* () {
         if (parentConfigPaths.includes(configPath)) {
             throw new Error(`Circular dependency in config file: "${configPath}"`);
         }
-        const plugins = utils_1.getUniquePlugins(resolvePlugins([...((lintConfig === null || lintConfig === void 0 ? void 0 : lintConfig.plugins) || []), builtIn_1.defaultPlugin], configPath));
-        const pluginPaths = (_a = lintConfig === null || lintConfig === void 0 ? void 0 : lintConfig.plugins) === null || _a === void 0 ? void 0 : _a.filter(utils_2.isString).map((p) => path.resolve(path.dirname(configPath), p));
+        const plugins = utils_1.getUniquePlugins(resolvePlugins([...((styleguideConfig === null || styleguideConfig === void 0 ? void 0 : styleguideConfig.plugins) || []), builtIn_1.defaultPlugin], configPath));
+        const pluginPaths = (_a = styleguideConfig === null || styleguideConfig === void 0 ? void 0 : styleguideConfig.plugins) === null || _a === void 0 ? void 0 : _a.filter(utils_2.isString).map((p) => path.resolve(path.dirname(configPath), p));
         const resolvedConfigPath = ref_utils_1.isAbsoluteUrl(configPath)
             ? configPath
             : configPath && path.resolve(configPath);
-        const extendConfigs = yield Promise.all(((_b = lintConfig === null || lintConfig === void 0 ? void 0 : lintConfig.extends) === null || _b === void 0 ? void 0 : _b.map((presetItem) => __awaiter(this, void 0, void 0, function* () {
+        const extendConfigs = yield Promise.all(((_b = styleguideConfig === null || styleguideConfig === void 0 ? void 0 : styleguideConfig.extends) === null || _b === void 0 ? void 0 : _b.map((presetItem) => __awaiter(this, void 0, void 0, function* () {
             if (!ref_utils_1.isAbsoluteUrl(presetItem) && !path.extname(presetItem)) {
                 return resolvePreset(presetItem, plugins);
             }
@@ -161,63 +179,66 @@ function resolveAndMergeNestedLint({ lintConfig, configPath = '', resolver = new
                 : ref_utils_1.isAbsoluteUrl(configPath)
                     ? new URL(presetItem, configPath).href
                     : path.resolve(path.dirname(configPath), presetItem);
-            const extendedLintConfig = yield loadExtendLintConfig(pathItem, resolver);
-            return yield resolveAndMergeNestedLint({
-                lintConfig: extendedLintConfig,
+            const extendedStyleguideConfig = yield loadExtendStyleguideConfig(pathItem, resolver);
+            return yield resolveAndMergeNestedStyleguideConfig({
+                styleguideConfig: extendedStyleguideConfig,
                 configPath: pathItem,
                 resolver: resolver,
             }, [...parentConfigPaths, resolvedConfigPath], extendPaths);
         }))) || []);
         const _d = utils_1.mergeExtends([
             ...extendConfigs,
-            Object.assign(Object.assign({}, lintConfig), { plugins, extends: undefined, extendPaths: [...parentConfigPaths, resolvedConfigPath], pluginPaths }),
-        ]), { plugins: mergedPlugins = [] } = _d, lint = __rest(_d, ["plugins"]);
-        return Object.assign(Object.assign({}, lint), { extendPaths: (_c = lint.extendPaths) === null || _c === void 0 ? void 0 : _c.filter((path) => path && !ref_utils_1.isAbsoluteUrl(path)), plugins: utils_1.getUniquePlugins(mergedPlugins), recommendedFallback: lintConfig === null || lintConfig === void 0 ? void 0 : lintConfig.recommendedFallback, doNotResolveExamples: lintConfig === null || lintConfig === void 0 ? void 0 : lintConfig.doNotResolveExamples });
+            Object.assign(Object.assign({}, styleguideConfig), { plugins, extends: undefined, extendPaths: [...parentConfigPaths, resolvedConfigPath], pluginPaths }),
+        ]), { plugins: mergedPlugins = [] } = _d, styleguide = __rest(_d, ["plugins"]);
+        return Object.assign(Object.assign({}, styleguide), { extendPaths: (_c = styleguide.extendPaths) === null || _c === void 0 ? void 0 : _c.filter((path) => path && !ref_utils_1.isAbsoluteUrl(path)), plugins: utils_1.getUniquePlugins(mergedPlugins), recommendedFallback: styleguideConfig === null || styleguideConfig === void 0 ? void 0 : styleguideConfig.recommendedFallback, doNotResolveExamples: styleguideConfig === null || styleguideConfig === void 0 ? void 0 : styleguideConfig.doNotResolveExamples });
     });
 }
-function resolveLint(lintOpts, parentConfigPaths = [], extendPaths = []) {
+function resolveStyleguideConfig(opts, parentConfigPaths = [], extendPaths = []) {
     return __awaiter(this, void 0, void 0, function* () {
-        const resolvedLint = yield resolveAndMergeNestedLint(lintOpts, parentConfigPaths, extendPaths);
-        return Object.assign(Object.assign({}, resolvedLint), { rules: resolvedLint.rules && groupLintAssertionRules(resolvedLint.rules) });
+        const resolvedStyleguideConfig = yield resolveAndMergeNestedStyleguideConfig(opts, parentConfigPaths, extendPaths);
+        return Object.assign(Object.assign({}, resolvedStyleguideConfig), { rules: resolvedStyleguideConfig.rules &&
+                groupStyleguideAssertionRules(resolvedStyleguideConfig.rules) });
     });
 }
-exports.resolveLint = resolveLint;
+exports.resolveStyleguideConfig = resolveStyleguideConfig;
 function resolvePreset(presetName, plugins) {
     var _a;
     const { pluginId, configName } = utils_1.parsePresetName(presetName);
     const plugin = plugins.find((p) => p.id === pluginId);
     if (!plugin) {
-        throw new Error(`Invalid config ${colorette_1.red(presetName)}: plugin ${pluginId} is not included.`);
+        throw new Error(`Invalid config ${logger_1.colorize.red(presetName)}: plugin ${pluginId} is not included.`);
     }
     const preset = (_a = plugin.configs) === null || _a === void 0 ? void 0 : _a[configName];
     if (!preset) {
         throw new Error(pluginId
-            ? `Invalid config ${colorette_1.red(presetName)}: plugin ${pluginId} doesn't export config with name ${configName}.`
-            : `Invalid config ${colorette_1.red(presetName)}: there is no such built-in config.`);
+            ? `Invalid config ${logger_1.colorize.red(presetName)}: plugin ${pluginId} doesn't export config with name ${configName}.`
+            : `Invalid config ${logger_1.colorize.red(presetName)}: there is no such built-in config.`);
     }
     return preset;
 }
 exports.resolvePreset = resolvePreset;
-function loadExtendLintConfig(filePath, resolver) {
+function loadExtendStyleguideConfig(filePath, resolver) {
     return __awaiter(this, void 0, void 0, function* () {
         try {
             const fileSource = yield resolver.loadExternalRef(filePath);
             const rawConfig = utils_1.transformConfig(utils_2.parseYaml(fileSource.body));
-            if (!rawConfig.lint) {
-                throw new Error(`Lint configuration format not detected: "${filePath}"`);
+            if (!rawConfig.styleguide) {
+                throw new Error(`Styleguide configuration format not detected: "${filePath}"`);
             }
-            return rawConfig.lint;
+            return rawConfig.styleguide;
         }
         catch (error) {
             throw new Error(`Failed to load "${filePath}": ${error.message}`);
         }
     });
 }
-function getMergedLintRawConfig(configLint, apiLint) {
-    const resultLint = Object.assign(Object.assign(Object.assign({}, configLint), apiLint), { rules: Object.assign(Object.assign({}, configLint === null || configLint === void 0 ? void 0 : configLint.rules), apiLint === null || apiLint === void 0 ? void 0 : apiLint.rules), oas2Rules: Object.assign(Object.assign({}, configLint === null || configLint === void 0 ? void 0 : configLint.oas2Rules), apiLint === null || apiLint === void 0 ? void 0 : apiLint.oas2Rules), oas3_0Rules: Object.assign(Object.assign({}, configLint === null || configLint === void 0 ? void 0 : configLint.oas3_0Rules), apiLint === null || apiLint === void 0 ? void 0 : apiLint.oas3_0Rules), oas3_1Rules: Object.assign(Object.assign({}, configLint === null || configLint === void 0 ? void 0 : configLint.oas3_1Rules), apiLint === null || apiLint === void 0 ? void 0 : apiLint.oas3_1Rules), preprocessors: Object.assign(Object.assign({}, configLint === null || configLint === void 0 ? void 0 : configLint.preprocessors), apiLint === null || apiLint === void 0 ? void 0 : apiLint.preprocessors), oas2Preprocessors: Object.assign(Object.assign({}, configLint === null || configLint === void 0 ? void 0 : configLint.oas2Preprocessors), apiLint === null || apiLint === void 0 ? void 0 : apiLint.oas2Preprocessors), oas3_0Preprocessors: Object.assign(Object.assign({}, configLint === null || configLint === void 0 ? void 0 : configLint.oas3_0Preprocessors), apiLint === null || apiLint === void 0 ? void 0 : apiLint.oas3_0Preprocessors), oas3_1Preprocessors: Object.assign(Object.assign({}, configLint === null || configLint === void 0 ? void 0 : configLint.oas3_1Preprocessors), apiLint === null || apiLint === void 0 ? void 0 : apiLint.oas3_1Preprocessors), decorators: Object.assign(Object.assign({}, configLint === null || configLint === void 0 ? void 0 : configLint.decorators), apiLint === null || apiLint === void 0 ? void 0 : apiLint.decorators), oas2Decorators: Object.assign(Object.assign({}, configLint === null || configLint === void 0 ? void 0 : configLint.oas2Decorators), apiLint === null || apiLint === void 0 ? void 0 : apiLint.oas2Decorators), oas3_0Decorators: Object.assign(Object.assign({}, configLint === null || configLint === void 0 ? void 0 : configLint.oas3_0Decorators), apiLint === null || apiLint === void 0 ? void 0 : apiLint.oas3_0Decorators), oas3_1Decorators: Object.assign(Object.assign({}, configLint === null || configLint === void 0 ? void 0 : configLint.oas3_1Decorators), apiLint === null || apiLint === void 0 ? void 0 : apiLint.oas3_1Decorators), recommendedFallback: (apiLint === null || apiLint === void 0 ? void 0 : apiLint.extends) ? false : configLint.recommendedFallback });
+function getMergedRawStyleguideConfig(rootStyleguideConfig, apiStyleguideConfig) {
+    const resultLint = Object.assign(Object.assign(Object.assign({}, rootStyleguideConfig), apiStyleguideConfig), { rules: Object.assign(Object.assign({}, rootStyleguideConfig === null || rootStyleguideConfig === void 0 ? void 0 : rootStyleguideConfig.rules), apiStyleguideConfig === null || apiStyleguideConfig === void 0 ? void 0 : apiStyleguideConfig.rules), oas2Rules: Object.assign(Object.assign({}, rootStyleguideConfig === null || rootStyleguideConfig === void 0 ? void 0 : rootStyleguideConfig.oas2Rules), apiStyleguideConfig === null || apiStyleguideConfig === void 0 ? void 0 : apiStyleguideConfig.oas2Rules), oas3_0Rules: Object.assign(Object.assign({}, rootStyleguideConfig === null || rootStyleguideConfig === void 0 ? void 0 : rootStyleguideConfig.oas3_0Rules), apiStyleguideConfig === null || apiStyleguideConfig === void 0 ? void 0 : apiStyleguideConfig.oas3_0Rules), oas3_1Rules: Object.assign(Object.assign({}, rootStyleguideConfig === null || rootStyleguideConfig === void 0 ? void 0 : rootStyleguideConfig.oas3_1Rules), apiStyleguideConfig === null || apiStyleguideConfig === void 0 ? void 0 : apiStyleguideConfig.oas3_1Rules), preprocessors: Object.assign(Object.assign({}, rootStyleguideConfig === null || rootStyleguideConfig === void 0 ? void 0 : rootStyleguideConfig.preprocessors), apiStyleguideConfig === null || apiStyleguideConfig === void 0 ? void 0 : apiStyleguideConfig.preprocessors), oas2Preprocessors: Object.assign(Object.assign({}, rootStyleguideConfig === null || rootStyleguideConfig === void 0 ? void 0 : rootStyleguideConfig.oas2Preprocessors), apiStyleguideConfig === null || apiStyleguideConfig === void 0 ? void 0 : apiStyleguideConfig.oas2Preprocessors), oas3_0Preprocessors: Object.assign(Object.assign({}, rootStyleguideConfig === null || rootStyleguideConfig === void 0 ? void 0 : rootStyleguideConfig.oas3_0Preprocessors), apiStyleguideConfig === null || apiStyleguideConfig === void 0 ? void 0 : apiStyleguideConfig.oas3_0Preprocessors), oas3_1Preprocessors: Object.assign(Object.assign({}, rootStyleguideConfig === null || rootStyleguideConfig === void 0 ? void 0 : rootStyleguideConfig.oas3_1Preprocessors), apiStyleguideConfig === null || apiStyleguideConfig === void 0 ? void 0 : apiStyleguideConfig.oas3_1Preprocessors), decorators: Object.assign(Object.assign({}, rootStyleguideConfig === null || rootStyleguideConfig === void 0 ? void 0 : rootStyleguideConfig.decorators), apiStyleguideConfig === null || apiStyleguideConfig === void 0 ? void 0 : apiStyleguideConfig.decorators), oas2Decorators: Object.assign(Object.assign({}, rootStyleguideConfig === null || rootStyleguideConfig === void 0 ? void 0 : rootStyleguideConfig.oas2Decorators), apiStyleguideConfig === null || apiStyleguideConfig === void 0 ? void 0 : apiStyleguideConfig.oas2Decorators), oas3_0Decorators: Object.assign(Object.assign({}, rootStyleguideConfig === null || rootStyleguideConfig === void 0 ? void 0 : rootStyleguideConfig.oas3_0Decorators), apiStyleguideConfig === null || apiStyleguideConfig === void 0 ? void 0 : apiStyleguideConfig.oas3_0Decorators), oas3_1Decorators: Object.assign(Object.assign({}, rootStyleguideConfig === null || rootStyleguideConfig === void 0 ? void 0 : rootStyleguideConfig.oas3_1Decorators), apiStyleguideConfig === null || apiStyleguideConfig === void 0 ? void 0 : apiStyleguideConfig.oas3_1Decorators), recommendedFallback: (apiStyleguideConfig === null || apiStyleguideConfig === void 0 ? void 0 : apiStyleguideConfig.extends)
+            ? false
+            : rootStyleguideConfig.recommendedFallback });
     return resultLint;
 }
-function groupLintAssertionRules(rules) {
+function groupStyleguideAssertionRules(rules) {
     if (!rules) {
         return rules;
     }

package/lib/config/config.d.ts

@@ -1,9 +1,7 @@
-/// <reference types="node" />
 import { NormalizedProblem } from '../walk';
 import { OasVersion, OasMajorVersion, Oas2RuleSet, Oas3RuleSet } from '../oas-types';
 import type { NodeType } from '../types';
-import type { DecoratorConfig, Plugin, PreprocessorConfig, Region, ResolveConfig, ResolvedApi, ResolvedConfig, ResolvedLintConfig, RuleConfig } from './types';
-export declare const env: NodeJS.ProcessEnv;
+import type { DecoratorConfig, Plugin, PreprocessorConfig, Region, ResolveConfig, ResolvedApi, ResolvedConfig, ResolvedStyleguideConfig, RuleConfig } from './types';
 export declare const IGNORE_FILE = ".redocly.lint-ignore.yaml";
 export declare const DEFAULT_REGION = "us";
 export declare const DOMAINS: {
@@ -11,8 +9,8 @@ export declare const DOMAINS: {
     eu: string;
 };
 export declare const AVAILABLE_REGIONS: Region[];
-export declare class LintConfig {
-    rawConfig: ResolvedLintConfig;
+export declare class StyleguideConfig {
+    rawConfig: ResolvedStyleguideConfig;
     configFile?: string | undefined;
     plugins: Plugin[];
     ignore: Record<string, Record<string, Set<string>>>;
@@ -25,20 +23,20 @@ export declare class LintConfig {
     recommendedFallback: boolean;
     extendPaths: string[];
     pluginPaths: string[];
-    constructor(rawConfig: ResolvedLintConfig, configFile?: string | undefined);
+    constructor(rawConfig: ResolvedStyleguideConfig, configFile?: string | undefined);
     resolveIgnore(ignoreFile?: string): void;
     saveIgnore(): void;
     addIgnore(problem: NormalizedProblem): void;
     addProblemToIgnore(problem: NormalizedProblem): NormalizedProblem;
     extendTypes(types: Record<string, NodeType>, version: OasVersion): Record<string, NodeType>;
     getRuleSettings(ruleId: string, oasVersion: OasVersion): {
-        severity: import("./types").RuleSeverity;
+        severity: string;
     };
     getPreprocessorSettings(ruleId: string, oasVersion: OasVersion): {
-        severity: import("./types").RuleSeverity;
+        severity: string;
     };
     getDecoratorSettings(ruleId: string, oasVersion: OasVersion): {
-        severity: import("./types").RuleSeverity;
+        severity: string;
     };
     getUnusedRules(): {
         rules: string[];
@@ -54,7 +52,7 @@ export declare class Config {
     rawConfig: ResolvedConfig;
     configFile?: string | undefined;
     apis: Record<string, ResolvedApi>;
-    lint: LintConfig;
+    styleguide: StyleguideConfig;
     resolve: ResolveConfig;
     licenseKey?: string;
     region?: Region;

package/lib/config/config.js

@@ -1,14 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Config = exports.LintConfig = exports.AVAILABLE_REGIONS = exports.DOMAINS = exports.DEFAULT_REGION = exports.IGNORE_FILE = exports.env = void 0;
+exports.Config = exports.StyleguideConfig = exports.AVAILABLE_REGIONS = exports.DOMAINS = exports.DEFAULT_REGION = exports.IGNORE_FILE = void 0;
 const fs = require("fs");
 const path = require("path");
 const js_yaml_1 = require("../js-yaml");
 const utils_1 = require("../utils");
 const oas_types_1 = require("../oas-types");
+const env_1 = require("../env");
 const utils_2 = require("./utils");
-// Alias environment here so this file can work in browser environments too.
-exports.env = typeof process !== 'undefined' ? process.env || {} : {};
 exports.IGNORE_FILE = '.redocly.lint-ignore.yaml';
 const IGNORE_BANNER = `# This file instructs Redocly's linter to ignore the rules contained for specific parts of your API.\n` +
     `# See https://redoc.ly/docs/cli/ for more information.\n`;
@@ -19,7 +18,7 @@ function getDomains() {
         eu: 'eu.redocly.com',
     };
     // FIXME: temporary fix for our lab environments
-    const domain = exports.env.REDOCLY_DOMAIN;
+    const domain = env_1.env.REDOCLY_DOMAIN;
     if (domain === null || domain === void 0 ? void 0 : domain.endsWith('.redocly.host')) {
         domains[domain.split('.')[0]] = domain;
     }
@@ -40,7 +39,7 @@ function getIgnoreFilePath(configFile) {
 }
 exports.DOMAINS = getDomains();
 exports.AVAILABLE_REGIONS = Object.keys(exports.DOMAINS);
-class LintConfig {
+class StyleguideConfig {
     constructor(rawConfig, configFile) {
         this.rawConfig = rawConfig;
         this.configFile = configFile;
@@ -125,10 +124,12 @@ class LintConfig {
                         if (!plugin.typeExtension.oas3)
                             continue;
                         extendedTypes = plugin.typeExtension.oas3(extendedTypes, version);
+                        break;
                     case oas_types_1.OasVersion.Version2:
                         if (!plugin.typeExtension.oas2)
                             continue;
                         extendedTypes = plugin.typeExtension.oas2(extendedTypes, version);
+                        break;
                     default:
                         throw new Error('Not implemented');
                 }
@@ -193,12 +194,14 @@ class LintConfig {
     getRulesForOasVersion(version) {
         switch (version) {
             case oas_types_1.OasMajorVersion.Version3:
+                // eslint-disable-next-line no-case-declarations
                 const oas3Rules = []; // default ruleset
                 this.plugins.forEach((p) => { var _a; return ((_a = p.preprocessors) === null || _a === void 0 ? void 0 : _a.oas3) && oas3Rules.push(p.preprocessors.oas3); });
                 this.plugins.forEach((p) => { var _a; return ((_a = p.rules) === null || _a === void 0 ? void 0 : _a.oas3) && oas3Rules.push(p.rules.oas3); });
                 this.plugins.forEach((p) => { var _a; return ((_a = p.decorators) === null || _a === void 0 ? void 0 : _a.oas3) && oas3Rules.push(p.decorators.oas3); });
                 return oas3Rules;
             case oas_types_1.OasMajorVersion.Version2:
+                // eslint-disable-next-line no-case-declarations
                 const oas2Rules = []; // default ruleset
                 this.plugins.forEach((p) => { var _a; return ((_a = p.preprocessors) === null || _a === void 0 ? void 0 : _a.oas2) && oas2Rules.push(p.preprocessors.oas2); });
                 this.plugins.forEach((p) => { var _a; return ((_a = p.rules) === null || _a === void 0 ? void 0 : _a.oas2) && oas2Rules.push(p.rules.oas2); });
@@ -234,13 +237,13 @@ class LintConfig {
         }
     }
 }
-exports.LintConfig = LintConfig;
+exports.StyleguideConfig = StyleguideConfig;
 class Config {
     constructor(rawConfig, configFile) {
         this.rawConfig = rawConfig;
         this.configFile = configFile;
         this.apis = rawConfig.apis || {};
-        this.lint = new LintConfig(rawConfig.lint || {}, configFile);
+        this.styleguide = new StyleguideConfig(rawConfig.styleguide || {}, configFile);
         this['features.openapi'] = rawConfig['features.openapi'] || {};
         this['features.mockServer'] = rawConfig['features.mockServer'] || {};
         this.resolve = utils_2.getResolveConfig(rawConfig === null || rawConfig === void 0 ? void 0 : rawConfig.resolve);

package/lib/config/load.d.ts

@@ -1,6 +1,13 @@
 import { Config } from './config';
 import type { RawConfig } from './types';
+import { RegionalTokenWithValidity } from '../redocly/redocly-client-types';
 export declare function loadConfig(configPath?: string | undefined, customExtends?: string[], processRawConfig?: (rawConfig: RawConfig) => void | Promise<void>): Promise<Config>;
 export declare const CONFIG_FILE_NAMES: string[];
 export declare function findConfig(dir?: string): string | undefined;
 export declare function getConfig(configPath?: string | undefined): Promise<RawConfig>;
+declare type CreateConfigOptions = {
+    extends?: string[];
+    tokens?: RegionalTokenWithValidity[];
+};
+export declare function createConfig(config: string | RawConfig, options?: CreateConfigOptions): Promise<Config>;
+export {};