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

package/src/rules/common/__tests__/tag-description.test.ts

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

package/src/rules/common/__tests__/tags-alphabetical.test.ts

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

package/src/rules/common/assertions/index.ts

@@ -7,7 +7,7 @@ export const Assertions: Oas3Rule | Oas2Rule = (opts: object) => {
 
   // As 'Assertions' has an array of asserts,
   // that array spreads into an 'opts' object on init rules phase here
-  // https://github.com/Redocly/openapi-cli/blob/master/packages/core/src/config/config.ts#L311
+  // https://github.com/Redocly/redocly-cli/blob/master/packages/core/src/config/config.ts#L311
   // that is why we need to iterate through 'opts' values;
   // before - filter only object 'opts' values
   const assertions: any[] = Object.values(opts).filter(

package/src/rules/common/assertions/utils.ts

@@ -1,3 +1,4 @@
+import { isRef } from '../../../ref-utils';
 import { Problem, ProblemSeverity, UserContext } from '../../../walk';
 import { asserts } from './asserts';
 
@@ -76,7 +77,7 @@ export function buildSubjectVisitor(
   asserts: AssertToApply[],
   context?: Record<string, any>[],
 ) {
-  return function (node: any, { report, location, key, type }: UserContext) {
+  return function (node: any, { report, location, key, type, resolve }: UserContext) {
     // 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;
@@ -102,7 +103,9 @@ export function buildSubjectVisitor(
     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 = isRef(node[property]) ? resolve(node[property])?.node : node[property];
+          runAssertion(value, assert, location.child(property), report);
         }
       } else {
         runAssertion(Object.keys(node), assert, location.key(), report);

package/src/rules/oas2/__tests__/boolean-parameter-prefixes.test.ts

@@ -21,7 +21,7 @@ describe('oas2 boolean-parameter-prefixes', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: makeConfig({ 'boolean-parameter-prefixes': 'error' }),
+      config: await makeConfig({ 'boolean-parameter-prefixes': 'error' }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
@@ -73,7 +73,7 @@ describe('oas2 boolean-parameter-prefixes', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: makeConfig({ 'boolean-parameter-prefixes': 'error' }),
+      config: await makeConfig({ 'boolean-parameter-prefixes': 'error' }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
@@ -97,7 +97,7 @@ describe('oas2 boolean-parameter-prefixes', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: makeConfig({
+      config: await makeConfig({
         'boolean-parameter-prefixes': {
           severity: 'error',
           prefixes: ['should'],

package/src/rules/oas2/__tests__/spec/referenceableScalars.test.ts

@@ -21,7 +21,7 @@ describe('Referenceable scalars', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: makeConfig({
+      config: await makeConfig({
         spec: 'error',
       }),
     });

package/src/rules/oas2/__tests__/spec/utils.ts

@@ -1,8 +1,7 @@
-import { LintConfig, RuleConfig } from '../../../../config/config';
+import { LintConfig, RuleConfig, resolveLint } from '../../../../config';
 import { parseYamlToDocument } from '../../../../../__tests__/utils';
 import { lintDocument } from '../../../../lint';
 import { BaseResolver } from '../../../../resolve';
-import { defaultPlugin } from '../../../../config/builtIn';
 
 export async function lintDoc(
   source: string,
@@ -13,11 +12,15 @@ export async function lintDoc(
   const results = await lintDocument({
     externalRefResolver: new BaseResolver(),
     document,
-    config: new LintConfig({
-      plugins: [defaultPlugin],
-      extends: [],
-      rules,
-    }),
+    config: new LintConfig(
+      await resolveLint({
+        lintConfig: {
+          plugins: [],
+          extends: [],
+          rules,
+        },
+      }),
+    ),
   });
 
   return results.map((res) => {

package/src/rules/oas3/__tests__/boolean-parameter-prefixes.test.ts

@@ -22,7 +22,7 @@ describe('oas3 boolean-parameter-prefixes', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: makeConfig({ 'boolean-parameter-prefixes': 'error' }),
+      config: await makeConfig({ 'boolean-parameter-prefixes': 'error' }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
@@ -74,7 +74,7 @@ describe('oas3 boolean-parameter-prefixes', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: makeConfig({ 'boolean-parameter-prefixes': 'error' }),
+      config: await makeConfig({ 'boolean-parameter-prefixes': 'error' }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
@@ -98,7 +98,7 @@ describe('oas3 boolean-parameter-prefixes', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: makeConfig({
+      config: await makeConfig({
         'boolean-parameter-prefixes': {
           severity: 'error',
           prefixes: ['should'],

package/src/rules/oas3/__tests__/no-empty-enum-servers.com.test.ts

@@ -24,7 +24,7 @@ describe('Oas3 as3-no-servers-empty-enum', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: makeConfig({ 'no-servers-empty-enum': 'error' }),
+      config: await makeConfig({ 'no-servers-empty-enum': 'error' }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
@@ -78,7 +78,7 @@ describe('Oas3 as3-no-servers-empty-enum', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: makeConfig({ 'no-servers-empty-enum': 'error' }),
+      config: await makeConfig({ 'no-servers-empty-enum': 'error' }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
@@ -117,7 +117,7 @@ describe('Oas3 as3-no-servers-empty-enum', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: makeConfig({ 'no-servers-empty-enum': 'error' }),
+      config: await makeConfig({ 'no-servers-empty-enum': 'error' }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
@@ -141,7 +141,7 @@ describe('Oas3 as3-no-servers-empty-enum', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: makeConfig({ 'no-servers-empty-enum': 'error' }),
+      config: await makeConfig({ 'no-servers-empty-enum': 'error' }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
@@ -168,7 +168,7 @@ describe('Oas3 as3-no-servers-empty-enum', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: makeConfig({ 'no-servers-empty-enum': 'error' }),
+      config: await makeConfig({ 'no-servers-empty-enum': 'error' }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
@@ -197,7 +197,7 @@ describe('Oas3 as3-no-servers-empty-enum', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: makeConfig({ 'no-servers-empty-enum': 'error' }),
+      config: await makeConfig({ 'no-servers-empty-enum': 'error' }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);

package/src/rules/oas3/__tests__/no-example-value-and-externalValue.test.ts

@@ -20,7 +20,7 @@ describe('Oas3 oas3-no-example-value-and-externalValue', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: makeConfig({ 'no-example-value-and-externalValue': 'error' }),
+      config: await makeConfig({ 'no-example-value-and-externalValue': 'error' }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
@@ -57,7 +57,7 @@ describe('Oas3 oas3-no-example-value-and-externalValue', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: makeConfig({ 'no-example-value-and-externalValue': 'error' }),
+      config: await makeConfig({ 'no-example-value-and-externalValue': 'error' }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);

package/src/rules/oas3/__tests__/no-invalid-media-type-examples.test.ts

@@ -33,7 +33,7 @@ describe('no-invalid-media-type-examples', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: makeConfig({ 'no-invalid-media-type-examples': 'error' }),
+      config: await makeConfig({ 'no-invalid-media-type-examples': 'error' }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
@@ -106,7 +106,7 @@ describe('no-invalid-media-type-examples', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: makeConfig({
+      config: await makeConfig({
         'no-invalid-media-type-examples': {
           severity: 'error',
           disallowAdditionalProperties: true,
@@ -166,7 +166,7 @@ describe('no-invalid-media-type-examples', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: makeConfig({
+      config: await makeConfig({
         'no-invalid-media-type-examples': {
           severity: 'error',
           disallowAdditionalProperties: true,
@@ -216,7 +216,7 @@ describe('no-invalid-media-type-examples', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: makeConfig({
+      config: await makeConfig({
         'no-invalid-media-type-examples': {
           severity: 'error',
           disallowAdditionalProperties: true,
@@ -269,7 +269,7 @@ describe('no-invalid-media-type-examples', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: makeConfig({ 'no-invalid-media-type-examples': 'error' }),
+      config: await makeConfig({ 'no-invalid-media-type-examples': 'error' }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
@@ -301,7 +301,7 @@ describe('no-invalid-media-type-examples', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: makeConfig({ 'no-invalid-media-type-examples': 'error' }),
+      config: await makeConfig({ 'no-invalid-media-type-examples': 'error' }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
@@ -336,7 +336,7 @@ describe('no-invalid-media-type-examples', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: makeConfig({ 'no-invalid-media-type-examples': 'error' }),
+      config: await makeConfig({ 'no-invalid-media-type-examples': 'error' }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
@@ -364,7 +364,7 @@ describe('no-invalid-media-type-examples', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: makeConfig({ 'no-invalid-media-type-examples': 'error' }),
+      config: await makeConfig({ 'no-invalid-media-type-examples': 'error' }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`

package/src/rules/oas3/__tests__/no-server-example.com.test.ts

@@ -17,7 +17,7 @@ describe('Oas3 oas3-no-server-example.com', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: makeConfig({ 'no-server-example.com': 'error' }),
+      config: await makeConfig({ 'no-server-example.com': 'error' }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
@@ -52,7 +52,7 @@ describe('Oas3 oas3-no-server-example.com', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: makeConfig({ 'no-server-example.com': 'error' }),
+      config: await makeConfig({ 'no-server-example.com': 'error' }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);

package/src/rules/oas3/__tests__/no-server-trailing-slash.test.ts

@@ -17,7 +17,7 @@ describe('Oas3 oas3-no-server-trailing-slash', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: makeConfig({ 'no-server-trailing-slash': 'error' }),
+      config: await makeConfig({ 'no-server-trailing-slash': 'error' }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
@@ -52,7 +52,7 @@ describe('Oas3 oas3-no-server-trailing-slash', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: makeConfig({ 'no-server-trailing-slash': 'error' }),
+      config: await makeConfig({ 'no-server-trailing-slash': 'error' }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
@@ -71,7 +71,7 @@ describe('Oas3 oas3-no-server-trailing-slash', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: makeConfig({ 'no-server-trailing-slash': 'error' }),
+      config: await makeConfig({ 'no-server-trailing-slash': 'error' }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);

package/src/rules/oas3/__tests__/no-unused-components.test.ts

@@ -42,7 +42,7 @@ describe('Oas3 no-unused-components', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: makeConfig({ 'no-unused-components': 'error' }),
+      config: await makeConfig({ 'no-unused-components': 'error' }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`

package/src/rules/oas3/__tests__/spec/referenceableScalars.test.ts

@@ -3,6 +3,7 @@ import { parseYamlToDocument, replaceSourceWithRef } from '../../../../../__test
 import { lintDocument } from '../../../../lint';
 import { LintConfig } from '../../../..';
 import { BaseResolver } from '../../../../resolve';
+import { resolveLint } from '../../../../config';
 
 describe('Referenceable scalars', () => {
   it('should not report $ref description', async () => {
@@ -22,13 +23,17 @@ describe('Referenceable scalars', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: new LintConfig({
-        extends: [],
-        rules: {
-          spec: 'error',
-          'no-unresolved-refs': 'error',
-        },
-      }),
+      config: new LintConfig(
+        await resolveLint({
+          lintConfig: {
+            extends: [],
+            rules: {
+              spec: 'error',
+              'no-unresolved-refs': 'error',
+            },
+          },
+        }),
+      ),
     });
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
   });
@@ -55,13 +60,17 @@ describe('Referenceable scalars', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: new LintConfig({
-        extends: [],
-        rules: {
-          'no-unresolved-refs': 'error',
-        },
-        doNotResolveExamples: true,
-      }),
+      config: new LintConfig(
+        await resolveLint({
+          lintConfig: {
+            extends: [],
+            rules: {
+              'no-unresolved-refs': 'error',
+            },
+            doNotResolveExamples: true,
+          },
+        }),
+      ),
     });
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
   });

package/src/rules/oas3/__tests__/spec/spec.test.ts

@@ -1,13 +1,13 @@
 import { outdent } from 'outdent';
 import { lintDocument } from '../../../../lint';
 import { parseYamlToDocument, replaceSourceWithRef } from '../../../../../__tests__/utils';
-import { LintConfig } from '../../../../config/config';
-import { defaultPlugin } from '../../../../config/builtIn';
+import { LintConfig, defaultPlugin, resolvePlugins, resolvePreset } from '../../../../config';
 
 import { BaseResolver } from '../../../../resolve';
 
-const allConfig = new LintConfig({ plugins: [defaultPlugin], extends: ['all'] });
-
+const plugins = resolvePlugins([defaultPlugin]);
+const pressets = resolvePreset('all', plugins);
+const allConfig = new LintConfig({ ...pressets, plugins });
 describe('Oas3 Structural visitor basic', () => {
   it('should report wrong types', async () => {
     const document = parseYamlToDocument(

package/src/rules/oas3/__tests__/spec/utils.ts

@@ -1,8 +1,7 @@
-import { LintConfig, RuleConfig } from '../../../../config/config';
+import { LintConfig, RuleConfig, resolveLint } from '../../../../config';
 import { parseYamlToDocument } from '../../../../../__tests__/utils';
 import { lintDocument } from '../../../../lint';
 import { BaseResolver } from '../../../../resolve';
-import { defaultPlugin } from '../../../../config/builtIn';
 
 export async function validateDoc(
   source: string,
@@ -13,11 +12,15 @@ export async function validateDoc(
   const results = await lintDocument({
     externalRefResolver: new BaseResolver(),
     document,
-    config: new LintConfig({
-      plugins: [defaultPlugin],
-      extends: [],
-      rules,
-    }),
+    config: new LintConfig(
+      await resolveLint({
+        lintConfig: {
+          plugins: [],
+          extends: [],
+          rules,
+        },
+      }),
+    ),
   });
 
   return results.map((res) => {

package/src/utils.ts

@@ -2,10 +2,10 @@ import * as fs from 'fs';
 import * as minimatch from 'minimatch';
 import fetch from 'node-fetch';
 import * as pluralize from 'pluralize';
-
 import { parseYaml } from './js-yaml';
-import { HttpResolveConfig } from './config/config';
 import { UserContext } from './walk';
+import type { HttpResolveConfig } from './config';
+import { env } from "./config";
 
 export { parseYaml, stringifyYaml } from './js-yaml';
 
@@ -52,7 +52,7 @@ export async function readFileFromUrl(url: string, config: HttpResolveConfig) {
   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 ? env[header.envVariable] || '' : header.value;
     }
   }
 
@@ -67,7 +67,7 @@ export async function readFileFromUrl(url: string, config: HttpResolveConfig) {
   return { body: await req.text(), mimeType: req.headers.get('content-type') };
 }
 
-export function match(url: string, pattern: string) {
+function match(url: string, pattern: string) {
   if (!pattern.match(/^https?:\/\//)) {
     // if pattern doesn't specify protocol directly, do not match against it
     url = url.replace(/^https?:\/\//, '');
@@ -171,3 +171,20 @@ export function isPathParameter(pathSegment: string) {
 export function isNotEmptyObject(obj: any) {
   return !!obj && Object.keys(obj).length > 0;
 }
+
+// TODO: use it everywhere
+export function isString(value: unknown): value is string {
+  return typeof value === 'string';
+}
+
+export function isNotString<T>(value: string | T): value is T {
+  return !isString(value);
+}
+
+export function assignExisting<T>(target: Record<string, T>, obj: Record<string, T>) {
+  for (let k of Object.keys(obj)) {
+    if (target.hasOwnProperty(k)) {
+      target[k] = obj[k];
+    }
+  }
+}