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

package/lib/walk.js

@@ -32,6 +32,26 @@ function walkDocument(opts) {
     walkNode(document.parsed, rootType, new ref_utils_1.Location(document.source, '#/'), undefined, '');
     function walkNode(node, type, location, parent, key) {
         var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
+        const resolve = (ref, from = currentLocation.source.absoluteRef) => {
+            if (!ref_utils_1.isRef(ref))
+                return { location, node: ref };
+            const refId = resolve_1.makeRefId(from, ref.$ref);
+            const resolvedRef = resolvedRefMap.get(refId);
+            if (!resolvedRef) {
+                return {
+                    location: undefined,
+                    node: undefined,
+                };
+            }
+            const { resolved, node, document, nodePointer, error } = resolvedRef;
+            const newLocation = resolved
+                ? new ref_utils_1.Location(document.source, nodePointer)
+                : error instanceof resolve_1.YamlParseError
+                    ? new ref_utils_1.Location(error.source, '')
+                    : undefined;
+            return { location: newLocation, node, error };
+        };
+        const rawLocation = location;
         let currentLocation = location;
         const { node: resolvedNode, location: resolvedLocation, error } = resolve(node);
         const enteredContexts = new Set();
@@ -44,13 +64,15 @@ function walkDocument(opts) {
                     visitor(node, {
                         report,
                         resolve,
+                        rawNode: node,
+                        rawLocation,
                         location,
                         type,
                         parent,
                         key,
                         parentLocations: {},
                         oasVersion: ctx.oasVersion,
-                        getVisitorData: getVisitorDataFn.bind(undefined, ruleId)
+                        getVisitorData: getVisitorDataFn.bind(undefined, ruleId),
                     }, { node: resolvedNode, location: resolvedLocation, error });
                     if ((resolvedLocation === null || resolvedLocation === void 0 ? void 0 : resolvedLocation.source.absoluteRef) && ctx.refTypes) {
                         ctx.refTypes.set(resolvedLocation === null || resolvedLocation === void 0 ? void 0 : resolvedLocation.source.absoluteRef, type);
@@ -101,7 +123,7 @@ function walkDocument(opts) {
                         if (!activatedOn.skipped) {
                             visitedBySome = true;
                             enteredContexts.add(context);
-                            const { ignoreNextVisitorsOnNode } = visitWithContext(visit, resolvedNode, context, ruleId, severity);
+                            const { ignoreNextVisitorsOnNode } = visitWithContext(visit, resolvedNode, node, context, ruleId, severity);
                             if (ignoreNextVisitorsOnNode)
                                 break;
                         }
@@ -173,7 +195,7 @@ function walkDocument(opts) {
             }
             for (const { context, visit, ruleId, severity } of currentLeaveVisitors) {
                 if (!context.isSkippedLevel && enteredContexts.has(context)) {
-                    visitWithContext(visit, resolvedNode, context, ruleId, severity);
+                    visitWithContext(visit, resolvedNode, node, context, ruleId, severity);
                 }
             }
         }
@@ -186,54 +208,41 @@ function walkDocument(opts) {
                     visitor(node, {
                         report,
                         resolve,
+                        rawNode: node,
+                        rawLocation,
                         location,
                         type,
                         parent,
                         key,
                         parentLocations: {},
                         oasVersion: ctx.oasVersion,
-                        getVisitorData: getVisitorDataFn.bind(undefined, ruleId)
+                        getVisitorData: getVisitorDataFn.bind(undefined, ruleId),
                     }, { node: resolvedNode, location: resolvedLocation, error });
                 }
             }
         }
         // returns true ignores all the next visitors on the specific node
-        function visitWithContext(visit, node, context, ruleId, severity) {
+        function visitWithContext(visit, resolvedNode, node, context, ruleId, severity) {
             const report = reportFn.bind(undefined, ruleId, severity);
             let ignoreNextVisitorsOnNode = false;
-            visit(node, {
+            visit(resolvedNode, {
                 report,
                 resolve,
+                rawNode: node,
                 location: currentLocation,
+                rawLocation,
                 type,
                 parent,
                 key,
                 parentLocations: collectParentsLocations(context),
                 oasVersion: ctx.oasVersion,
-                ignoreNextVisitorsOnNode: () => { ignoreNextVisitorsOnNode = true; },
+                ignoreNextVisitorsOnNode: () => {
+                    ignoreNextVisitorsOnNode = true;
+                },
                 getVisitorData: getVisitorDataFn.bind(undefined, ruleId),
             }, collectParents(context), context);
             return { ignoreNextVisitorsOnNode };
         }
-        function resolve(ref, from = currentLocation.source.absoluteRef) {
-            if (!ref_utils_1.isRef(ref))
-                return { location, node: ref };
-            const refId = resolve_1.makeRefId(from, ref.$ref);
-            const resolvedRef = resolvedRefMap.get(refId);
-            if (!resolvedRef) {
-                return {
-                    location: undefined,
-                    node: undefined,
-                };
-            }
-            const { resolved, node, document, nodePointer, error } = resolvedRef;
-            const newLocation = resolved
-                ? new ref_utils_1.Location(document.source, nodePointer)
-                : error instanceof resolve_1.YamlParseError
-                    ? new ref_utils_1.Location(error.source, '')
-                    : undefined;
-            return { location: newLocation, node, error };
-        }
         function reportFn(ruleId, severity, opts) {
             const loc = opts.location
                 ? Array.isArray(opts.location)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redocly/openapi-core",
-  "version": "1.0.0-beta.102",
+  "version": "1.0.0-beta.105",
   "description": "",
   "main": "lib/index.js",
   "engines": {
@@ -16,7 +16,8 @@
     "fs": false,
     "path": "path-browserify",
     "os": false,
-    "node-fetch": false
+    "node-fetch": false,
+    "colorette": false
   },
   "homepage": "https://github.com/Redocly/redocly-cli",
   "keywords": [

package/src/__tests__/fixtures/.redocly.lint-ignore.yaml

@@ -0,0 +1,5 @@
+# This file instructs Redocly's linter to ignore the rules contained for specific parts of your API.
+# See https://redoc.ly/docs/cli/ for more information.
+openapi.yaml:
+  operation-operationId:
+    - '#/paths/~1pets~1{petId}/post/operationId'

package/src/__tests__/lint.test.ts

@@ -1,3 +1,4 @@
+import * as path from 'path';
 import { outdent } from 'outdent';
 
 import { lintFromString, lintConfig, lintDocument } from '../lint';
@@ -70,7 +71,7 @@ describe('lint', () => {
           links:
             color: '#6CC496'
       `,
-      '',
+      ''
     );
     const results = await lintConfig({ document });
 
@@ -85,7 +86,7 @@ describe('lint', () => {
             },
           ],
           "message": "Expected type \`ConfigApis\` (object) but got \`string\`",
-          "ruleId": "spec",
+          "ruleId": "configuration spec",
           "severity": "error",
           "suggest": Array [],
         },
@@ -97,8 +98,8 @@ describe('lint', () => {
               "source": "",
             },
           ],
-          "message": "Expected type \`string\` but got \`object\`.",
-          "ruleId": "spec",
+          "message": "\`layout\` can be one of the following only: \\"stacked\\", \\"three-panel\\".",
+          "ruleId": "configuration spec",
           "severity": "error",
           "suggest": Array [],
         },
@@ -117,12 +118,25 @@ describe('lint', () => {
         plugins:
           - './local-plugin.js'
       `,
-      '',
+      ''
     );
     const results = await lintConfig({ document });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
       Array [
+        Object {
+          "location": Array [
+            Object {
+              "pointer": "#/apis/lint",
+              "reportOnKey": true,
+              "source": "",
+            },
+          ],
+          "message": "The field \`root\` must be present on this level.",
+          "ruleId": "configuration spec",
+          "severity": "error",
+          "suggest": Array [],
+        },
         Object {
           "location": Array [
             Object {
@@ -132,7 +146,7 @@ describe('lint', () => {
             },
           ],
           "message": "Property \`plugins\` is not expected here.",
-          "ruleId": "spec",
+          "ruleId": "configuration spec",
           "severity": "error",
           "suggest": Array [],
         },
@@ -169,7 +183,7 @@ describe('lint', () => {
                       type: string
                       const: ABC
         `,
-      'foobar.yaml',
+      'foobar.yaml'
     );
 
     const results = await lintDocument({
@@ -186,10 +200,10 @@ describe('lint', () => {
       outdent`
       openapi: 3.0
     `,
-      '',
+      ''
     );
     expect(() => detectOpenAPI(testDocument.parsed)).toThrow(
-      `Invalid OpenAPI version: should be a string but got "number"`,
+      `Invalid OpenAPI version: should be a string but got "number"`
     );
   });
 
@@ -218,7 +232,7 @@ describe('lint', () => {
                   '200':
                     description: callback successfully processed
     `,
-      'foobar.yaml',
+      'foobar.yaml'
     );
 
     const results = await lintDocument({
@@ -229,4 +243,50 @@ describe('lint', () => {
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
   });
+
+  it('should ignore error because ignore file passed', async () => {
+    const absoluteRef = path.join(__dirname, 'fixtures/openapi.yaml');
+    const document = parseYamlToDocument(
+      outdent`
+      openapi: 3.0.0
+      info:
+        version: 1.0.0
+        title: Example OpenAPI 3 definition.
+        description: Information about API
+        license:
+          name: MIT
+          url: 'https://opensource.org/licenses/MIT'
+      servers:
+        - url: 'https://redocly.com/v1'
+      paths:
+        '/pets/{petId}':
+          post:
+            responses:
+              '201':
+                summary: Exist 
+                description: example description
+      `,
+      absoluteRef
+    );
+
+    const configFilePath = path.join(__dirname, 'fixtures');
+
+    const result = await lintDocument({
+      externalRefResolver: new BaseResolver(),
+      document,
+      config: await makeConfig({ 'operation-operationId': 'error' }, undefined, configFilePath),
+    });
+    expect(result).toHaveLength(1);
+    expect(result).toMatchObject([
+      {
+        ignored: true,
+        location: [{ pointer: '#/paths/~1pets~1{petId}/post/operationId' }],
+        message: 'Operation object should contain `operationId` field.',
+        ruleId: 'operation-operationId',
+        severity: 'error',
+      },
+    ]);
+    expect(result[0]).toHaveProperty('ignored', true);
+    expect(result[0]).toHaveProperty('ruleId', 'operation-operationId');
+  });
 });

package/src/__tests__/utils.test.ts

@@ -1,4 +1,12 @@
-import { pickObjectProps, omitObjectProps, slash, getMatchingStatusCodeRange } from '../utils';
+import {
+  pickObjectProps,
+  omitObjectProps,
+  slash,
+  getMatchingStatusCodeRange,
+  doesYamlFileExist,
+} from '../utils';
+import * as fs from 'fs';
+import * as path from 'path';
 
 describe('utils', () => {
   const testObject = {
@@ -81,5 +89,38 @@ describe('utils', () => {
       expect(getMatchingStatusCodeRange('2002')).toEqual('2002');
       expect(getMatchingStatusCodeRange(4000)).toEqual('4000');
     });
+
+    describe('isConfigFileExist', () => {
+      beforeEach(() => {
+        jest
+          .spyOn(fs, 'existsSync')
+          .mockImplementation((path) => path === 'redocly.yaml' || path === 'redocly.yml');
+        jest.spyOn(path, 'extname').mockImplementation((path) => {
+          if (path.endsWith('.yaml')) {
+            return '.yaml';
+          } else if (path.endsWith('.yml')) {
+            return '.yml';
+          } else {
+            return '';
+          }
+        });
+      });
+
+      it('should return true because of valid path provided', () => {
+        expect(doesYamlFileExist('redocly.yaml')).toBe(true);
+      });
+
+      it('should return true because of valid path provided with yml', () => {
+        expect(doesYamlFileExist('redocly.yml')).toBe(true);
+      });
+
+      it('should return false because of fail do not exist', () => {
+        expect(doesYamlFileExist('redoccccly.yaml')).toBe(false);
+      });
+
+      it('should return false because of it is not yaml file', () => {
+        expect(doesYamlFileExist('redocly.yam')).toBe(false);
+      });
+    });
   });
 });

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

@@ -9,7 +9,7 @@ describe('loadConfig', () => {
     jest
       .spyOn(RedoclyClient.prototype, 'getTokens')
       .mockImplementation(() =>
-        Promise.resolve([{ region: 'us', token: 'accessToken', valid: true }]),
+        Promise.resolve([{ region: 'us', token: 'accessToken', valid: true }])
       );
     const config = await loadConfig();
     expect(config.resolve.http.headers).toStrictEqual([
@@ -32,7 +32,7 @@ describe('loadConfig', () => {
     jest
       .spyOn(RedoclyClient.prototype, 'getTokens')
       .mockImplementation(() =>
-        Promise.resolve([{ region: 'eu', token: 'accessToken', valid: true }]),
+        Promise.resolve([{ region: 'eu', token: 'accessToken', valid: true }])
       );
     const config = await loadConfig();
     expect(config.resolve.http.headers).toStrictEqual([
@@ -44,6 +44,12 @@ describe('loadConfig', () => {
       },
     ]);
   });
+
+  it('should call callback if such passed', async () => {
+    const mockFn = jest.fn();
+    await loadConfig(undefined, undefined, mockFn);
+    expect(mockFn).toHaveBeenCalled();
+  });
 });
 
 describe('findConfig', () => {

package/src/config/config.ts

@@ -1,7 +1,7 @@
 import * as fs from 'fs';
 import * as path from 'path';
 import { parseYaml, stringifyYaml } from '../js-yaml';
-import { slash } from '../utils';
+import { slash, doesYamlFileExist } from '../utils';
 import { NormalizedProblem } from '../walk';
 import { OasVersion, OasMajorVersion, Oas2RuleSet, Oas3RuleSet } from '../oas-types';
 
@@ -46,6 +46,16 @@ function getDomains() {
   return domains;
 }
 
+function getIgnoreFilePath(configFile?: string): string | undefined {
+  if (configFile) {
+    return doesYamlFileExist(configFile)
+      ? path.join(path.dirname(configFile), IGNORE_FILE)
+      : path.join(configFile, IGNORE_FILE);
+  } else {
+    return typeof process === 'undefined' ? undefined : path.join(process.cwd(), IGNORE_FILE);
+  }
+}
+
 export const DOMAINS = getDomains();
 export const AVAILABLE_REGIONS = Object.keys(DOMAINS) as Region[];
 
@@ -69,7 +79,7 @@ export class LintConfig {
     this.plugins = rawConfig.plugins || [];
     this.doNotResolveExamples = !!rawConfig.doNotResolveExamples;
 
-    this.recommendedFallback = rawConfig.recommendedFallback || false
+    this.recommendedFallback = rawConfig.recommendedFallback || false;
 
     this.rules = {
       [OasVersion.Version2]: { ...rawConfig.rules, ...rawConfig.oas2Rules },
@@ -91,29 +101,25 @@ export class LintConfig {
 
     this.extendPaths = rawConfig.extendPaths || [];
     this.pluginPaths = rawConfig.pluginPaths || [];
+    this.resolveIgnore(getIgnoreFilePath(configFile));
+  }
 
-    const dir = this.configFile
-      ? path.dirname(this.configFile)
-      : (typeof process !== 'undefined' && process.cwd()) || '';
-    const ignoreFile = path.join(dir, IGNORE_FILE);
+  resolveIgnore(ignoreFile?: string) {
+    if (!ignoreFile || !doesYamlFileExist(ignoreFile)) return;
 
-    /* no crash when using it on the client */
-    if (fs.hasOwnProperty('existsSync') && fs.existsSync(ignoreFile)) {
-      // TODO: parse errors
-      this.ignore =
-        (parseYaml(fs.readFileSync(ignoreFile, 'utf-8')) as Record<
-          string,
-          Record<string, Set<string>>
-        >) || {};
-
-      // resolve ignore paths
-      for (const fileName of Object.keys(this.ignore)) {
-        this.ignore[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];
+    this.ignore =
+      (parseYaml(fs.readFileSync(ignoreFile, 'utf-8')) as Record<
+        string,
+        Record<string, Set<string>>
+      >) || {};
+
+    // resolve ignore paths
+    for (const fileName of Object.keys(this.ignore)) {
+      this.ignore[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];
     }
   }
 
@@ -224,15 +230,13 @@ export class LintConfig {
 
     for (const usedVersion of Array.from(this._usedVersions)) {
       rules.push(
-        ...Object.keys(this.rules[usedVersion]).filter((name) => !this._usedRules.has(name)),
+        ...Object.keys(this.rules[usedVersion]).filter((name) => !this._usedRules.has(name))
       );
       decorators.push(
-        ...Object.keys(this.decorators[usedVersion]).filter((name) => !this._usedRules.has(name)),
+        ...Object.keys(this.decorators[usedVersion]).filter((name) => !this._usedRules.has(name))
       );
       preprocessors.push(
-        ...Object.keys(this.preprocessors[usedVersion]).filter(
-          (name) => !this._usedRules.has(name),
-        ),
+        ...Object.keys(this.preprocessors[usedVersion]).filter((name) => !this._usedRules.has(name))
       );
     }
 

package/src/config/load.ts

@@ -1,18 +1,22 @@
 import * as fs from 'fs';
 import * as path from 'path';
 import { RedoclyClient } from '../redocly';
-import { isEmptyObject, loadYaml } from '../utils';
+import { isEmptyObject, loadYaml, doesYamlFileExist } from '../utils';
 import { Config, DOMAINS } from './config';
 import { transformConfig } from './utils';
 import { resolveConfig } from './config-resolvers';
 
 import type { RawConfig, Region } from './types';
 
-export async function loadConfig(
-  configPath: string | undefined = findConfig(),
-  customExtends?: string[],
-): Promise<Config> {
-  const rawConfig = await getConfig(configPath);
+async function addConfigMetadata({
+  rawConfig,
+  customExtends,
+  configPath,
+}: {
+  rawConfig: RawConfig;
+  customExtends?: string[];
+  configPath?: string;
+}): Promise<Config> {
   if (customExtends !== undefined) {
     rawConfig.lint = rawConfig.lint || {};
     rawConfig.lint.extends = customExtends;
@@ -48,7 +52,7 @@ export async function loadConfig(
                 value: item.token,
               },
             ]
-          : []),
+          : [])
       );
     }
   }
@@ -56,12 +60,28 @@ export async function loadConfig(
   return resolveConfig(rawConfig, configPath);
 }
 
+export async function loadConfig(
+  configPath: string | undefined = findConfig(),
+  customExtends?: string[],
+  processRawConfig?: (rawConfig: RawConfig) => void | Promise<void>
+): Promise<Config> {
+  const rawConfig = await getConfig(configPath);
+  if (typeof processRawConfig === 'function') {
+    await processRawConfig(rawConfig);
+  }
+  return await addConfigMetadata({
+    rawConfig,
+    customExtends,
+    configPath,
+  });
+}
+
 export const CONFIG_FILE_NAMES = ['redocly.yaml', 'redocly.yml', '.redocly.yaml', '.redocly.yml'];
 
 export function findConfig(dir?: string): string | undefined {
   if (!fs.hasOwnProperty('existsSync')) return;
   const existingConfigFiles = CONFIG_FILE_NAMES.map((name) =>
-    dir ? path.resolve(dir, name) : name,
+    dir ? path.resolve(dir, name) : name
   ).filter(fs.existsSync);
   if (existingConfigFiles.length > 1) {
     throw new Error(`
@@ -74,7 +94,7 @@ export function findConfig(dir?: string): string | undefined {
 }
 
 export async function getConfig(configPath: string | undefined = findConfig()) {
-  if (!configPath) return {};
+  if (!configPath || !doesYamlFileExist(configPath)) return {};
   try {
     const rawConfig = ((await loadYaml(configPath)) || {}) as RawConfig;
     return transformConfig(rawConfig);

package/src/config/types.ts

@@ -11,17 +11,18 @@ import type {
 } from '../oas-types';
 import type { NodeType } from '../types';
 
+export type RuleSeverity = ProblemSeverity | 'off';
+
+export type PreprocessorSeverity = RuleSeverity | 'on';
+
 export type RuleConfig =
-  | ProblemSeverity
-  | 'off'
+  | RuleSeverity
   | ({
       severity?: ProblemSeverity;
     } & Record<string, any>);
 
 export type PreprocessorConfig =
-  | ProblemSeverity
-  | 'off'
-  | 'on'
+  | PreprocessorSeverity
   | ({
       severity?: ProblemSeverity;
     } & Record<string, any>);