@redocly/openapi-core 1.0.0-beta.123 → 1.0.0-beta.125

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

@@ -0,0 +1,144 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`generation ignore object should generate config with absoluteUri for ignore 1`] = `
+StyleguideConfig {
+  "_usedRules": Set {},
+  "_usedVersions": Set {},
+  "configFile": undefined,
+  "decorators": Object {
+    "oas2": Object {
+      "oas2": Object {},
+      "oas3_0": Object {},
+      "oas3_1": Object {},
+    },
+    "oas3_0": Object {
+      "oas2": Object {},
+      "oas3_0": Object {},
+      "oas3_1": Object {},
+    },
+    "oas3_1": Object {
+      "oas2": Object {},
+      "oas3_0": Object {},
+      "oas3_1": Object {},
+    },
+  },
+  "doNotResolveExamples": false,
+  "extendPaths": Array [],
+  "ignore": Object {
+    "https://some-path.yaml": Object {
+      "no-unused-components": Set {
+        "#/components/schemas/Foo",
+      },
+    },
+    "some-path/openapi.yaml": Object {
+      "no-unused-components": Set {
+        "#/components/schemas/Foo",
+      },
+    },
+  },
+  "pluginPaths": Array [],
+  "plugins": Array [],
+  "preprocessors": Object {
+    "oas2": Object {
+      "oas2": Object {},
+      "oas3_0": Object {},
+      "oas3_1": Object {},
+    },
+    "oas3_0": Object {
+      "oas2": Object {},
+      "oas3_0": Object {},
+      "oas3_1": Object {},
+    },
+    "oas3_1": Object {
+      "oas2": Object {},
+      "oas3_0": Object {},
+      "oas3_1": Object {},
+    },
+  },
+  "rawConfig": Object {
+    "_usedRules": Set {},
+    "_usedVersions": Set {},
+    "configFile": "redocly.yaml",
+    "decorators": Object {
+      "oas2": Object {},
+      "oas3_0": Object {},
+      "oas3_1": Object {},
+    },
+    "doNotResolveExamples": false,
+    "ignore": Object {},
+    "plugins": Array [],
+    "preprocessors": Object {
+      "oas2": Object {},
+      "oas3_0": Object {},
+      "oas3_1": Object {},
+    },
+    "rawConfig": Object {
+      "plugins": Array [],
+      "rules": Object {
+        "no-empty-servers": "error",
+        "operation-summary": "error",
+      },
+    },
+    "recommendedFallback": false,
+    "rules": Object {
+      "oas2": Object {
+        "no-empty-servers": "error",
+        "operation-summary": "error",
+      },
+      "oas3_0": Object {
+        "no-empty-servers": "error",
+        "operation-summary": "error",
+      },
+      "oas3_1": Object {
+        "no-empty-servers": "error",
+        "operation-summary": "error",
+      },
+    },
+  },
+  "recommendedFallback": false,
+  "rules": Object {
+    "oas2": Object {
+      "oas2": Object {
+        "no-empty-servers": "error",
+        "operation-summary": "error",
+      },
+      "oas3_0": Object {
+        "no-empty-servers": "error",
+        "operation-summary": "error",
+      },
+      "oas3_1": Object {
+        "no-empty-servers": "error",
+        "operation-summary": "error",
+      },
+    },
+    "oas3_0": Object {
+      "oas2": Object {
+        "no-empty-servers": "error",
+        "operation-summary": "error",
+      },
+      "oas3_0": Object {
+        "no-empty-servers": "error",
+        "operation-summary": "error",
+      },
+      "oas3_1": Object {
+        "no-empty-servers": "error",
+        "operation-summary": "error",
+      },
+    },
+    "oas3_1": Object {
+      "oas2": Object {
+        "no-empty-servers": "error",
+        "operation-summary": "error",
+      },
+      "oas3_0": Object {
+        "no-empty-servers": "error",
+        "operation-summary": "error",
+      },
+      "oas3_1": Object {
+        "no-empty-servers": "error",
+        "operation-summary": "error",
+      },
+    },
+  },
+}
+`;

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

