fix: show vuln note if present

snyk · Oct 22, 2019 · 6891566 · 6891566
1 parent 35e0fbd
commit 6891566
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 8 deletions.
diff --git a/src/cli/commands/test/formatters/remediation-based-format-issues.ts b/src/cli/commands/test/formatters/remediation-based-format-issues.ts
@@ -27,6 +27,7 @@ interface BasicVulnInfo {
   fixedIn: string[];
   legalInstructions?: LegalInstruction[];
   paths: string[][];
+  note: string | false;
 }
 
 interface TopLevelPackageUpgrade {
@@ -60,6 +61,7 @@ export function formatIssuesWithRemediation(
       type: vuln.metadata.type,
       version: vuln.version,
       fixedIn: vuln.fixedIn,
+      note: vuln.note,
       legalInstructions: vuln.legalInstructionsArray,
       paths: vuln.list.map((v) => v.from),
     };
@@ -166,10 +168,11 @@ function constructLicenseText(
       basicLicenseInfo[id].title,
       basicLicenseInfo[id].severity,
       basicLicenseInfo[id].isNew,
-      basicLicenseInfo[id].legalInstructions,
       `${basicLicenseInfo[id].name}@${basicLicenseInfo[id].version}`,
       basicLicenseInfo[id].paths,
       testOptions,
+      basicLicenseInfo[id].note,
+      basicLicenseInfo[id].legalInstructions,
     );
     licenseTextArray.push('\n' + licenseText);
   }
@@ -207,10 +210,10 @@ function constructPatchesText(
       basicVulnInfo[id].title,
       basicVulnInfo[id].severity,
       basicVulnInfo[id].isNew,
-      undefined,
       `${basicVulnInfo[id].name}@${basicVulnInfo[id].version}`,
       basicVulnInfo[id].paths,
       testOptions,
+      basicVulnInfo[id].note,
     );
     patchedTextArray.push(patchedText + thisPatchFixes);
   }
@@ -237,10 +240,10 @@ function thisUpgradeFixes(
         basicVulnInfo[id].title,
         basicVulnInfo[id].severity,
         basicVulnInfo[id].isNew,
-        undefined,
         `${basicVulnInfo[id].name}@${basicVulnInfo[id].version}`,
         basicVulnInfo[id].paths,
         testOptions,
+        basicVulnInfo[id].note,
       ),
     )
     .join('\n');
@@ -387,10 +390,10 @@ function constructUnfixableText(
         issue.title,
         issue.severity,
         issue.isNew,
-        undefined,
         `${issue.packageName}@${issue.version}`,
         issueInfo.paths,
         testOptions,
+        issueInfo.note,
       ) + `${extraInfo}`,
     );
   }
@@ -413,10 +416,11 @@ function formatIssue(
   title: string,
   severity: SEVERITY,
   isNew: boolean,
-  legalInstructions: LegalInstruction[] | undefined,
   vulnerableModule: string,
   paths: string[][],
   testOptions: TestOptions,
+  note: string | false,
+  legalInstructions?: LegalInstruction[],
 ): string {
   const severitiesColourMapping = {
     low: {
@@ -483,7 +487,8 @@ function formatIssue(
       ? `${chalk.bold(
           '\n    Legal instructions',
         )}:\n    ${legalLicenseInstructionsText}`
-      : '')
+      : '') +
+    (note ? `${chalk.bold('\n    Note')}:\n    ${note}` : '')
   );
 }
 

diff --git a/src/lib/snyk-test/legacy.ts b/src/lib/snyk-test/legacy.ts
@@ -40,7 +40,7 @@ export interface GroupedVuln {
   metadata: VulnMetaData;
   isIgnored: boolean;
   title: string;
-  note: string;
+  note: string | false;
   severity: SEVERITY;
   isNew: boolean;
   name: string;
@@ -95,7 +95,7 @@ interface AnnotatedIssue extends IssueData {
   type?: 'license';
   title: string;
   patch?: any;
-  note?: any;
+  note?: string | false;
   publicationTime?: string;
 }