@redocly/openapi-core 1.10.6 → 1.12.0

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # @redocly/openapi-core
 
+## 1.12.0
+
+### Patch Changes
+
+- Improved caching for external configuration resources.
+
+## 1.11.0
+
+### Minor Changes
+
+- Added support for a `github-actions` output format for the `lint` command to annotate reported problems on files when used in a GitHub Actions workflow.
+
+### Patch Changes
+
+- Fixed [`no-invalid-media-type-examples`](https://redocly.com/docs/cli/rules/no-invalid-media-type-examples/) rule `externalValue` example validation.
+- Process remove-unused-components rule transitively; components are now removed if they were previously referenced by a removed component.
+
 ## 1.10.6
 
 ### Patch Changes

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

@@ -9,7 +9,11 @@ export declare function resolveConfigFileAndRefs({ configPath, externalRefResolv
     document: Document;
     resolvedRefMap: ResolvedRefMap;
 }>;
-export declare function resolveConfig(rawConfig: RawConfig, configPath?: string): Promise<Config>;
+export declare function resolveConfig({ rawConfig, configPath, externalRefResolver, }: {
+    rawConfig: RawConfig;
+    configPath?: string;
+    externalRefResolver?: BaseResolver;
+}): Promise<Config>;
 export declare function resolvePlugins(plugins: (string | Plugin)[] | null, configPath?: string): Plugin[];
 export declare function resolveApis({ rawConfig, configPath, resolver, }: {
     rawConfig: RawConfig;

package/lib/config/config-resolvers.js

@@ -53,13 +53,13 @@ function resolveConfigFileAndRefs({ configPath, externalRefResolver = new resolv
     });
 }
 exports.resolveConfigFileAndRefs = resolveConfigFileAndRefs;
-function resolveConfig(rawConfig, configPath) {
+function resolveConfig({ rawConfig, configPath, externalRefResolver, }) {
     var _a, _b;
     return __awaiter(this, void 0, void 0, function* () {
         if ((_b = (_a = rawConfig.styleguide) === null || _a === void 0 ? void 0 : _a.extends) === null || _b === void 0 ? void 0 : _b.some(utils_3.isNotString)) {
             throw new Error(`Error configuration format not detected in extends value must contain strings`);
         }
-        const resolver = new resolve_1.BaseResolver((0, utils_2.getResolveConfig)(rawConfig.resolve));
+        const resolver = externalRefResolver !== null && externalRefResolver !== void 0 ? externalRefResolver : new resolve_1.BaseResolver((0, utils_2.getResolveConfig)(rawConfig.resolve));
         const apis = yield resolveApis({
             rawConfig,
             configPath,
@@ -263,8 +263,8 @@ exports.resolvePreset = resolvePreset;
 function loadExtendStyleguideConfig(filePath, resolver) {
     return __awaiter(this, void 0, void 0, function* () {
         try {
-            const fileSource = yield resolver.loadExternalRef(filePath);
-            const rawConfig = (0, utils_2.transformConfig)((0, utils_3.parseYaml)(fileSource.body));
+            const { parsed } = (yield resolver.resolveDocument(null, filePath));
+            const rawConfig = (0, utils_2.transformConfig)(parsed);
             if (!rawConfig.styleguide) {
                 throw new Error(`Styleguide configuration format not detected: "${filePath}"`);
             }

package/lib/config/load.d.ts

@@ -23,6 +23,7 @@ type CreateConfigOptions = {
     extends?: string[];
     tokens?: RegionalTokenWithValidity[];
     configPath?: string;
+    externalRefResolver?: BaseResolver;
 };
 export declare function createConfig(config: string | RawUniversalConfig, options?: CreateConfigOptions): Promise<Config>;
 export {};

package/lib/config/load.js

@@ -19,7 +19,7 @@ const config_1 = require("./config");
 const utils_2 = require("./utils");
 const config_resolvers_1 = require("./config-resolvers");
 const bundle_1 = require("../bundle");
-function addConfigMetadata({ rawConfig, customExtends, configPath, tokens, files, region, }) {
+function addConfigMetadata({ rawConfig, customExtends, configPath, tokens, files, region, externalRefResolver, }) {
     var _a;
     return __awaiter(this, void 0, void 0, function* () {
         if (customExtends !== undefined) {
@@ -56,7 +56,11 @@ function addConfigMetadata({ rawConfig, customExtends, configPath, tokens, files
                     : []));
             }
         }
-        return (0, config_resolvers_1.resolveConfig)(Object.assign(Object.assign({}, rawConfig), { files: files !== null && files !== void 0 ? files : rawConfig.files, region: region !== null && region !== void 0 ? region : rawConfig.region }), configPath);
+        return (0, config_resolvers_1.resolveConfig)({
+            rawConfig: Object.assign(Object.assign({}, rawConfig), { files: files !== null && files !== void 0 ? files : rawConfig.files, region: region !== null && region !== void 0 ? region : rawConfig.region }),
+            configPath,
+            externalRefResolver,
+        });
     });
 }
 function loadConfig(options = {}) {
@@ -72,6 +76,7 @@ function loadConfig(options = {}) {
             tokens,
             files,
             region,
+            externalRefResolver,
         });
     });
 }

package/lib/config/utils.js

@@ -114,7 +114,7 @@ function mergeExtends(rulesConfList) {
     };
     for (const rulesConf of rulesConfList) {
         if (rulesConf.extends) {
-            throw new Error(`'extends' is not supported in shared configs yet: ${JSON.stringify(rulesConf, null, 2)}.`);
+            throw new Error(`'extends' is not supported in shared configs yet:\n${JSON.stringify(rulesConf, null, 2)}`);
         }
         Object.assign(result.rules, rulesConf.rules);
         Object.assign(result.oas2Rules, rulesConf.oas2Rules);

package/lib/decorators/oas2/remove-unused-components.js

@@ -5,16 +5,38 @@ const utils_1 = require("../../utils");
 const RemoveUnusedComponents = () => {
     const components = new Map();
     function registerComponent(location, componentType, name) {
-        var _a;
+        var _a, _b;
         components.set(location.absolutePointer, {
-            used: ((_a = components.get(location.absolutePointer)) === null || _a === void 0 ? void 0 : _a.used) || false,
+            usedIn: (_b = (_a = components.get(location.absolutePointer)) === null || _a === void 0 ? void 0 : _a.usedIn) !== null && _b !== void 0 ? _b : [],
             componentType,
             name,
         });
     }
+    function removeUnusedComponents(root, removedPaths) {
+        const removedLengthStart = removedPaths.length;
+        for (const [path, { usedIn, name, componentType }] of components) {
+            const used = usedIn.some((location) => !removedPaths.some((removed) => 
+            // Check if the current location's absolute pointer starts with the 'removed' path
+            // and either its length matches exactly with 'removed' or the character after the 'removed' path is a '/'
+            location.absolutePointer.startsWith(removed) &&
+                (location.absolutePointer.length === removed.length ||
+                    location.absolutePointer[removed.length] === '/')));
+            if (!used && componentType) {
+                removedPaths.push(path);
+                delete root[componentType][name];
+                components.delete(path);
+                if ((0, utils_1.isEmptyObject)(root[componentType])) {
+                    delete root[componentType];
+                }
+            }
+        }
+        return removedPaths.length > removedLengthStart
+            ? removeUnusedComponents(root, removedPaths)
+            : removedPaths.length;
+    }
     return {
         ref: {
-            leave(ref, { type, resolve, key }) {
+            leave(ref, { location, type, resolve, key }) {
                 if (['Schema', 'Parameter', 'Response', 'SecurityScheme'].includes(type.name)) {
                     const resolvedRef = resolve(ref);
                     if (!resolvedRef.location)
@@ -22,31 +44,23 @@ const RemoveUnusedComponents = () => {
                     const [fileLocation, localPointer] = resolvedRef.location.absolutePointer.split('#', 2);
                     const componentLevelLocalPointer = localPointer.split('/').slice(0, 3).join('/');
                     const pointer = `${fileLocation}#${componentLevelLocalPointer}`;
-                    components.set(pointer, {
-                        used: true,
-                        name: key.toString(),
-                    });
+                    const registered = components.get(pointer);
+                    if (registered) {
+                        registered.usedIn.push(location);
+                    }
+                    else {
+                        components.set(pointer, {
+                            usedIn: [location],
+                            name: key.toString(),
+                        });
+                    }
                 }
             },
         },
         Root: {
             leave(root, ctx) {
                 const data = ctx.getVisitorData();
-                data.removedCount = 0;
-                const rootComponents = new Set();
-                components.forEach((usageInfo) => {
-                    const { used, name, componentType } = usageInfo;
-                    if (!used && componentType) {
-                        rootComponents.add(componentType);
-                        delete root[componentType][name];
-                        data.removedCount++;
-                    }
-                });
-                for (const component of rootComponents) {
-                    if ((0, utils_1.isEmptyObject)(root[component])) {
-                        delete root[component];
-                    }
-                }
+                data.removedCount = removeUnusedComponents(root, []);
             },
         },
         NamedSchemas: {

package/lib/decorators/oas3/remove-unused-components.js

@@ -5,16 +5,36 @@ const utils_1 = require("../../utils");
 const RemoveUnusedComponents = () => {
     const components = new Map();
     function registerComponent(location, componentType, name) {
-        var _a;
+        var _a, _b;
         components.set(location.absolutePointer, {
-            used: ((_a = components.get(location.absolutePointer)) === null || _a === void 0 ? void 0 : _a.used) || false,
+            usedIn: (_b = (_a = components.get(location.absolutePointer)) === null || _a === void 0 ? void 0 : _a.usedIn) !== null && _b !== void 0 ? _b : [],
             componentType,
             name,
         });
     }
+    function removeUnusedComponents(root, removedPaths) {
+        const removedLengthStart = removedPaths.length;
+        for (const [path, { usedIn, name, componentType }] of components) {
+            const used = usedIn.some((location) => !removedPaths.some((removed) => location.absolutePointer.startsWith(removed) &&
+                (location.absolutePointer.length === removed.length ||
+                    location.absolutePointer[removed.length] === '/')));
+            if (!used && componentType && root.components) {
+                removedPaths.push(path);
+                const componentChild = root.components[componentType];
+                delete componentChild[name];
+                components.delete(path);
+                if ((0, utils_1.isEmptyObject)(componentChild)) {
+                    delete root.components[componentType];
+                }
+            }
+        }
+        return removedPaths.length > removedLengthStart
+            ? removeUnusedComponents(root, removedPaths)
+            : removedPaths.length;
+    }
     return {
         ref: {
-            leave(ref, { type, resolve, key }) {
+            leave(ref, { location, type, resolve, key }) {
                 if (['Schema', 'Header', 'Parameter', 'Response', 'Example', 'RequestBody'].includes(type.name)) {
                     const resolvedRef = resolve(ref);
                     if (!resolvedRef.location)
@@ -22,28 +42,23 @@ const RemoveUnusedComponents = () => {
                     const [fileLocation, localPointer] = resolvedRef.location.absolutePointer.split('#', 2);
                     const componentLevelLocalPointer = localPointer.split('/').slice(0, 4).join('/');
                     const pointer = `${fileLocation}#${componentLevelLocalPointer}`;
-                    components.set(pointer, {
-                        used: true,
-                        name: key.toString(),
-                    });
+                    const registered = components.get(pointer);
+                    if (registered) {
+                        registered.usedIn.push(location);
+                    }
+                    else {
+                        components.set(pointer, {
+                            usedIn: [location],
+                            name: key.toString(),
+                        });
+                    }
                 }
             },
         },
         Root: {
             leave(root, ctx) {
                 const data = ctx.getVisitorData();
-                data.removedCount = 0;
-                components.forEach((usageInfo) => {
-                    const { used, componentType, name } = usageInfo;
-                    if (!used && componentType && root.components) {
-                        const componentChild = root.components[componentType];
-                        delete componentChild[name];
-                        data.removedCount++;
-                        if ((0, utils_1.isEmptyObject)(componentChild)) {
-                            delete root.components[componentType];
-                        }
-                    }
-                });
+                data.removedCount = removeUnusedComponents(root, []);
                 if ((0, utils_1.isEmptyObject)(root.components)) {
                     delete root.components;
                 }

package/lib/format/format.d.ts

@@ -4,7 +4,7 @@ export type Totals = {
     warnings: number;
     ignored: number;
 };
-export type OutputFormat = 'codeframe' | 'stylish' | 'json' | 'checkstyle' | 'codeclimate' | 'summary';
+export type OutputFormat = 'codeframe' | 'stylish' | 'json' | 'checkstyle' | 'codeclimate' | 'summary' | 'github-actions' | 'markdown';
 export declare function getTotals(problems: (NormalizedProblem & {
     ignored?: boolean;
 })[]): Totals;

package/lib/format/format.js

@@ -103,6 +103,8 @@ function formatProblems(problems, opts) {
         case 'summary':
             formatSummary(problems);
             break;
+        case 'github-actions':
+            outputForGithubActions(problems, cwd);
     }
     if (totalProblems - ignoredProblems > maxProblems) {
         logger_1.logger.info(`< ... ${totalProblems - maxProblems} more problems hidden > ${logger_1.colorize.gray('increase with `--max-problems N`')}\n`);
@@ -266,3 +268,58 @@ function xmlEscape(s) {
         }
     });
 }
+function outputForGithubActions(problems, cwd) {
+    var _a, _b;
+    for (const problem of problems) {
+        for (const location of problem.location.map(codeframes_1.getLineColLocation)) {
+            let command;
+            switch (problem.severity) {
+                case 'error':
+                    command = 'error';
+                    break;
+                case 'warn':
+                    command = 'warning';
+                    break;
+            }
+            const suggest = formatDidYouMean(problem);
+            const message = suggest !== '' ? problem.message + '\n\n' + suggest : problem.message;
+            const properties = {
+                title: problem.ruleId,
+                file: (0, ref_utils_1.isAbsoluteUrl)(location.source.absoluteRef)
+                    ? location.source.absoluteRef
+                    : path.relative(cwd, location.source.absoluteRef),
+                line: location.start.line,
+                col: location.start.col,
+                endLine: (_a = location.end) === null || _a === void 0 ? void 0 : _a.line,
+                endColumn: (_b = location.end) === null || _b === void 0 ? void 0 : _b.col,
+            };
+            output_1.output.write(`::${command} ${formatProperties(properties)}::${escapeMessage(message)}\n`);
+        }
+    }
+    function formatProperties(props) {
+        return Object.entries(props)
+            .filter(([, v]) => v !== null && v !== undefined)
+            .map(([k, v]) => `${k}=${escapeProperty(v)}`)
+            .join(',');
+    }
+    function toString(v) {
+        if (v === null || v === undefined) {
+            return '';
+        }
+        else if (typeof v === 'string' || v instanceof String) {
+            return v;
+        }
+        return JSON.stringify(v);
+    }
+    function escapeMessage(v) {
+        return toString(v).replace(/%/g, '%25').replace(/\r/g, '%0D').replace(/\n/g, '%0A');
+    }
+    function escapeProperty(v) {
+        return toString(v)
+            .replace(/%/g, '%25')
+            .replace(/\r/g, '%0D')
+            .replace(/\n/g, '%0A')
+            .replace(/:/g, '%3A')
+            .replace(/,/g, '%2C');
+    }
+}

package/lib/index.d.ts

@@ -1,4 +1,4 @@
-export { BundleOutputFormat, readFileFromUrl, slash, doesYamlFileExist, isTruthy } from './utils';
+export { BundleOutputFormat, readFileFromUrl, slash, doesYamlFileExist, isTruthy, pause, } from './utils';
 export { Oas3_1Types } from './types/oas3_1';
 export { Oas3Types } from './types/oas3';
 export { Oas2Types } from './types/oas2';

package/lib/index.js

@@ -1,12 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.lintConfig = exports.lintFromString = exports.lintDocument = exports.validate = exports.lint = exports.getTotals = exports.formatProblems = exports.getLineColLocation = exports.getAstNodeByPointer = exports.walkDocument = exports.normalizeVisitors = exports.getTypes = exports.detectSpec = exports.SpecVersion = exports.getMajorSpecVersion = exports.SpecMajorVersion = exports.isAbsoluteUrl = exports.isRef = exports.unescapePointer = exports.stringifyYaml = exports.parseYaml = exports.makeDocumentFromString = exports.YamlParseError = exports.ResolveError = exports.resolveDocument = exports.BaseResolver = exports.Source = exports.isRedoclyRegistryURL = exports.RedoclyClient = exports.createConfig = exports.CONFIG_FILE_NAMES = exports.findConfig = exports.getConfig = exports.loadConfig = exports.transformConfig = exports.getMergedConfig = exports.IGNORE_FILE = exports.StyleguideConfig = exports.Config = exports.Stats = exports.normalizeTypes = exports.ConfigTypes = exports.AsyncApi2Types = exports.Oas2Types = exports.Oas3Types = exports.Oas3_1Types = exports.isTruthy = exports.doesYamlFileExist = exports.slash = exports.readFileFromUrl = void 0;
-exports.bundleFromString = exports.mapTypeToComponent = exports.bundleDocument = exports.bundle = void 0;
+exports.lintFromString = exports.lintDocument = exports.validate = exports.lint = exports.getTotals = exports.formatProblems = exports.getLineColLocation = exports.getAstNodeByPointer = exports.walkDocument = exports.normalizeVisitors = exports.getTypes = exports.detectSpec = exports.SpecVersion = exports.getMajorSpecVersion = exports.SpecMajorVersion = exports.isAbsoluteUrl = exports.isRef = exports.unescapePointer = exports.stringifyYaml = exports.parseYaml = exports.makeDocumentFromString = exports.YamlParseError = exports.ResolveError = exports.resolveDocument = exports.BaseResolver = exports.Source = exports.isRedoclyRegistryURL = exports.RedoclyClient = exports.createConfig = exports.CONFIG_FILE_NAMES = exports.findConfig = exports.getConfig = exports.loadConfig = exports.transformConfig = exports.getMergedConfig = exports.IGNORE_FILE = exports.StyleguideConfig = exports.Config = exports.Stats = exports.normalizeTypes = exports.ConfigTypes = exports.AsyncApi2Types = exports.Oas2Types = exports.Oas3Types = exports.Oas3_1Types = exports.pause = exports.isTruthy = exports.doesYamlFileExist = exports.slash = exports.readFileFromUrl = void 0;
+exports.bundleFromString = exports.mapTypeToComponent = exports.bundleDocument = exports.bundle = exports.lintConfig = void 0;
 var utils_1 = require("./utils");
 Object.defineProperty(exports, "readFileFromUrl", { enumerable: true, get: function () { return utils_1.readFileFromUrl; } });
 Object.defineProperty(exports, "slash", { enumerable: true, get: function () { return utils_1.slash; } });
 Object.defineProperty(exports, "doesYamlFileExist", { enumerable: true, get: function () { return utils_1.doesYamlFileExist; } });
 Object.defineProperty(exports, "isTruthy", { enumerable: true, get: function () { return utils_1.isTruthy; } });
+Object.defineProperty(exports, "pause", { enumerable: true, get: function () { return utils_1.pause; } });
 var oas3_1_1 = require("./types/oas3_1");
 Object.defineProperty(exports, "Oas3_1Types", { enumerable: true, get: function () { return oas3_1_1.Oas3_1Types; } });
 var oas3_1 = require("./types/oas3");

package/lib/rules/common/assertions/utils.js

@@ -32,10 +32,10 @@ function getAssertsToApply(assertion) {
     const shouldRunOnKeys = assertsToApply.find((assert) => assert.runsOnKeys && !assert.runsOnValues);
     const shouldRunOnValues = assertsToApply.find((assert) => assert.runsOnValues && !assert.runsOnKeys);
     if (shouldRunOnValues && !assertion.subject.property) {
-        throw new Error(`${shouldRunOnValues.name} can't be used on all keys. Please provide a single property`);
+        throw new Error(`The '${shouldRunOnValues.name}' assertion can't be used on all keys. Please provide a single property.`);
     }
     if (shouldRunOnKeys && assertion.subject.property) {
-        throw new Error(`${shouldRunOnKeys.name} can't be used on a single property. Please use 'property'.`);
+        throw new Error(`The '${shouldRunOnKeys.name}' assertion can't be used on properties. Please remove the 'property' key.`);
     }
     return assertsToApply;
 }

package/lib/rules/oas3/no-invalid-media-type-examples.js

@@ -28,6 +28,9 @@ const ValidContentExamples = (opts) => {
                         location = isMultiple ? resolved.location.child('value') : resolved.location;
                         example = resolved.node;
                     }
+                    if (isMultiple && typeof example.value === 'undefined') {
+                        return;
+                    }
                     (0, utils_1.validateExample)(isMultiple ? example.value : example, mediaType.schema, location, ctx, allowAdditionalProperties);
                 }
             },

package/lib/utils.d.ts

@@ -50,3 +50,4 @@ export declare function identity<T>(value: T): T;
 export declare function keysOf<T>(obj: T): (keyof T)[];
 export declare function pickDefined<T extends Record<string, unknown>>(obj?: T): Record<string, unknown> | undefined;
 export declare function nextTick(): void;
+export declare function pause(ms: number): Promise<void>;

package/lib/utils.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.nextTick = exports.pickDefined = exports.keysOf = exports.identity = exports.isTruthy = exports.showErrorForDeprecatedField = exports.showWarningForDeprecatedField = exports.doesYamlFileExist = exports.isCustomRuleId = exports.getMatchingStatusCodeRange = exports.assignExisting = exports.isNotString = exports.isString = exports.isNotEmptyObject = exports.slash = exports.isPathParameter = exports.yamlAndJsonSyncReader = exports.readFileAsStringSync = exports.isSingular = exports.validateMimeTypeOAS3 = exports.validateMimeType = exports.splitCamelCaseIntoWords = exports.omitObjectProps = exports.pickObjectProps = exports.readFileFromUrl = exports.isEmptyArray = exports.isEmptyObject = exports.isPlainObject = exports.isDefined = exports.loadYaml = exports.popStack = exports.pushStack = exports.stringifyYaml = exports.parseYaml = void 0;
+exports.pause = exports.nextTick = exports.pickDefined = exports.keysOf = exports.identity = exports.isTruthy = exports.showErrorForDeprecatedField = exports.showWarningForDeprecatedField = exports.doesYamlFileExist = exports.isCustomRuleId = exports.getMatchingStatusCodeRange = exports.assignExisting = exports.isNotString = exports.isString = exports.isNotEmptyObject = exports.slash = exports.isPathParameter = exports.yamlAndJsonSyncReader = exports.readFileAsStringSync = exports.isSingular = exports.validateMimeTypeOAS3 = exports.validateMimeType = exports.splitCamelCaseIntoWords = exports.omitObjectProps = exports.pickObjectProps = exports.readFileFromUrl = exports.isEmptyArray = exports.isEmptyObject = exports.isPlainObject = exports.isDefined = exports.loadYaml = exports.popStack = exports.pushStack = exports.stringifyYaml = exports.parseYaml = void 0;
 const fs = require("fs");
 const path_1 = require("path");
 const minimatch = require("minimatch");
@@ -236,6 +236,12 @@ function nextTick() {
     });
 }
 exports.nextTick = nextTick;
+function pause(ms) {
+    return __awaiter(this, void 0, void 0, function* () {
+        return new Promise((resolve) => setTimeout(resolve, ms));
+    });
+}
+exports.pause = pause;
 function getUpdatedFieldName(updatedField, updatedObject) {
     return `${typeof updatedObject !== 'undefined' ? `${updatedObject}.` : ''}${updatedField}`;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redocly/openapi-core",
-  "version": "1.10.6",
+  "version": "1.12.0",
   "description": "",
   "main": "lib/index.js",
   "engines": {
@@ -35,7 +35,7 @@
   ],
   "dependencies": {
     "@redocly/ajv": "^8.11.0",
-    "@redocly/config": "^0.1.4",
+    "@redocly/config": "^0.2.0",
     "colorette": "^1.2.0",
     "js-levenshtein": "^1.1.6",
     "js-yaml": "^4.1.0",

package/src/__tests__/format.test.ts

@@ -1,6 +1,8 @@
 import { outdent } from 'outdent';
 
 import { formatProblems, getTotals } from '../format/format';
+import { LocationObject, NormalizedProblem } from '../walk';
+import { Source } from '../resolve';
 
 describe('format', () => {
   function replaceColors(log: string) {
@@ -40,6 +42,10 @@ describe('format', () => {
       output += str;
       return true;
     });
+    jest.spyOn(process.stdout, 'write').mockImplementation((str: string | Uint8Array) => {
+      output += str;
+      return true;
+    });
   });
 
   it('should correctly format summary output', () => {
@@ -73,4 +79,32 @@ describe('format', () => {
       "
     `);
   });
+
+  it('should format problems using github-actions', () => {
+    const problems = [
+      {
+        ruleId: 'spec',
+        message: 'message',
+        severity: 'error' as const,
+        location: [
+          {
+            source: { absoluteRef: 'openapi.yaml' } as Source,
+            start: { line: 1, col: 2 },
+            end: { line: 3, col: 4 },
+          } as LocationObject,
+        ],
+        suggest: [],
+      },
+    ];
+
+    formatProblems(problems, {
+      format: 'github-actions',
+      version: '1.0.0',
+      totals: getTotals(problems),
+    });
+
+    expect(output).toEqual(
+      '::error title=spec,file=openapi.yaml,line=1,col=2,endLine=3,endColumn=4::message\n'
+    );
+  });
 });

package/src/bundle.ts

@@ -232,7 +232,7 @@ export async function bundleDocument(opts: {
 
   walkDocument({
     document,
-    rootType: types.Root as NormalizedNodeType,
+    rootType: types.Root,
     normalizedVisitors: bundleVisitor,
     resolvedRefMap,
     ctx,

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

@@ -390,7 +390,7 @@ describe('resolveConfig', () => {
       },
     };
 
-    const { apis } = await resolveConfig(rawConfig, configPath);
+    const { apis } = await resolveConfig({ rawConfig, configPath });
     //@ts-ignore
     expect(apis['petstore'].styleguide.plugins.length).toEqual(1);
     //@ts-ignore
@@ -427,7 +427,7 @@ describe('resolveConfig', () => {
       },
     };
 
-    const { apis } = await resolveConfig(rawConfig, configPath);
+    const { apis } = await resolveConfig({ rawConfig, configPath });
     expect(apis['petstore'].styleguide.rules).toBeDefined();
     expect(Object.keys(apis['petstore'].styleguide.rules || {}).length).toEqual(7);
     expect(apis['petstore'].styleguide.rules?.['operation-2xx-response']).toEqual('warn');
@@ -469,7 +469,7 @@ describe('resolveConfig', () => {
       },
     };
 
-    const { apis } = await resolveConfig(rawConfig, configPath);
+    const { apis } = await resolveConfig({ rawConfig, configPath });
     expect(apis['petstore'].styleguide.rules).toBeDefined();
     expect(apis['petstore'].styleguide.rules?.['operation-2xx-response']).toEqual('warn');
     expect(apis['petstore'].styleguide.rules?.['operation-4xx-response']).toEqual('error');
@@ -513,7 +513,7 @@ describe('resolveConfig', () => {
       },
     };
 
-    const { apis } = await resolveConfig(rawConfig, configPath);
+    const { apis } = await resolveConfig({ rawConfig, configPath });
     expect(apis['petstore'].styleguide.rules).toBeDefined();
     expect(apis['petstore'].styleguide.rules?.['operation-2xx-response']).toEqual('warn'); // from minimal ruleset
   });

package/src/config/__tests__/fixtures/load-external.yaml

@@ -0,0 +1,2 @@
+extends:
+  - https://raw.githubusercontent.com/Redocly/redocly-cli-cookbook/main/rulesets/spec-compliant/redocly.yaml

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

@@ -5,6 +5,7 @@ import { lintConfig } from '../../lint';
 import { replaceSourceWithRef } from '../../../__tests__/utils';
 import type { RuleConfig, FlatRawConfig } from './../types';
 import type { NormalizedProblem } from '../../walk';
+import { BaseResolver } from '../../resolve';
 
 const fs = require('fs');
 const path = require('path');
@@ -58,6 +59,19 @@ describe('loadConfig', () => {
     });
     expect(mockFn).toHaveBeenCalled();
   });
+
+  it('should call externalRefResolver if such passed', async () => {
+    const externalRefResolver = new BaseResolver();
+    const resolverSpy = jest.spyOn(externalRefResolver, 'resolveDocument');
+    await loadConfig({
+      configPath: path.join(__dirname, './fixtures/load-external.yaml'),
+      externalRefResolver: externalRefResolver as any,
+    });
+    expect(resolverSpy).toHaveBeenCalledWith(
+      null,
+      'https://raw.githubusercontent.com/Redocly/redocly-cli-cookbook/main/rulesets/spec-compliant/redocly.yaml'
+    );
+  });
 });
 
 describe('findConfig', () => {

package/src/config/config-resolvers.ts

@@ -12,7 +12,7 @@ import {
   transformConfig,
 } from './utils';
 import { isBrowser } from '../env';
-import { isNotString, isString, isDefined, parseYaml, keysOf } from '../utils';
+import { isNotString, isString, isDefined, keysOf } from '../utils';
 import { Config } from './config';
 import { colorize, logger } from '../logger';
 import { asserts, buildAssertCustomFunction } from '../rules/common/assertions/asserts';
@@ -63,14 +63,22 @@ export async function resolveConfigFileAndRefs({
   return { document, resolvedRefMap };
 }
 
-export async function resolveConfig(rawConfig: RawConfig, configPath?: string): Promise<Config> {
+export async function resolveConfig({
+  rawConfig,
+  configPath,
+  externalRefResolver,
+}: {
+  rawConfig: RawConfig;
+  configPath?: string;
+  externalRefResolver?: BaseResolver;
+}): Promise<Config> {
   if (rawConfig.styleguide?.extends?.some(isNotString)) {
     throw new Error(
       `Error configuration format not detected in extends value must contain strings`
     );
   }
 
-  const resolver = new BaseResolver(getResolveConfig(rawConfig.resolve));
+  const resolver = externalRefResolver ?? new BaseResolver(getResolveConfig(rawConfig.resolve));
 
   const apis = await resolveApis({
     rawConfig,
@@ -388,10 +396,8 @@ async function loadExtendStyleguideConfig(
   resolver: BaseResolver
 ): Promise<StyleguideRawConfig> {
   try {
-    const fileSource = await resolver.loadExternalRef(filePath);
-    const rawConfig = transformConfig(
-      parseYaml(fileSource.body) as RawConfig & DeprecatedInRawConfig
-    );
+    const { parsed } = (await resolver.resolveDocument(null, filePath)) as Document;
+    const rawConfig = transformConfig(parsed as RawConfig & DeprecatedInRawConfig);
     if (!rawConfig.styleguide) {
       throw new Error(`Styleguide configuration format not detected: "${filePath}"`);
     }