@@ -1,6 +1,17 @@
 import { OasVersion } from '../../oas-types';
 import { Config, StyleguideConfig } from '../config';
 import { getMergedConfig } from '../utils';
+import { doesYamlFileExist } from '../../utils';
+import { parseYaml } from '../../js-yaml';
+import { readFileSync } from 'fs';
+import { ignoredFileStub } from './fixtures/ingore-file';
+import * as path from 'path';
+import { NormalizedProblem } from '../../walk';
+import { Source } from '../../resolve';
+
+jest.mock('../../utils');
+jest.mock('../../js-yaml');
+jest.mock('fs');
 
 const testConfig: Config = {
   rawConfig: {
@@ -280,3 +291,17 @@ describe('StyleguideConfig.extendTypes', () => {
     );
   });
 });
+
+describe('generation ignore object', () => {
+  it('should generate config with absoluteUri for ignore', () => {
+    (readFileSync as jest.Mock<any, any>).mockImplementationOnce(() => '');
+    (parseYaml as jest.Mock<any, any>).mockImplementationOnce(() => ignoredFileStub);
+    (doesYamlFileExist as jest.Mock<any, any>).mockImplementationOnce(() => true);
+
+    jest.spyOn(path, 'resolve').mockImplementationOnce((_, filename) => `some-path/${filename}`);
+
+    const styleguideConfig = new StyleguideConfig(testConfig.styleguide);
+
+    expect(styleguideConfig).toMatchSnapshot();
+  });
+});

package/src/config/__tests__/fixtures/ingore-file.ts

@@ -0,0 +1,8 @@
+export const ignoredFileStub = {
+  'openapi.yaml': {
+    'no-unused-components': ['#/components/schemas/Foo'],
+  },
+  'https://some-path.yaml': {
+    'no-unused-components': ['#/components/schemas/Foo'],
+  },
+};

package/src/config/config.ts

@@ -21,6 +21,7 @@ import type {
   ThemeRawConfig,
 } from './types';
 import { getResolveConfig } from './utils';
+import { isAbsoluteUrl } from '../ref-utils';
 
 export const IGNORE_FILE = '.redocly.lint-ignore.yaml';
 const IGNORE_BANNER =
@@ -115,11 +116,17 @@ export class StyleguideConfig {
 
     // resolve ignore paths
     for (const fileName of Object.keys(this.ignore)) {
-      this.ignore[path.resolve(path.dirname(ignoreFile), fileName)] = this.ignore[fileName];
+      this.ignore[
+        isAbsoluteUrl(fileName) ? fileName : path.resolve(path.dirname(ignoreFile), fileName)
+      ] = this.ignore[fileName];
+
       for (const ruleId of Object.keys(this.ignore[fileName])) {
         this.ignore[fileName][ruleId] = new Set(this.ignore[fileName][ruleId]);
       }
-      delete this.ignore[fileName];
+
+      if (!isAbsoluteUrl(fileName)) {
+        delete this.ignore[fileName];
+      }
     }
   }
 
