feat: introduce spinner lib to replace custom one

src/cli/commands/monitor.ts

@@ -9,7 +9,7 @@ import * as config from '../../lib/config';
 import * as url from 'url';
 import chalk from 'chalk';
 import * as pathUtil from 'path';
-import * as spinner from '../../lib/spinner';
+import * as spinner from 'cli-spinner';
 
 import * as detect from '../../lib/detect';
 import * as plugins from '../../lib/plugins';

src/lib/plugins/nodejs-plugin/npm-lock-parser.ts

@@ -1,7 +1,7 @@
 import * as baseDebug from 'debug';
 const debug = baseDebug('snyk');
 import * as path from 'path';
-import * as spinner from '../../spinner';
+import { Spinner } from 'cli-spinner';
 import * as analytics from '../../analytics';
 import * as fs from 'fs';
 import * as lockFileParser from 'snyk-nodejs-lockfile-parser';
@@ -54,9 +54,12 @@ export async function parse(
     : lockFileParser.LockfileType.npm;
 
   const resolveModuleSpinnerLabel = `Analyzing npm dependencies for ${lockFileFullPath}`;
+  const spinner = new Spinner(resolveModuleSpinnerLabel);
+  spinner.setSpinnerString('|/-\\');
+
   debug(resolveModuleSpinnerLabel);
   try {
-    await spinner(resolveModuleSpinnerLabel);
+    spinner.start();
     const strictOutOfSync = options.strictOutOfSync !== false;
     return lockFileParser.buildDepTree(
       manifestFile,
@@ -66,6 +69,6 @@ export async function parse(
       strictOutOfSync,
     );
   } finally {
-    await spinner.clear(resolveModuleSpinnerLabel);
+    spinner.stop(true);
   }
 }

src/lib/snyk-test/run-test.ts

@@ -11,7 +11,7 @@ import { ModuleInfo } from '../module-info';
 import { isCI } from '../is-ci';
 import request = require('../request');
 import snyk = require('../');
-import spinner = require('../spinner');
+import { Spinner } from 'cli-spinner';
 import common = require('./common');
 import { DepTree, TestOptions } from '../types';
 import {
@@ -72,7 +72,9 @@ async function runTest(
   options: Options & TestOptions,
 ): Promise<LegacyVulnApiResult[]> {
   const results: LegacyVulnApiResult[] = [];
-  const spinnerLbl = 'Querying vulnerabilities database...';
+  const spinner = new Spinner('Querying vulnerabilities database...');
+  spinner.setSpinnerString('|/-\\');
+
   try {
     const payloads = await assemblePayloads(root, options);
     for (const payload of payloads) {
@@ -87,7 +89,7 @@ async function runTest(
       ) {
         dockerfilePackages = payload.body.docker.dockerfilePackages;
       }
-      await spinner(spinnerLbl);
+      spinner.start();
       analytics.add('depGraph', !!depGraph);
       analytics.add('isDocker', !!(payload.body && payload.body.docker));
       // Type assertion might be a lie, but we are correcting that below
@@ -184,7 +186,7 @@ async function runTest(
       error.code,
     );
   } finally {
-    spinner.clear<void>(spinnerLbl)();
+    spinner.stop(true);
   }
 }
 
@@ -313,19 +315,21 @@ async function assembleLocalPayloads(
     analysisType +
     ' dependencies for ' +
     (pathUtil.relative('.', pathUtil.join(root, options.file || '')) ||
-      pathUtil.relative('..', '.') + ' project dir');
+      pathUtil.relative('..', '.'));
+  const spinner = new Spinner(spinnerLbl);
+  spinner.setSpinnerString('|/-\\');
 
   try {
     const payloads: Payload[] = [];
 
-    await spinner(spinnerLbl);
+    spinner.start();
     const deps = await getDepsFromPlugin(root, options);
     analytics.add('pluginName', deps.plugin.name);
 
     for (const scannedProject of deps.scannedProjects) {
       const pkg = scannedProject.depTree;
       if (options['print-deps']) {
-        await spinner.clear<void>(spinnerLbl)();
+        spinner.stop(true);
         maybePrintDeps(options, pkg);
       }
       if (deps.plugin && deps.plugin.packageManager) {
@@ -438,7 +442,7 @@ async function assembleLocalPayloads(
     }
     return payloads;
   } finally {
-    await spinner.clear<void>(spinnerLbl)();
+    await spinner.stop(true);
   }
 }