feat: display dry run mode warning

- update the retry message to be white with `Tip:` at the beginning

packages/snyk-fix/src/lib/errors/common.ts

@@ -1,4 +1,4 @@
 export const reTryMessage =
-  'Re-run in debug mode to see more information: DEBUG=*snyk* <COMMAND>';
+  'Tip: Re-run in debug mode to see more information: DEBUG=*snyk* <COMMAND>';
 export const contactSupportMessage =
   'If the issue persists contact support@snyk.io';

packages/snyk-fix/src/lib/output-formatters/show-results-summary.ts

@@ -27,7 +27,11 @@ export async function showResultsSummary(
   const {
     summary: overallSummary,
     count: changedCount,
-  } = generateFixedAndFailedSummary(resultsByPlugin, exceptionsByScanType);
+  } = generateFixedAndFailedSummary(
+    resultsByPlugin,
+    exceptionsByScanType,
+    options,
+  );
 
   const vulnsSummary = generateIssueSummary(
     resultsByPlugin,
@@ -36,7 +40,7 @@ export async function showResultsSummary(
   const fixedIssuesSummary = `${chalk.bold(
     calculateFixedIssues(resultsByPlugin),
   )} fixed issues`;
-  const getHelpText = chalk.red(`\n${reTryMessage}. ${contactSupportMessage}`);
+  const getHelpText = `\n${reTryMessage}. ${contactSupportMessage}`;
 
   const fixSummary = `\n${successfulFixesSummary}${
     unresolvedSummary ? `\n\n${unresolvedSummary}` : ''
@@ -128,14 +132,19 @@ export function generateUnresolvedSummary(
 export function generateFixedAndFailedSummary(
   resultsByPlugin: FixHandlerResultByPlugin,
   exceptionsByScanType: ErrorsByEcoSystem,
+  options: FixOptions,
 ): { summary: string; count: number } {
   const sectionTitle = 'Summary:';
   const formattedTitleHeader = `${chalk.bold(sectionTitle)}`;
   const fixed = calculateFixed(resultsByPlugin);
   const failed = calculateFailed(resultsByPlugin, exceptionsByScanType);
-
+  const dryRunText = options.dryRun
+    ? chalk.hex('#EDD55E')(
+        `${PADDING_SPACE}Command run in dry run mode. Fixes are not be applied.\n`,
+      )
+    : '';
   return {
-    summary: `${formattedTitleHeader}\n\n${PADDING_SPACE}${chalk.bold.red(
+    summary: `${formattedTitleHeader}\n\n${dryRunText}${PADDING_SPACE}${chalk.bold.red(
       failed,
     )} items were not fixed\n${PADDING_SPACE}${chalk.green.bold(
       fixed,

packages/snyk-fix/test/unit/__snapshots__/fix.spec.ts.snap

@@ -80,7 +80,7 @@ Summary:
   0 fixed issues
 
 
-Re-run in debug mode to see more information: DEBUG=*snyk* <COMMAND>. If the issue persists contact support@snyk.io",
+Tip: Re-run in debug mode to see more information: DEBUG=*snyk* <COMMAND>. If the issue persists contact support@snyk.io",
   "meta": Object {
     "failed": 1,
     "fixed": 0,
@@ -201,6 +201,7 @@ Successful fixes:
 
 Summary:
 
+  Command run in dry run mode. Fixes are not be applied.
   0 items were not fixed
   2 items were successfully fixed
   2 total issues: 2 High

packages/snyk-fix/test/unit/lib/output-formatters/__snapshots__/show-results-summary.spec.ts.snap

@@ -11,6 +11,7 @@ exports[`formatIssueCountBySeverity all vuln severities present 1`] = `"1 Critic
 exports[`generateFixedAndFailedSummary has failed only 1`] = `
 "Summary:
 
+Command run in dry run mode. Fixes are not be applied.
   1 items were not fixed
   0 items were successfully fixed"
 `;
@@ -32,6 +33,7 @@ exports[`generateFixedAndFailedSummary has fixed only 1`] = `
 exports[`generateFixedAndFailedSummary has skipped & failed & plugin errors 1`] = `
 "Summary:
 
+Command run in dry run mode. Fixes are not be applied.
   2 items were not fixed
   1 items were successfully fixed"
 `;
@@ -85,7 +87,7 @@ Summary:
   1 fixed issues
 
 
-Re-run in debug mode to see more information: DEBUG=*snyk* <COMMAND>. If the issue persists contact support@snyk.io"
+Tip: Re-run in debug mode to see more information: DEBUG=*snyk* <COMMAND>. If the issue persists contact support@snyk.io"
 `;
 
 exports[`showResultsSummary has unresolved only 1`] = `
@@ -106,5 +108,5 @@ Summary:
   0 fixed issues
 
 
-Re-run in debug mode to see more information: DEBUG=*snyk* <COMMAND>. If the issue persists contact support@snyk.io"
+Tip: Re-run in debug mode to see more information: DEBUG=*snyk* <COMMAND>. If the issue persists contact support@snyk.io"
 `;

packages/snyk-fix/test/unit/lib/output-formatters/show-results-summary.spec.ts

@@ -49,7 +49,7 @@ describe('generateFixedAndFailedSummary', () => {
         skipped: [],
       },
     };
-    const res = await generateFixedAndFailedSummary(resultsByPlugin, {});
+    const res = await generateFixedAndFailedSummary(resultsByPlugin, {}, {});
     expect(stripAnsi(res.summary)).toMatchSnapshot();
   });
 
@@ -77,7 +77,7 @@ describe('generateFixedAndFailedSummary', () => {
         skipped: [],
       },
     };
-    const res = await generateFixedAndFailedSummary(resultsByPlugin, {});
+    const res = await generateFixedAndFailedSummary(resultsByPlugin, {}, {});
     expect(stripAnsi(res.summary)).toMatchSnapshot();
     expect(res.count).toEqual(1);
   });
@@ -100,7 +100,11 @@ describe('generateFixedAndFailedSummary', () => {
         skipped: [],
       },
     };
-    const res = await generateFixedAndFailedSummary(resultsByPlugin, {});
+    const res = await generateFixedAndFailedSummary(
+      resultsByPlugin,
+      {},
+      { dryRun: true },
+    );
     expect(stripAnsi(res.summary)).toMatchSnapshot();
     expect(res.count).toEqual(1);
   });
@@ -146,7 +150,11 @@ describe('generateFixedAndFailedSummary', () => {
         ],
       },
     };
-    const res = await generateFixedAndFailedSummary(resultsByPlugin, {});
+    const res = await generateFixedAndFailedSummary(
+      resultsByPlugin,
+      {},
+      { dryRun: true },
+    );
     expect(stripAnsi(res.summary)).toMatchSnapshot();
     expect(res.count).toEqual(3);
   });