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

package/src/__tests__/codeframes.test.ts

@@ -17,7 +17,7 @@ describe('Location', () => {
             license:
               name: MIT
               url: https://google.com
-        `,
+        `
       ),
     };
     const preciseLocation = getLineColLocation(loc);
@@ -37,7 +37,7 @@ describe('Location', () => {
             license:
               name: MIT
               url: https://google.com
-        `,
+        `
       ),
     };
     const preciseLocation = getLineColLocation(loc);
@@ -57,7 +57,7 @@ describe('Location', () => {
             license:
               name: MIT
               url: https://google.com
-        `,
+        `
       ),
     };
     const preciseLocation = getLineColLocation(loc);
@@ -77,7 +77,7 @@ describe('Location', () => {
             license:
               name: MIT
               url: https://google.com
-        `,
+        `
       ),
     };
     const preciseLocation = getLineColLocation(loc);
@@ -98,7 +98,7 @@ describe('Location', () => {
             license:
               name: MIT
               url: https://google.com
-        `,
+        `
       ),
     };
     const preciseLocation = getLineColLocation(loc);
@@ -106,7 +106,6 @@ describe('Location', () => {
     expect(preciseLocation.end).toEqual({ line: 2, col: 9 });
   });
 
-
   it('should return first line for empty doc', () => {
     const loc = {
       reportOnKey: false,
@@ -158,7 +157,7 @@ describe('codeframes', () => {
             license:
               name: MIT
               url: https://google.com
-            `,
+            `
       ),
     };
 
@@ -222,7 +221,7 @@ describe('codeframes', () => {
             license:
               name: MIT
               url: https://google.com
-            `,
+            `
       ),
     };
 
@@ -256,7 +255,7 @@ describe('codeframes', () => {
               name: MIT,
               url: https://google.com
             }
-            `,
+            `
       ),
     };
 
@@ -299,7 +298,7 @@ describe('codeframes', () => {
               field5: MIT
               url: https://google.com
           openapi: 3.0.2
-          `,
+          `
       ),
     };
 
@@ -343,7 +342,7 @@ describe('codeframes', () => {
               field3: MIT
               field4: MIT
               field5: MIT
-          `,
+          `
       ),
     };
 
@@ -390,7 +389,7 @@ describe('codeframes', () => {
                     in: wrong
               post:
                 operationId: test2
-          `,
+          `
       ),
     };
 
@@ -425,7 +424,7 @@ describe('codeframes', () => {
             license:
               name: MIT
               url: https://google.com
-          `,
+          `
       ),
     };
 
@@ -483,7 +482,7 @@ describe('codeframes', () => {
           license:
             name: MIT
             url: https://google.com
-      `,
+      `
       ),
     };
 

package/src/__tests__/js-yaml.test.ts

@@ -48,7 +48,7 @@ describe('js-yaml', () => {
 
   test('should correctly dump date and string', () => {
     expect(stringifyYaml(parseYaml(yamlToDump))).toMatchInlineSnapshot(
-    `
+      `
     "date: '2022-01-21T11:29:56.694Z'
     dateWithoutQuotes: '2020-01-01'
     dateWithQuotes: '2020-01-01'
@@ -57,7 +57,8 @@ describe('js-yaml', () => {
     stringWithQuotes: test
     stringWithDoubleQuotes: test
     "
-    `);
+    `
+    );
   });
 
   test('parse and stringify', () => {
@@ -65,7 +66,8 @@ describe('js-yaml', () => {
   });
 
   test('should throw an error for unsupported types', () => {
-    expect(() => stringifyYaml({ foo: () => {} }))
-      .toThrow('unacceptable kind of an object to dump [object Function]');
+    expect(() => stringifyYaml({ foo: () => {} })).toThrow(
+      'unacceptable kind of an object to dump [object Function]'
+    );
   });
 });

package/src/__tests__/lint.test.ts

@@ -49,7 +49,7 @@ describe('lint', () => {
     const document = parseYamlToDocument(
       outdent`
       apis: error string
-      lint:
+      styleguide:
         plugins:
           - './local-plugin.js'
         extends:
@@ -107,14 +107,82 @@ describe('lint', () => {
     `);
   });
 
-  it("'plugins' shouldn't be allowed in 'apis' -> 'lint' field", async () => {
+  it('lintConfig should detect wrong fields and suggest correct ones', async () => {
+    const document = parseYamlToDocument(
+      outdent`
+      api: 
+        name@version:
+          root: ./file.yaml
+      syleguide:
+        rules:
+          operation-2xx-response: warn
+      `,
+      ''
+    );
+    const results = await lintConfig({ document });
+
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
+      Array [
+        Object {
+          "location": Array [
+            Object {
+              "pointer": "#/api",
+              "reportOnKey": true,
+              "source": "",
+            },
+          ],
+          "message": "Property \`api\` is not expected here.",
+          "ruleId": "configuration spec",
+          "severity": "error",
+          "suggest": Array [
+            "apis",
+          ],
+        },
+        Object {
+          "location": Array [
+            Object {
+              "pointer": "#/syleguide",
+              "reportOnKey": true,
+              "source": "",
+            },
+          ],
+          "message": "Property \`syleguide\` is not expected here.",
+          "ruleId": "configuration spec",
+          "severity": "error",
+          "suggest": Array [
+            "styleguide",
+          ],
+        },
+      ]
+    `);
+  });
+
+  it('lintConfig should work with legacy fields', async () => {
+    const document = parseYamlToDocument(
+      outdent`
+      apiDefinitions: 
+        entry: ./file.yaml
+      lint:
+        rules:
+          operation-2xx-response: warn
+      referenceDocs:
+        showConsole: true
+      `,
+      ''
+    );
+    const results = await lintConfig({ document });
+
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
+  });
+
+  it("'plugins' shouldn't be allowed in 'apis' -> 'styleguide' field", async () => {
     const document = parseYamlToDocument(
       outdent`
       apis: 
-        lint: 
+        styleguide: 
           plugins: 
             - './local-plugin.js'
-      lint:
+      styleguide:
         plugins:
           - './local-plugin.js'
       `,
@@ -127,7 +195,7 @@ describe('lint', () => {
         Object {
           "location": Array [
             Object {
-              "pointer": "#/apis/lint",
+              "pointer": "#/apis/styleguide",
               "reportOnKey": true,
               "source": "",
             },
@@ -140,7 +208,7 @@ describe('lint', () => {
         Object {
           "location": Array [
             Object {
-              "pointer": "#/apis/lint/plugins",
+              "pointer": "#/apis/styleguide/plugins",
               "reportOnKey": true,
               "source": "",
             },

package/src/__tests__/logger-browser.test.ts

@@ -0,0 +1,53 @@
+/**
+ * @jest-environment jsdom
+ */
+
+import * as colorette from 'colorette';
+import { logger, colorize } from '../logger';
+
+describe('Logger in Browser', () => {
+  it('should call "console.error"', () => {
+    const error = jest.spyOn(console, 'error').mockImplementation();
+
+    logger.error('error');
+
+    expect(error).toBeCalledTimes(1);
+    expect(error).toBeCalledWith('error');
+
+    error.mockRestore();
+  });
+
+  it('should call "console.log"', () => {
+    const log = jest.spyOn(console, 'log').mockImplementation();
+
+    logger.info('info');
+
+    expect(log).toBeCalledTimes(1);
+    expect(log).toBeCalledWith('info');
+
+    log.mockRestore();
+  });
+
+  it('should call "console.warn"', () => {
+    const warn = jest.spyOn(console, 'warn').mockImplementation();
+
+    logger.warn('warn');
+
+    expect(warn).toBeCalledTimes(1);
+    expect(warn).toBeCalledWith('warn');
+
+    warn.mockRestore();
+  });
+});
+
+describe('colorize in Browser', () => {
+  it('should not call original colorette lib', () => {
+    const color = 'cyan';
+    const spyingCyan = jest.spyOn(colorette, color);
+
+    const colorized = colorize.cyan(color);
+
+    expect(spyingCyan).not.toBeCalled();
+    expect(colorized).toEqual(color);
+  });
+});

package/src/__tests__/logger.test.ts

@@ -0,0 +1,47 @@
+import * as colorette from 'colorette';
+import { logger, colorize } from '../logger';
+
+describe('Logger in nodejs', () => {
+  let spyingStderr: jest.SpyInstance;
+
+  beforeEach(() => {
+    spyingStderr = jest.spyOn(process.stderr, 'write').mockImplementation();
+  });
+
+  afterEach(() => {
+    spyingStderr.mockRestore();
+  });
+
+  it('should call "process.stderr.write" for error severity', () => {
+    logger.error('error');
+
+    expect(spyingStderr).toBeCalledTimes(1);
+    expect(spyingStderr).toBeCalledWith(colorette.red('error'));
+  });
+
+  it('should call "process.stderr.write" for warn severity', () => {
+    logger.warn('warn');
+
+    expect(spyingStderr).toBeCalledTimes(1);
+    expect(spyingStderr).toBeCalledWith(colorette.yellow('warn'));
+  });
+
+  it('should call "process.stderr.write" for info severity', () => {
+    logger.info('info');
+
+    expect(spyingStderr).toBeCalledTimes(1);
+    expect(spyingStderr).toBeCalledWith('info');
+  });
+});
+
+describe('colorize in nodejs', () => {
+  it('should call original colorette lib', () => {
+    const color = 'cyan';
+    const spyingCyan = jest.spyOn(colorette, color);
+
+    const colorized = colorize.cyan(color);
+
+    expect(spyingCyan).toBeCalledWith(color);
+    expect(colorized).toEqual(colorette[color](color));
+  });
+});

package/src/__tests__/login.test.ts

@@ -6,10 +6,10 @@ describe.skip('login', () => {
     Object.defineProperty(client, 'registryApi', {
       value: {
         setAccessTokens: jest.fn(),
-        authStatus: jest.fn(() => true)
+        authStatus: jest.fn(() => true),
       },
       writable: true,
-      configurable: true
+      configurable: true,
     });
     await client.login('token'); // TODO: bug with rewrite local config file
     expect(client.registryApi.setAccessTokens).toHaveBeenCalled();

package/src/__tests__/normalizeVisitors.test.ts

@@ -22,7 +22,7 @@ describe('Normalize visitors', () => {
         ruleId,
         severity: 'error' as 'error',
         visitor: ruleset[ruleId]({}),
-      })),
+      }))
     );
 
     const normalized = normalizeVisitors(visitors, normalizeTypes(Oas3Types));
@@ -66,7 +66,7 @@ describe('Normalize visitors', () => {
         ruleId,
         severity: 'error' as 'error',
         visitor: ruleset[ruleId]({}),
-      })),
+      }))
     );
 
     const normalized = normalizeVisitors(visitors, normalizeTypes(Oas3Types));
@@ -104,7 +104,7 @@ describe('Normalize visitors', () => {
         ruleId,
         severity: 'error' as 'error',
         visitor: ruleset[ruleId]({}),
-      })),
+      }))
     );
 
     const normalized = normalizeVisitors(visitors, normalizeTypes(Oas3Types));
@@ -139,7 +139,7 @@ describe('Normalize visitors', () => {
         ruleId,
         severity: 'error' as 'error',
         visitor: ruleset[ruleId]({}),
-      })),
+      }))
     );
 
     const normalized = normalizeVisitors(visitors, normalizeTypes(Oas3Types));

package/src/__tests__/output-browser.test.ts

@@ -0,0 +1,18 @@
+/**
+ * @jest-environment jsdom
+ */
+
+import { output } from '../output';
+
+describe('output', () => {
+  it('should ignore all parsable data in browser', () => {
+    const spyingStdout = jest.spyOn(process.stdout, 'write').mockImplementation();
+    const data = '{ "errors" : [] }';
+
+    output.write(data);
+
+    expect(spyingStdout).not.toBeCalled();
+
+    spyingStdout.mockRestore();
+  });
+});

package/src/__tests__/output.test.ts

@@ -0,0 +1,15 @@
+import { output } from '../output';
+
+describe('output', () => {
+  it('should write all parsable data to stdout', () => {
+    const spyingStdout = jest.spyOn(process.stdout, 'write').mockImplementation();
+    const data = '{ "errors" : [] }';
+
+    output.write(data);
+
+    expect(spyingStdout).toBeCalledTimes(1);
+    expect(spyingStdout).toBeCalledWith(data);
+
+    spyingStdout.mockRestore();
+  });
+});

package/src/__tests__/ref-utils.test.ts

@@ -2,7 +2,7 @@ import outdent from 'outdent';
 import { parseYamlToDocument } from '../../__tests__/utils';
 import { parseRef, refBaseName } from '../ref-utils';
 import { lintDocument } from '../lint';
-import { LintConfig } from '../config';
+import { StyleguideConfig } from '../config';
 import { BaseResolver } from '../resolve';
 
 describe('ref-utils', () => {
@@ -84,37 +84,37 @@ describe('ref-utils', () => {
                 name:
                   type: string
       `,
-      '',
+      ''
     );
 
     const result = await lintDocument({
       document,
       externalRefResolver: new BaseResolver(),
-      config: new LintConfig({}),
+      config: new StyleguideConfig({}),
     });
 
     expect(result).toMatchInlineSnapshot(`Array []`);
   });
 
   describe('refBaseName', () => {
-    it("returns base name for file reference", () => {
-      expect(refBaseName("../testcase/Pet.yaml")).toStrictEqual("Pet");
+    it('returns base name for file reference', () => {
+      expect(refBaseName('../testcase/Pet.yaml')).toStrictEqual('Pet');
     });
 
-    it("returns base name for local file reference", () => {
-      expect(refBaseName("Cat.json")).toStrictEqual("Cat");
+    it('returns base name for local file reference', () => {
+      expect(refBaseName('Cat.json')).toStrictEqual('Cat');
     });
 
-    it("returns base name for url reference", () => {
-      expect(refBaseName("http://example.com/tests/crocodile.json")).toStrictEqual("crocodile");
+    it('returns base name for url reference', () => {
+      expect(refBaseName('http://example.com/tests/crocodile.json')).toStrictEqual('crocodile');
     });
 
-    it("returns base name for file with multiple dots in name", () => {
-      expect(refBaseName("feline.tiger.v1.yaml")).toStrictEqual("feline.tiger.v1");
+    it('returns base name for file with multiple dots in name', () => {
+      expect(refBaseName('feline.tiger.v1.yaml')).toStrictEqual('feline.tiger.v1');
     });
 
-    it("returns base name for file without any dots in name", () => {
-      expect(refBaseName("abcdefg")).toStrictEqual("abcdefg");
+    it('returns base name for file without any dots in name', () => {
+      expect(refBaseName('abcdefg')).toStrictEqual('abcdefg');
     });
   });
 });

package/src/__tests__/resolve-http.test.ts

@@ -19,7 +19,7 @@ describe('Resolve http-headers', () => {
             C:
               $ref: 'https://sample.com/test/a/test.yaml'
       `,
-      'foobar.yaml',
+      'foobar.yaml'
     );
 
     const fetchMock = jest.fn(() => Promise.resolve({ ok: true, text: Promise.resolve('') }));

package/src/__tests__/resolve.test.ts

@@ -18,7 +18,7 @@ describe('collect refs', () => {
             contact: {}
             license: {}
       `,
-      'foobar.yaml',
+      'foobar.yaml'
     );
 
     const resolvedRefs = await resolveDocument({
@@ -35,7 +35,7 @@ describe('collect refs', () => {
       Array [
         "foobar.yaml::#/defs/info",
       ]
-    `,
+    `
     );
     expect(Array.from(resolvedRefs.values()).map((info) => info.node)).toEqual([
       { contact: {}, license: {} },
@@ -56,7 +56,7 @@ describe('collect refs', () => {
             contact: {}
             license: {}
       `,
-      '',
+      ''
     );
 
     try {
@@ -89,7 +89,7 @@ describe('collect refs', () => {
             contact: {}
             license: {}
       `,
-      'foobar.yaml',
+      'foobar.yaml'
     );
 
     const resolvedRefs = await resolveDocument({
@@ -125,7 +125,7 @@ describe('collect refs', () => {
         loop2:
           $ref: '#/info'
       `,
-      'foobar.yaml',
+      'foobar.yaml'
     );
 
     try {
@@ -147,7 +147,7 @@ describe('collect refs', () => {
         info:
           $ref: "./externalInfo.yaml#/info"
       `,
-      path.join(cwd, 'foobar.yaml'),
+      path.join(cwd, 'foobar.yaml')
     );
 
     const resolvedRefs = await resolveDocument({
@@ -181,7 +181,7 @@ describe('collect refs', () => {
     const externalRefResolver = new BaseResolver();
     const rootDocument = await externalRefResolver.resolveDocument(
       null,
-      `${cwd}/openapi-with-back.yaml`,
+      `${cwd}/openapi-with-back.yaml`
     );
 
     const resolvedRefs = await resolveDocument({
@@ -192,8 +192,11 @@ describe('collect refs', () => {
 
     expect(resolvedRefs).toBeDefined();
 
-    expect(Array.from(resolvedRefs.keys()).map((ref) => ref.substring(cwd.length + 1)).sort())
-      .toMatchInlineSnapshot(`
+    expect(
+      Array.from(resolvedRefs.keys())
+        .map((ref) => ref.substring(cwd.length + 1))
+        .sort()
+    ).toMatchInlineSnapshot(`
       Array [
         "openapi-with-back.yaml::./schemas/type-a.yaml#/",
         "openapi-with-back.yaml::./schemas/type-b.yaml#/",
@@ -345,7 +348,7 @@ describe('collect refs', () => {
     const externalRefResolver = new BaseResolver();
     const rootDocument = await externalRefResolver.resolveDocument(
       null,
-      `${cwd}/openapi-with-md-description.yaml`,
+      `${cwd}/openapi-with-md-description.yaml`
     );
 
     expect(rootDocument).toBeDefined();
@@ -383,7 +386,7 @@ describe('collect refs', () => {
         components:
           $ref: "./transitive/components.yaml#/components/schemas/a"
       `,
-      path.join(cwd, 'foobar.yaml'),
+      path.join(cwd, 'foobar.yaml')
     );
 
     const resolvedRefs = await resolveDocument({

package/src/__tests__/utils-browser.test.ts

@@ -0,0 +1,11 @@
+/**
+ * @jest-environment jsdom
+ */
+
+import { isBrowser } from '../env';
+
+describe('isBrowser', () => {
+  it('should be browser', () => {
+    expect(isBrowser).toBe(true);
+  });
+});

package/src/__tests__/utils.test.ts

@@ -5,6 +5,7 @@ import {
   getMatchingStatusCodeRange,
   doesYamlFileExist,
 } from '../utils';
+import { isBrowser } from '../env';
 import * as fs from 'fs';
 import * as path from 'path';
 
@@ -122,5 +123,11 @@ describe('utils', () => {
         expect(doesYamlFileExist('redocly.yam')).toBe(false);
       });
     });
+
+    describe('isBrowser', () => {
+      it('should not be browser', () => {
+        expect(isBrowser).toBe(false);
+      });
+    });
   });
 });