@redocly/cli 1.6.0 → 1.8.0

package/CHANGELOG.md

@@ -1,5 +1,28 @@
 # @redocly/cli
 
+## 1.8.0
+
+### Minor Changes
+
+- Added a `push` and `push-status` command for use with future Redocly products.
+
+### Patch Changes
+
+- Updated @redocly/openapi-core to v1.8.0.
+
+## 1.7.0
+
+### Minor Changes
+
+- Added a `preview` command that starts a local preview server for Redocly projects that use products that are currently in a pre-release stage.
+
+### Patch Changes
+
+- Fixed an issue with resolving references after splitting API descriptions written in the json format.
+- Added filename extension support for more `x-codeSamples` languages.
+- Fixed a problem where the linter incorrectly returned an error for valid examples that contain references.
+- Updated @redocly/openapi-core to v1.7.0.
+
 ## 1.6.0
 
 ### Minor Changes

package/README.md

@@ -28,7 +28,7 @@ Then you can use it as `redocly [command] [options]`, for example:
 redocly lint path-to-root-file.yaml
 ```
 
-Minimal required versions of Node.js and NPM are 14.19.0 and 7.0.0 respectively.
+The minimum required versions of Node.js and NPM are 14.19.0 and 7.0.0 respectively.
 
 ### Docker
 
@@ -63,11 +63,11 @@ Your API reference docs are in `redoc-static.html` by default. You can customize
 
 ### Bundle multiple OpenAPI documents
 
-Having one massive OpenAPI description can be annoying, so most people split them up into multiple documents via `$ref`, only to later find out some tools don't support `$ref`, or don't support multiple documents?! Well fear not, because Redocly has a `bundle` command you can use to recombine all of those documents back into one single document. The bundled output Redocly CLI provides is clean, tidy, and looks like a human made it.
+Having one massive OpenAPI description can be annoying, so most people split them up into multiple documents via `$ref`, only to later find out some tools don't support `$ref` or don't support multiple documents. Redocly CLI to the rescue! It has a `bundle` command you can use to recombine all of those documents back into one single document. The bundled output that Redocly CLI provides is clean, tidy, and looks like a human made it.
 
 ### Automate API guidelines with Linting
 
-Check your API matches the expected API guidelines by using the `lint` command. API guidelines are an important piece of API governance, it helps to keep APIs consistent (enforcing the same standards and naming conventions) but can also guide API teams through potential security hazards and other pitfalls. Automating API guidelines means you can keep APIs consistent and secure throughout their lifecycle. Even better, you can shape the design of the API before it even exists if you combine API linting with a design-first API workflow!
+Check that your API matches the expected API guidelines by using the `lint` command. API guidelines are an important piece of API governance. They help to keep APIs consistent by enforcing the same standards and naming conventions, and they can also guide API teams through potential security hazards and other pitfalls. Automating API guidelines means you can keep APIs consistent and secure throughout their lifecycle. Even better, you can shape the design of the API before it even exists by combining API linting with a design-first API workflow.
 
 Our API linter is designed for speed on even large documents, and it's easy to run locally, in CI, or anywhere you need it. It's also designed for humans, with meaningful error messages to help you get your API right every time.
 
@@ -79,9 +79,9 @@ redocly lint openapi.yaml
 
 **Configure the rules** as you wish. Other API Linters use complicated identifiers like JSONPath, but Redocly makes life easy with simple expressions that understand the OpenAPI structure. You can either use the [built-in rules](https://redocly.com/docs/cli/rules) to mix-and-match your ideal API guidelines, or break out the tools to build your own.
 
-**Format the output** in whatever way you need, the `stylish` output is as good as it sounds, but if you need JSON or Checkstyle outputs to integrate with other tools, the lint command can output those too.
+**Format the output** in whatever way you need. The `stylish` output is as good as it sounds, but if you need JSON or Checkstyle outputs to integrate with other tools, the `lint` command can output those too.
 
-**Multiple files supported** so you don't need to bundle your API description to lint it, just point Redocly CLI at the "entry point" (e.g.: `openapi.yaml`) and it handles the rest.
+**Multiple files supported** so you don't need to bundle your API description to lint it; just point Redocly CLI at the "entry point" (e.g.: `openapi.yaml`) and it handles the rest.
 
 [Learn more about API standards and configuring Redocly rules](https://redocly.com/docs/cli/api-standards).
 

package/lib/__tests__/commands/build-docs.test.js

@@ -13,10 +13,10 @@ const redoc_1 = require("redoc");
 const server_1 = require("react-dom/server");
 const build_docs_1 = require("../../commands/build-docs");
 const utils_1 = require("../../commands/build-docs/utils");
-const utils_2 = require("../../utils");
+const miscellaneous_1 = require("../../utils/miscellaneous");
 jest.mock('redoc');
 jest.mock('fs');
-jest.mock('../../utils');
+jest.mock('../../utils/miscellaneous');
 const config = {
     output: '',
     title: 'Test',
@@ -50,7 +50,7 @@ describe('build-docs', () => {
             api: '../some-path/openapi.yaml',
         }, {});
         expect(redoc_1.loadAndBundleSpec).toBeCalledTimes(1);
-        expect(utils_2.getFallbackApisOrExit).toBeCalledTimes(1);
+        expect(miscellaneous_1.getFallbackApisOrExit).toBeCalledTimes(1);
         expect(processExitMock).toBeCalledTimes(0);
     }));
 });

package/lib/__tests__/commands/bundle.test.js

@@ -11,10 +11,10 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 const openapi_core_1 = require("@redocly/openapi-core");
 const bundle_1 = require("../../commands/bundle");
-const utils_1 = require("../../utils");
+const miscellaneous_1 = require("../../utils/miscellaneous");
 const wrapper_1 = require("../../wrapper");
 jest.mock('@redocly/openapi-core');
-jest.mock('../../utils');
+jest.mock('../../utils/miscellaneous');
 openapi_core_1.getMergedConfig.mockImplementation((config) => config);
 describe('bundle', () => {
     let processExitMock;
@@ -107,8 +107,8 @@ describe('bundle', () => {
             format: 'codeframe',
             lint: false,
         });
-        expect(utils_1.handleError).toHaveBeenCalledTimes(1);
-        expect(utils_1.handleError).toHaveBeenCalledWith(new Error('Invalid definition'), 'invalid.json');
+        expect(miscellaneous_1.handleError).toHaveBeenCalledTimes(1);
+        expect(miscellaneous_1.handleError).toHaveBeenCalledWith(new Error('Invalid definition'), 'invalid.json');
     }));
     it("handleError isn't called when bundles a valid definition", () => __awaiter(void 0, void 0, void 0, function* () {
         const apis = ['foo.yaml'];
@@ -123,6 +123,6 @@ describe('bundle', () => {
             format: 'codeframe',
             lint: false,
         });
-        expect(utils_1.handleError).toHaveBeenCalledTimes(0);
+        expect(miscellaneous_1.handleError).toHaveBeenCalledTimes(0);
     }));
 });

package/lib/__tests__/commands/join.test.js

@@ -10,19 +10,19 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const join_1 = require("../../commands/join");
-const utils_1 = require("../../utils");
+const miscellaneous_1 = require("../../utils/miscellaneous");
 const colorette_1 = require("colorette");
 const openapi_core_1 = require("@redocly/openapi-core");
 const openapi_core_2 = require("../../__mocks__/@redocly/openapi-core");
 const config_1 = require("../fixtures/config");
-jest.mock('../../utils');
+jest.mock('../../utils/miscellaneous');
 jest.mock('colorette');
 describe('handleJoin fails', () => {
     const colloreteYellowMock = colorette_1.yellow;
     colloreteYellowMock.mockImplementation((string) => string);
     it('should call exitWithError because only one entrypoint', () => __awaiter(void 0, void 0, void 0, function* () {
         yield (0, join_1.handleJoin)({ apis: ['first.yaml'] }, {}, 'cli-version');
-        expect(utils_1.exitWithError).toHaveBeenCalledWith(`At least 2 apis should be provided. \n\n`);
+        expect(miscellaneous_1.exitWithError).toHaveBeenCalledWith(`At least 2 apis should be provided. \n\n`);
     }));
     it('should call exitWithError because passed all 3 options for tags', () => __awaiter(void 0, void 0, void 0, function* () {
         yield (0, join_1.handleJoin)({
@@ -31,7 +31,7 @@ describe('handleJoin fails', () => {
             'without-x-tag-groups': true,
             'prefix-tags-with-filename': true,
         }, {}, 'cli-version');
-        expect(utils_1.exitWithError).toHaveBeenCalledWith(`You use prefix-tags-with-filename, prefix-tags-with-info-prop, without-x-tag-groups together.\nPlease choose only one! \n\n`);
+        expect(miscellaneous_1.exitWithError).toHaveBeenCalledWith(`You use prefix-tags-with-filename, prefix-tags-with-info-prop, without-x-tag-groups together.\nPlease choose only one! \n\n`);
     }));
     it('should call exitWithError because passed all 2 options for tags', () => __awaiter(void 0, void 0, void 0, function* () {
         yield (0, join_1.handleJoin)({
@@ -39,13 +39,13 @@ describe('handleJoin fails', () => {
             'without-x-tag-groups': true,
             'prefix-tags-with-filename': true,
         }, {}, 'cli-version');
-        expect(utils_1.exitWithError).toHaveBeenCalledWith(`You use prefix-tags-with-filename, without-x-tag-groups together.\nPlease choose only one! \n\n`);
+        expect(miscellaneous_1.exitWithError).toHaveBeenCalledWith(`You use prefix-tags-with-filename, without-x-tag-groups together.\nPlease choose only one! \n\n`);
     }));
     it('should call exitWithError because Only OpenAPI 3.0 and OpenAPI 3.1 are supported', () => __awaiter(void 0, void 0, void 0, function* () {
         yield (0, join_1.handleJoin)({
             apis: ['first.yaml', 'second.yaml'],
         }, config_1.ConfigFixture, 'cli-version');
-        expect(utils_1.exitWithError).toHaveBeenCalledWith('Only OpenAPI 3.0 and OpenAPI 3.1 are supported: undefined \n\n');
+        expect(miscellaneous_1.exitWithError).toHaveBeenCalledWith('Only OpenAPI 3.0 and OpenAPI 3.1 are supported: undefined \n\n');
     }));
     it('should call exitWithError if mixing OpenAPI 3.0 and 3.1', () => __awaiter(void 0, void 0, void 0, function* () {
         openapi_core_1.detectSpec
@@ -54,21 +54,21 @@ describe('handleJoin fails', () => {
         yield (0, join_1.handleJoin)({
             apis: ['first.yaml', 'second.yaml'],
         }, config_1.ConfigFixture, 'cli-version');
-        expect(utils_1.exitWithError).toHaveBeenCalledWith('All APIs must use the same OpenAPI version: undefined \n\n');
+        expect(miscellaneous_1.exitWithError).toHaveBeenCalledWith('All APIs must use the same OpenAPI version: undefined \n\n');
     }));
     it('should call writeToFileByExtension function', () => __awaiter(void 0, void 0, void 0, function* () {
         openapi_core_1.detectSpec.mockReturnValue('oas3_0');
         yield (0, join_1.handleJoin)({
             apis: ['first.yaml', 'second.yaml'],
         }, config_1.ConfigFixture, 'cli-version');
-        expect(utils_1.writeToFileByExtension).toHaveBeenCalledWith(expect.any(Object), 'openapi.yaml', expect.any(Boolean));
+        expect(miscellaneous_1.writeToFileByExtension).toHaveBeenCalledWith(expect.any(Object), 'openapi.yaml', expect.any(Boolean));
     }));
     it('should call writeToFileByExtension function for OpenAPI 3.1', () => __awaiter(void 0, void 0, void 0, function* () {
         openapi_core_1.detectSpec.mockReturnValue('oas3_1');
         yield (0, join_1.handleJoin)({
             apis: ['first.yaml', 'second.yaml'],
         }, config_1.ConfigFixture, 'cli-version');
-        expect(utils_1.writeToFileByExtension).toHaveBeenCalledWith(expect.any(Object), 'openapi.yaml', expect.any(Boolean));
+        expect(miscellaneous_1.writeToFileByExtension).toHaveBeenCalledWith(expect.any(Object), 'openapi.yaml', expect.any(Boolean));
     }));
     it('should call writeToFileByExtension function with custom output file', () => __awaiter(void 0, void 0, void 0, function* () {
         openapi_core_1.detectSpec.mockReturnValue('oas3_0');
@@ -76,14 +76,14 @@ describe('handleJoin fails', () => {
             apis: ['first.yaml', 'second.yaml'],
             output: 'output.yml',
         }, config_1.ConfigFixture, 'cli-version');
-        expect(utils_1.writeToFileByExtension).toHaveBeenCalledWith(expect.any(Object), 'output.yml', expect.any(Boolean));
+        expect(miscellaneous_1.writeToFileByExtension).toHaveBeenCalledWith(expect.any(Object), 'output.yml', expect.any(Boolean));
     }));
     it('should call writeToFileByExtension function with json file extension', () => __awaiter(void 0, void 0, void 0, function* () {
         openapi_core_1.detectSpec.mockReturnValue('oas3_0');
         yield (0, join_1.handleJoin)({
             apis: ['first.json', 'second.yaml'],
         }, config_1.ConfigFixture, 'cli-version');
-        expect(utils_1.writeToFileByExtension).toHaveBeenCalledWith(expect.any(Object), 'openapi.json', expect.any(Boolean));
+        expect(miscellaneous_1.writeToFileByExtension).toHaveBeenCalledWith(expect.any(Object), 'openapi.json', expect.any(Boolean));
     }));
     it('should call skipDecorators and skipPreprocessors', () => __awaiter(void 0, void 0, void 0, function* () {
         openapi_core_1.detectSpec.mockReturnValue('oas3_0');

package/lib/__tests__/commands/lint.test.js

@@ -11,15 +11,15 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 const lint_1 = require("../../commands/lint");
 const openapi_core_1 = require("@redocly/openapi-core");
-const utils_1 = require("../../utils");
+const miscellaneous_1 = require("../../utils/miscellaneous");
 const config_1 = require("../fixtures/config");
 const perf_hooks_1 = require("perf_hooks");
 const wrapper_1 = require("../../wrapper");
 const colorette_1 = require("colorette");
 jest.mock('@redocly/openapi-core');
-jest.mock('../../utils');
+jest.mock('../../utils/miscellaneous');
 jest.mock('perf_hooks');
-jest.mock('../../update-version-notifier', () => ({
+jest.mock('../../utils/update-version-notifier', () => ({
     version: '1.0.0',
 }));
 const argvMock = {
@@ -48,20 +48,20 @@ describe('handleLint', () => {
     describe('loadConfig and getEnrtypoints stage', () => {
         it('should fail if config file does not exist', () => __awaiter(void 0, void 0, void 0, function* () {
             yield (0, wrapper_1.commandWrapper)(lint_1.handleLint)(Object.assign(Object.assign({}, argvMock), { config: 'config.yaml' }));
-            expect(utils_1.exitWithError).toHaveBeenCalledWith('Please, provide valid path to the configuration file');
+            expect(miscellaneous_1.exitWithError).toHaveBeenCalledWith('Please, provide valid path to the configuration file');
         }));
         it('should call loadConfigAndHandleErrors and getFallbackApisOrExit', () => __awaiter(void 0, void 0, void 0, function* () {
             yield (0, wrapper_1.commandWrapper)(lint_1.handleLint)(argvMock);
-            expect(utils_1.loadConfigAndHandleErrors).toHaveBeenCalledWith({
+            expect(miscellaneous_1.loadConfigAndHandleErrors).toHaveBeenCalledWith({
                 configPath: undefined,
                 customExtends: undefined,
                 processRawConfig: undefined,
             });
-            expect(utils_1.getFallbackApisOrExit).toHaveBeenCalled();
+            expect(miscellaneous_1.getFallbackApisOrExit).toHaveBeenCalled();
         }));
         it('should call loadConfig with args if such exist', () => __awaiter(void 0, void 0, void 0, function* () {
             yield (0, wrapper_1.commandWrapper)(lint_1.handleLint)(Object.assign(Object.assign({}, argvMock), { config: 'redocly.yaml', extends: ['some/path'] }));
-            expect(utils_1.loadConfigAndHandleErrors).toHaveBeenCalledWith({
+            expect(miscellaneous_1.loadConfigAndHandleErrors).toHaveBeenCalledWith({
                 configPath: 'redocly.yaml',
                 customExtends: ['some/path'],
                 processRawConfig: undefined,
@@ -73,12 +73,12 @@ describe('handleLint', () => {
         }));
         it('should check if ruleset exist', () => __awaiter(void 0, void 0, void 0, function* () {
             yield (0, wrapper_1.commandWrapper)(lint_1.handleLint)(argvMock);
-            expect(utils_1.checkIfRulesetExist).toHaveBeenCalledTimes(1);
+            expect(miscellaneous_1.checkIfRulesetExist).toHaveBeenCalledTimes(1);
         }));
         it('should fail if apis not provided', () => __awaiter(void 0, void 0, void 0, function* () {
             yield (0, wrapper_1.commandWrapper)(lint_1.handleLint)(Object.assign(Object.assign({}, argvMock), { apis: [] }));
-            expect(utils_1.getFallbackApisOrExit).toHaveBeenCalledTimes(1);
-            expect(utils_1.exitWithError).toHaveBeenCalledWith('No APIs were provided');
+            expect(miscellaneous_1.getFallbackApisOrExit).toHaveBeenCalledTimes(1);
+            expect(miscellaneous_1.exitWithError).toHaveBeenCalledWith('No APIs were provided');
         }));
     });
     describe('loop through entrypoints and lint stage', () => {
@@ -104,21 +104,21 @@ describe('handleLint', () => {
                 totals: { errors: 0 },
                 version: '1.0.0',
             });
-            expect(utils_1.getExecutionTime).toHaveBeenCalledWith(42);
+            expect(miscellaneous_1.getExecutionTime).toHaveBeenCalledWith(42);
         }));
         it('should catch error in handleError if something fails', () => __awaiter(void 0, void 0, void 0, function* () {
             openapi_core_1.lint.mockRejectedValueOnce('error');
             yield (0, wrapper_1.commandWrapper)(lint_1.handleLint)(argvMock);
-            expect(utils_1.handleError).toHaveBeenCalledWith('error', 'openapi.yaml');
+            expect(miscellaneous_1.handleError).toHaveBeenCalledWith('error', 'openapi.yaml');
         }));
     });
     describe('erros and warning handle after lint stage', () => {
         it('should call printLintTotals and printLintTotals', () => __awaiter(void 0, void 0, void 0, function* () {
             yield (0, wrapper_1.commandWrapper)(lint_1.handleLint)(argvMock);
-            expect(utils_1.printUnusedWarnings).toHaveBeenCalled();
+            expect(miscellaneous_1.printUnusedWarnings).toHaveBeenCalled();
         }));
         it('should call exit with 0 if no errors', () => __awaiter(void 0, void 0, void 0, function* () {
-            utils_1.loadConfigAndHandleErrors.mockImplementation(() => {
+            miscellaneous_1.loadConfigAndHandleErrors.mockImplementation(() => {
                 return Object.assign({}, config_1.ConfigFixture);
             });
             yield (0, wrapper_1.commandWrapper)(lint_1.handleLint)(argvMock);

package/lib/__tests__/commands/push-region.test.js

@@ -22,7 +22,7 @@ jest.mock('node-fetch', () => ({
 }));
 jest.mock('@redocly/openapi-core');
 jest.mock('../../commands/login');
-jest.mock('../../utils');
+jest.mock('../../utils/miscellaneous');
 openapi_core_1.getMergedConfig.mockImplementation((config) => config);
 const mockPromptClientToken = login_1.promptClientToken;
 describe('push-with-region', () => {

package/lib/__tests__/commands/push.test.js

@@ -11,7 +11,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 const fs = require("fs");
 const openapi_core_1 = require("@redocly/openapi-core");
-const utils_1 = require("../../utils");
+const miscellaneous_1 = require("../../utils/miscellaneous");
 const push_1 = require("../../commands/push");
 const config_1 = require("../fixtures/config");
 const colorette_1 = require("colorette");
@@ -23,7 +23,7 @@ jest.mock('node-fetch', () => ({
     })),
 }));
 jest.mock('@redocly/openapi-core');
-jest.mock('../../utils');
+jest.mock('../../utils/miscellaneous');
 openapi_core_1.getMergedConfig.mockImplementation((config) => config);
 describe('push', () => {
     const redoclyClient = require('@redocly/openapi-core').__redoclyClient;
@@ -65,7 +65,7 @@ describe('push', () => {
             'job-id': ' ',
             'batch-size': 2,
         }, config_1.ConfigFixture);
-        expect(utils_1.exitWithError).toBeCalledTimes(1);
+        expect(miscellaneous_1.exitWithError).toBeCalledTimes(1);
     }));
     it('fails if batchSize value is less than 2', () => __awaiter(void 0, void 0, void 0, function* () {
         yield (0, push_1.handlePush)({
@@ -77,7 +77,7 @@ describe('push', () => {
             'job-id': '123',
             'batch-size': 1,
         }, config_1.ConfigFixture);
-        expect(utils_1.exitWithError).toBeCalledTimes(1);
+        expect(miscellaneous_1.exitWithError).toBeCalledTimes(1);
     }));
     it('push with --files', () => __awaiter(void 0, void 0, void 0, function* () {
         const mockConfig = Object.assign(Object.assign({}, config_1.ConfigFixture), { files: ['./resouces/1.md', './resouces/2.md'] });
@@ -112,8 +112,8 @@ describe('push', () => {
             'job-id': '123',
             'batch-size': 2,
         }, config_1.ConfigFixture);
-        expect(utils_1.exitWithError).toBeCalledTimes(1);
-        expect(utils_1.exitWithError).toBeCalledWith(`No organization provided, please use --organization option or specify the 'organization' field in the config file.`);
+        expect(miscellaneous_1.exitWithError).toBeCalledTimes(1);
+        expect(miscellaneous_1.exitWithError).toBeCalledWith(`No organization provided, please use --organization option or specify the 'organization' field in the config file.`);
     }));
     it('push should work with organization in config', () => __awaiter(void 0, void 0, void 0, function* () {
         const mockConfig = Object.assign(Object.assign({}, config_1.ConfigFixture), { organization: 'test_org' });
@@ -160,8 +160,8 @@ describe('push', () => {
             'job-id': '123',
             'batch-size': 2,
         }, mockConfig);
-        expect(utils_1.exitWithError).toBeCalledTimes(1);
-        expect(utils_1.exitWithError).toHaveBeenLastCalledWith('Api not found. Please make sure you have provided the correct data in the config file.');
+        expect(miscellaneous_1.exitWithError).toBeCalledTimes(1);
+        expect(miscellaneous_1.exitWithError).toHaveBeenLastCalledWith('Api not found. Please make sure you have provided the correct data in the config file.');
     }));
     it('push should fail if destination not provided', () => __awaiter(void 0, void 0, void 0, function* () {
         const mockConfig = { organization: 'test_org', apis: {} };
@@ -173,8 +173,8 @@ describe('push', () => {
             'job-id': '123',
             'batch-size': 2,
         }, mockConfig);
-        expect(utils_1.exitWithError).toBeCalledTimes(1);
-        expect(utils_1.exitWithError).toHaveBeenLastCalledWith('No destination provided, please use --destination option to provide destination.');
+        expect(miscellaneous_1.exitWithError).toBeCalledTimes(1);
+        expect(miscellaneous_1.exitWithError).toHaveBeenLastCalledWith('No destination provided, please use --destination option to provide destination.');
     }));
     it('push should fail if destination format is not valid', () => __awaiter(void 0, void 0, void 0, function* () {
         const mockConfig = { organization: 'test_org', apis: {} };
@@ -186,7 +186,7 @@ describe('push', () => {
             'job-id': '123',
             'batch-size': 2,
         }, mockConfig);
-        expect(utils_1.exitWithError).toHaveBeenCalledWith(`Destination argument value is not valid, please use the right format: ${(0, colorette_1.yellow)('<api-name@api-version>')}`);
+        expect(miscellaneous_1.exitWithError).toHaveBeenCalledWith(`Destination argument value is not valid, please use the right format: ${(0, colorette_1.yellow)('<api-name@api-version>')}`);
     }));
     it('push should work and encode name with spaces', () => __awaiter(void 0, void 0, void 0, function* () {
         const encodeURIComponentSpy = jest.spyOn(global, 'encodeURIComponent');

package/lib/__tests__/fetch-with-timeout.test.js

@@ -9,30 +9,21 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const fetch_with_timeout_1 = require("../fetch-with-timeout");
+const abort_controller_1 = require("abort-controller");
+const fetch_with_timeout_1 = require("../utils/fetch-with-timeout");
 const node_fetch_1 = require("node-fetch");
 jest.mock('node-fetch');
 describe('fetchWithTimeout', () => {
     afterEach(() => {
         jest.clearAllMocks();
     });
-    it('should use bare node-fetch if AbortController is not available', () => __awaiter(void 0, void 0, void 0, function* () {
-        // @ts-ignore
-        global.AbortController = undefined;
-        // @ts-ignore
-        global.setTimeout = jest.fn();
-        yield (0, fetch_with_timeout_1.default)('url', { method: 'GET' });
-        expect(node_fetch_1.default).toHaveBeenCalledWith('url', { method: 'GET' });
-        expect(global.setTimeout).toHaveBeenCalledTimes(0);
-    }));
-    it('should call node-fetch with signal if AbortController is  available', () => __awaiter(void 0, void 0, void 0, function* () {
-        global.AbortController = jest.fn().mockImplementation(() => ({ signal: 'something' }));
+    it('should call node-fetch with signal', () => __awaiter(void 0, void 0, void 0, function* () {
         // @ts-ignore
         global.setTimeout = jest.fn();
         global.clearTimeout = jest.fn();
         yield (0, fetch_with_timeout_1.default)('url');
         expect(global.setTimeout).toHaveBeenCalledTimes(1);
-        expect(node_fetch_1.default).toHaveBeenCalledWith('url', { signal: 'something' });
+        expect(node_fetch_1.default).toHaveBeenCalledWith('url', { signal: new abort_controller_1.default().signal });
         expect(global.clearTimeout).toHaveBeenCalledTimes(1);
     }));
 });

package/lib/__tests__/spinner.test.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const spinner_1 = require("../utils/spinner");
+const process = require("process");
+jest.useFakeTimers();
+describe('Spinner', () => {
+    const IS_TTY = process.stdout.isTTY;
+    let writeMock;
+    let spinner;
+    beforeEach(() => {
+        process.stdout.isTTY = true;
+        writeMock = jest.spyOn(process.stdout, 'write').mockImplementation(jest.fn());
+        spinner = new spinner_1.Spinner();
+    });
+    afterEach(() => {
+        writeMock.mockRestore();
+        jest.clearAllTimers();
+    });
+    afterAll(() => {
+        process.stdout.isTTY = IS_TTY;
+    });
+    it('starts the spinner', () => {
+        spinner.start('Loading');
+        jest.advanceTimersByTime(100);
+        expect(writeMock).toHaveBeenCalledWith('\r⠋ Loading');
+    });
+    it('stops the spinner', () => {
+        spinner.start('Loading');
+        spinner.stop();
+        expect(writeMock).toHaveBeenCalledWith('\r');
+    });
+    it('should write 3 frames', () => {
+        spinner.start('Loading');
+        jest.advanceTimersByTime(300);
+        expect(writeMock).toHaveBeenCalledTimes(3);
+    });
+    it('should call write 1 times if CI set to true', () => {
+        process.stdout.isTTY = false;
+        spinner.start('Loading');
+        jest.advanceTimersByTime(300);
+        expect(writeMock).toHaveBeenCalledTimes(1);
+    });
+});