@redocly/openapi-core 1.0.0-beta.94 → 1.0.0-beta.97

package/lib/rules/common/assertions/utils.d.ts

@@ -15,6 +15,6 @@ export declare type AssertToApply = {
     runsOnValues: boolean;
 };
 export declare function buildVisitorObject(subject: string, context: Record<string, any>[], subjectVisitor: any): Record<string, any>;
-export declare function buildSubjectVisitor(properties: string | string[], asserts: AssertToApply[], context?: Record<string, any>[]): (node: any, { report, location, key, type }: UserContext) => void;
+export declare function buildSubjectVisitor(properties: string | string[], asserts: AssertToApply[], context?: Record<string, any>[]): (node: any, { report, location, key, type, resolve }: UserContext) => void;
 export declare function getIntersectionLength(keys: string[], properties: string[]): number;
 export declare function isOrdered(value: any[], options: OrderOptions | OrderDirection): boolean;

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

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isOrdered = exports.getIntersectionLength = exports.buildSubjectVisitor = exports.buildVisitorObject = void 0;
+const ref_utils_1 = require("../../../ref-utils");
 const asserts_1 = require("./asserts");
 function buildVisitorObject(subject, context, subjectVisitor) {
     if (!context) {
@@ -44,7 +45,8 @@ function buildVisitorObject(subject, context, subjectVisitor) {
 }
 exports.buildVisitorObject = buildVisitorObject;
 function buildSubjectVisitor(properties, asserts, context) {
-    return function (node, { report, location, key, type }) {
+    return function (node, { report, location, key, type, resolve }) {
+        var _a;
         // We need to check context's last node if it has the same type as subject node;
         // if yes - that means we didn't create context's last node visitor,
         // so we need to handle 'matchParentKeys' and 'excludeParentKeys' conditions here;
@@ -67,7 +69,9 @@ function buildSubjectVisitor(properties, asserts, context) {
         for (const assert of asserts) {
             if (properties) {
                 for (const property of properties) {
-                    runAssertion(node[property], assert, location.child(property), report);
+                    // we can have resolvable scalar so need to resolve value here.
+                    const value = ref_utils_1.isRef(node[property]) ? (_a = resolve(node[property])) === null || _a === void 0 ? void 0 : _a.node : node[property];
+                    runAssertion(value, assert, location.child(property), report);
                 }
             }
             else {

package/lib/utils.d.ts

@@ -1,5 +1,5 @@
-import { HttpResolveConfig } from './config/config';
 import { UserContext } from './walk';
+import type { HttpResolveConfig } from './config';
 export { parseYaml, stringifyYaml } from './js-yaml';
 export declare type StackFrame<T> = {
     prev: StackFrame<T> | null;
@@ -22,7 +22,6 @@ export declare function readFileFromUrl(url: string, config: HttpResolveConfig):
     body: any;
     mimeType: any;
 }>;
-export declare function match(url: string, pattern: string): boolean;
 export declare function pickObjectProps<T extends Record<string, unknown>>(object: T, keys: Array<string>): T;
 export declare function omitObjectProps<T extends Record<string, unknown>>(object: T, keys: Array<string>): T;
 export declare function splitCamelCaseIntoWords(str: string): Set<string>;
@@ -36,3 +35,6 @@ export declare function isPathParameter(pathSegment: string): boolean;
  */
 export declare function slash(path: string): string;
 export declare function isNotEmptyObject(obj: any): boolean;
+export declare function isString(value: unknown): value is string;
+export declare function isNotString<T>(value: string | T): value is T;
+export declare function assignExisting<T>(target: Record<string, T>, obj: Record<string, T>): void;

package/lib/utils.js

@@ -9,12 +9,13 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isNotEmptyObject = exports.slash = exports.isPathParameter = exports.readFileAsStringSync = exports.isSingular = exports.validateMimeTypeOAS3 = exports.validateMimeType = exports.splitCamelCaseIntoWords = exports.omitObjectProps = exports.pickObjectProps = exports.match = exports.readFileFromUrl = exports.isEmptyArray = exports.isEmptyObject = exports.isPlainObject = exports.notUndefined = exports.loadYaml = exports.popStack = exports.pushStack = exports.stringifyYaml = exports.parseYaml = void 0;
+exports.assignExisting = exports.isNotString = exports.isString = exports.isNotEmptyObject = exports.slash = exports.isPathParameter = exports.readFileAsStringSync = exports.isSingular = exports.validateMimeTypeOAS3 = exports.validateMimeType = exports.splitCamelCaseIntoWords = exports.omitObjectProps = exports.pickObjectProps = exports.readFileFromUrl = exports.isEmptyArray = exports.isEmptyObject = exports.isPlainObject = exports.notUndefined = exports.loadYaml = exports.popStack = exports.pushStack = exports.stringifyYaml = exports.parseYaml = void 0;
 const fs = require("fs");
 const minimatch = require("minimatch");
 const node_fetch_1 = require("node-fetch");
 const pluralize = require("pluralize");
 const js_yaml_1 = require("./js-yaml");
+const config_1 = require("./config");
 var js_yaml_2 = require("./js-yaml");
 Object.defineProperty(exports, "parseYaml", { enumerable: true, get: function () { return js_yaml_2.parseYaml; } });
 Object.defineProperty(exports, "stringifyYaml", { enumerable: true, get: function () { return js_yaml_2.stringifyYaml; } });
@@ -56,7 +57,7 @@ function readFileFromUrl(url, config) {
         for (const header of config.headers) {
             if (match(url, header.matches)) {
                 headers[header.name] =
-                    header.envVariable !== undefined ? process.env[header.envVariable] || '' : header.value;
+                    header.envVariable !== undefined ? config_1.env[header.envVariable] || '' : header.value;
             }
         }
         const req = yield (config.customFetch || node_fetch_1.default)(url, {
@@ -76,7 +77,6 @@ function match(url, pattern) {
     }
     return minimatch(url, pattern);
 }
-exports.match = match;
 function pickObjectProps(object, keys) {
     return Object.fromEntries(keys.filter((key) => key in object).map((key) => [key, object[key]]));
 }
@@ -156,3 +156,20 @@ function isNotEmptyObject(obj) {
     return !!obj && Object.keys(obj).length > 0;
 }
 exports.isNotEmptyObject = isNotEmptyObject;
+// TODO: use it everywhere
+function isString(value) {
+    return typeof value === 'string';
+}
+exports.isString = isString;
+function isNotString(value) {
+    return !isString(value);
+}
+exports.isNotString = isNotString;
+function assignExisting(target, obj) {
+    for (let k of Object.keys(obj)) {
+        if (target.hasOwnProperty(k)) {
+            target[k] = obj[k];
+        }
+    }
+}
+exports.assignExisting = assignExisting;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redocly/openapi-core",
-  "version": "1.0.0-beta.94",
+  "version": "1.0.0-beta.97",
   "description": "",
   "main": "lib/index.js",
   "engines": {
@@ -10,12 +10,15 @@
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/Redocly/openapi-cli.git"
+    "url": "https://github.com/Redocly/redocly-cli.git"
   },
   "browser": {
-    "fs": false
+    "fs": false,
+    "path": "path-browserify",
+    "os": false,
+    "node-fetch": false
   },
-  "homepage": "https://github.com/Redocly/openapi-cli",
+  "homepage": "https://github.com/Redocly/redocly-cli",
   "keywords": [
     "linter",
     "OpenAPI",
@@ -36,7 +39,7 @@
     "js-levenshtein": "^1.1.6",
     "js-yaml": "^4.1.0",
     "lodash.isequal": "^4.5.0",
-    "minimatch": "^3.0.4",
+    "minimatch": "^5.0.1",
     "node-fetch": "^2.6.1",
     "pluralize": "^8.0.0",
     "yaml-ast-parser": "0.0.43"
@@ -45,7 +48,7 @@
     "@types/js-levenshtein": "^1.1.0",
     "@types/js-yaml": "^4.0.3",
     "@types/lodash.isequal": "^4.5.5",
-    "@types/minimatch": "^3.0.3",
+    "@types/minimatch": "^3.0.5",
     "@types/node-fetch": "^2.5.7",
     "@types/pluralize": "^0.0.29",
     "typescript": "^4.0.5"

package/src/__tests__/lint.test.ts

@@ -174,7 +174,7 @@ describe('lint', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: makeConfig({ spec: 'error' }),
+      config: await makeConfig({ spec: 'error' }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);

package/src/benchmark/benches/recommended-oas3.bench.ts

@@ -1,10 +1,9 @@
 import { readFileSync } from 'fs';
 import { join as pathJoin, resolve as pathResolve } from 'path';
 import { lintDocument } from '../../lint';
-import { LintConfig } from '../../config/config';
+import { LintConfig, defaultPlugin, resolvePreset } from '../../config';
 import { BaseResolver } from '../../resolve';
 import { parseYamlToDocument } from '../utils';
-import { defaultPlugin } from '../../config/builtIn';
 
 export const name = 'Validate with recommended rules';
 export const count = 10;
@@ -18,6 +17,6 @@ export function measureAsync() {
   return lintDocument({
     externalRefResolver: new BaseResolver(),
     document: rebillyDocument,
-    config: new LintConfig({ plugins: [defaultPlugin] }),
+    config: new LintConfig(resolvePreset('recommended', [defaultPlugin])),
   });
 }

package/src/benchmark/benchmark.js

@@ -29,7 +29,7 @@ function prepareRevision(revision) {
 
   // Returns the complete git hash for a given git revision reference.
   const hash = exec(`git rev-parse "${revision}"`);
-  const dir = path.join(os.tmpdir(), 'openapi-cli-benchmark', hash);
+  const dir = path.join(os.tmpdir(), 'redocly-cli-benchmark', hash);
   if (fs.existsSync(dir)) {
     fs.rmdirSync(dir, { recursive: true});
   }

package/src/benchmark/utils.ts

@@ -1,7 +1,9 @@
 import { parseYaml } from '../js-yaml';
 import { Document, Source } from '../resolve';
 import { Oas3RuleSet } from '../oas-types';
-import { RuleConfig, LintConfig, Plugin } from '../config/config';
+import { LintConfig, mergeExtends, resolvePlugins } from '../config';
+
+import type { RuleConfig, Plugin, ResolvedLintConfig } from '../config/types';
 
 export function parseYamlToDocument(body: string, absoluteRef: string = ''): Document {
   return {
@@ -16,16 +18,19 @@ export function makeConfigForRuleset(rules: Oas3RuleSet, plugin?: Partial<Plugin
   Object.keys(rules).forEach((name) => {
     rulesConf[`${ruleId}/${name}`] = 'error';
   });
-
-  return new LintConfig({
-    plugins: [
+  const extendConfigs = [
+    resolvePlugins([
       {
         ...plugin,
         id: ruleId,
         rules: { oas3: rules },
       },
-    ],
-    extends: [],
-    rules: rulesConf,
-  });
+    ]) as ResolvedLintConfig,
+  ];
+  if (rules) {
+    extendConfigs.push({ rules });
+  }
+  const lint = mergeExtends(extendConfigs);
+
+  return new LintConfig(lint);
 }

package/src/bundle.ts

@@ -8,7 +8,6 @@ import { NormalizedNodeType, normalizeTypes, NodeType } from './types';
 import { WalkContext, walkDocument, UserContext, ResolveResult } from './walk';
 import { detectOpenAPI, openAPIMajor, OasMajorVersion } from './oas-types';
 import { isRef, Location, refBaseName } from './ref-utils';
-import type { Config, LintConfig } from './config/config';
 import { initRules } from './config/rules';
 import { reportUnresolvedRef } from './rules/no-unresolved-refs';
 import { isPlainObject } from './utils';
@@ -17,6 +16,8 @@ import { isRedoclyRegistryURL } from './redocly';
 import { RemoveUnusedComponents as RemoveUnusedComponentsOas2 } from './rules/oas2/remove-unused-components';
 import { RemoveUnusedComponents as RemoveUnusedComponentsOas3 } from './rules/oas3/remove-unused-components';
 
+import type { Config, LintConfig } from './config';
+
 export type Oas3RuleSet = Record<string, Oas3Rule>;
 
 export enum OasVersion {

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

@@ -0,0 +1,157 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`resolveConfig should ignore minimal from the root and read local file 1`] = `
+Object {
+  "decorators": Object {},
+  "doNotResolveExamples": undefined,
+  "oas2Decorators": Object {},
+  "oas2Preprocessors": Object {},
+  "oas2Rules": Object {},
+  "oas3_0Decorators": Object {},
+  "oas3_0Preprocessors": Object {},
+  "oas3_0Rules": Object {
+    "no-empty-servers": "error",
+    "no-example-value-and-externalValue": "error",
+    "no-invalid-media-type-examples": "error",
+    "no-server-example.com": "warn",
+    "no-server-trailing-slash": "error",
+    "no-servers-empty-enum": "error",
+    "no-undefined-server-variable": "error",
+    "no-unused-components": "warn",
+  },
+  "oas3_1Decorators": Object {},
+  "oas3_1Preprocessors": Object {},
+  "oas3_1Rules": Object {
+    "no-empty-servers": "error",
+    "no-example-value-and-externalValue": "error",
+    "no-server-example.com": "warn",
+    "no-server-trailing-slash": "error",
+    "no-servers-empty-enum": "error",
+    "no-undefined-server-variable": "error",
+    "no-unused-components": "warn",
+  },
+  "preprocessors": Object {},
+  "recommendedFallback": false,
+  "rules": Object {
+    "assertions": "warn",
+    "boolean-parameter-prefixes": "error",
+    "info-contact": "off",
+    "info-description": "warn",
+    "info-license": "warn",
+    "info-license-url": "warn",
+    "local/operation-id-not-test": "error",
+    "no-ambiguous-paths": "warn",
+    "no-enum-type-mismatch": "error",
+    "no-identical-paths": "error",
+    "no-invalid-media-type-examples": "error",
+    "no-path-trailing-slash": "error",
+    "no-unresolved-refs": "error",
+    "operation-2xx-response": "warn",
+    "operation-4xx-response": "error",
+    "operation-description": "error",
+    "operation-operationId": "warn",
+    "operation-operationId-unique": "error",
+    "operation-operationId-url-safe": "error",
+    "operation-parameters-unique": "error",
+    "operation-security-defined": "error",
+    "operation-singular-tag": "off",
+    "operation-summary": "error",
+    "operation-tag-defined": "off",
+    "parameter-description": "off",
+    "path-declaration-must-exist": "error",
+    "path-http-verbs-order": "error",
+    "path-not-include-query": "error",
+    "path-parameters-defined": "error",
+    "paths-kebab-case": "off",
+    "spec": "error",
+    "tag-description": "warn",
+    "tags-alphabetical": "off",
+  },
+}
+`;
+
+exports[`resolveLint should resolve extends with local file config witch contains path to nested config 1`] = `
+Object {
+  "decorators": Object {},
+  "doNotResolveExamples": undefined,
+  "oas2Decorators": Object {},
+  "oas2Preprocessors": Object {},
+  "oas2Rules": Object {},
+  "oas3_0Decorators": Object {},
+  "oas3_0Preprocessors": Object {},
+  "oas3_0Rules": Object {
+    "no-empty-servers": "error",
+    "no-example-value-and-externalValue": "error",
+    "no-invalid-media-type-examples": "warn",
+    "no-server-example.com": "warn",
+    "no-server-trailing-slash": "error",
+    "no-servers-empty-enum": "error",
+    "no-undefined-server-variable": "error",
+    "no-unused-components": "warn",
+  },
+  "oas3_1Decorators": Object {},
+  "oas3_1Preprocessors": Object {},
+  "oas3_1Rules": Object {
+    "no-empty-servers": "error",
+    "no-example-value-and-externalValue": "error",
+    "no-server-example.com": "warn",
+    "no-server-trailing-slash": "error",
+    "no-servers-empty-enum": "error",
+    "no-undefined-server-variable": "error",
+    "no-unused-components": "warn",
+  },
+  "preprocessors": Object {},
+  "recommendedFallback": undefined,
+  "rules": Object {
+    "assertions": Array [
+      Object {
+        "assertionId": "path-item-get-defined",
+        "defined": true,
+        "message": "Every path item must have a GET operation.",
+        "property": "get",
+        "subject": "PathItem",
+      },
+      Object {
+        "assertionId": "tag-description",
+        "message": "Tag description must be at least 13 characters and end with a full stop.",
+        "minLength": 13,
+        "pattern": "/\\\\.$/",
+        "property": "description",
+        "severity": "error",
+        "subject": "Tag",
+      },
+    ],
+    "boolean-parameter-prefixes": "error",
+    "info-contact": "off",
+    "info-description": "warn",
+    "info-license": "warn",
+    "info-license-url": "warn",
+    "local/operation-id-not-test": "error",
+    "no-ambiguous-paths": "warn",
+    "no-enum-type-mismatch": "error",
+    "no-identical-paths": "error",
+    "no-invalid-media-type-examples": "warn",
+    "no-path-trailing-slash": "error",
+    "no-unresolved-refs": "error",
+    "operation-2xx-response": "error",
+    "operation-4xx-response": "off",
+    "operation-description": "off",
+    "operation-operationId": "warn",
+    "operation-operationId-unique": "error",
+    "operation-operationId-url-safe": "error",
+    "operation-parameters-unique": "error",
+    "operation-security-defined": "error",
+    "operation-singular-tag": "off",
+    "operation-summary": "error",
+    "operation-tag-defined": "off",
+    "parameter-description": "off",
+    "path-declaration-must-exist": "error",
+    "path-not-include-query": "error",
+    "path-parameters-defined": "error",
+    "paths-kebab-case": "off",
+    "spec": "error",
+    "tag-description": "warn",
+    "tags-alphabetical": "off",
+  },
+}
+`;