@@ -128,8 +135,11 @@ export class StyleguideConfig {
     const ignoreFile = path.join(dir, IGNORE_FILE);
     const mapped: Record<string, any> = {};
     for (const absFileName of Object.keys(this.ignore)) {
-      const ignoredRules = (mapped[slash(path.relative(dir, absFileName))] =
-        this.ignore[absFileName]);
+      const mappedDefinitionName = isAbsoluteUrl(absFileName)
+        ? absFileName
+        : slash(path.relative(dir, absFileName));
+      const ignoredRules = (mapped[mappedDefinitionName] = this.ignore[absFileName]);
+
       for (const ruleId of Object.keys(ignoredRules)) {
         ignoredRules[ruleId] = Array.from(ignoredRules[ruleId]) as any;
       }

package/src/config/types.ts

@@ -1,4 +1,4 @@
-import type { ProblemSeverity } from '../walk';
+import type { ProblemSeverity, UserContext } from '../walk';
 import type {
   Oas3PreprocessorsSet,
   OasMajorVersion,
@@ -11,6 +11,7 @@ import type {
 } from '../oas-types';
 import type { NodeType } from '../types';
 import { Location } from '../ref-utils';
+import { SkipFunctionContext } from '../visitors';
 
 export type RuleSeverity = ProblemSeverity | 'off';
 
@@ -86,6 +87,8 @@ export type CustomRulesConfig = {
   oas2?: Oas2RuleSet;
 };
 
+export type AssertionContext = Partial<UserContext> & SkipFunctionContext & { node: any };
+
 export type AssertResult = { message?: string; location?: Location };
 export type CustomFunction = (
   value: any,

package/src/format/format.ts

@@ -7,6 +7,7 @@ const coreVersion = require('../../package.json').version;
 import { NormalizedProblem, ProblemSeverity, LineColLocationObject, LocationObject } from '../walk';
 import { getCodeframe, getLineColLocation } from './codeframes';
 import { env } from '../env';
+import { isAbsoluteUrl } from '../ref-utils';
 
 export type Totals = {
   errors: number;
@@ -120,7 +121,7 @@ export function formatProblems(
       for (const [file, { ruleIdPad, locationPad: positionPad, fileProblems }] of Object.entries(
         groupedByFile
       )) {
-        logger.info(`${colorize.blue(path.relative(cwd, file))}:\n`);
+        logger.info(`${colorize.blue(isAbsoluteUrl(file) ? file : path.relative(cwd, file))}:\n`);
 
         for (let i = 0; i < fileProblems.length; i++) {
           const problem = fileProblems[i];
@@ -138,7 +139,9 @@ export function formatProblems(
       output.write('<checkstyle version="4.3">\n');
 
       for (const [file, { fileProblems }] of Object.entries(groupedByFile)) {
-        output.write(`<file name="${xmlEscape(path.relative(cwd, file))}">\n`);
+        output.write(
+          `<file name="${xmlEscape(isAbsoluteUrl(file) ? file : path.relative(cwd, file))}">\n`
+        );
         fileProblems.forEach(formatCheckstyle);
         output.write(`</file>\n`);
       }
@@ -169,7 +172,9 @@ export function formatProblems(
       return {
         description: p.message,
         location: {
-          path: path.relative(cwd, location.source.absoluteRef),
+          path: isAbsoluteUrl(location.source.absoluteRef)
+            ? location.source.absoluteRef
+            : path.relative(cwd, location.source.absoluteRef),
           lines: {
             begin: lineCol.start.line,
           },
@@ -191,14 +196,18 @@ export function formatProblems(
           location: p.location.map((location: any) => ({
             ...location,
             source: {
-              ref: path.relative(cwd, location.source.absoluteRef),
+              ref: isAbsoluteUrl(location.source.absoluteRef)
+                ? location.source.absoluteRef
+                : path.relative(cwd, location.source.absoluteRef),
             },
           })),
           from: p.from
             ? {
                 ...p.from,
                 source: {
-                  ref: path.relative(cwd, p.from?.source.absoluteRef || cwd),
+                  ref: isAbsoluteUrl(p.from?.source.absoluteRef)
+                    ? p.from?.source.absoluteRef
+                    : path.relative(cwd, p.from?.source.absoluteRef || cwd),
                 },
               }
             : undefined,
@@ -226,7 +235,9 @@ export function formatProblems(
   function formatCodeframe(problem: NormalizedProblem, idx: number) {
     const bgColor = getBgColor(problem);
     const location = problem.location[0]; // TODO: support multiple locations
-    const relativePath = path.relative(cwd, location.source.absoluteRef);
+    const relativePath = isAbsoluteUrl(location.source.absoluteRef)
+      ? location.source.absoluteRef
+      : path.relative(cwd, location.source.absoluteRef);
     const loc = getLineColLocation(location);
     const atPointer = location.pointer ? colorize.gray(`at ${location.pointer}`) : '';
     const fileWithLoc = `${relativePath}:${loc.start.line}:${loc.start.col}`;