refactor: consistent message across products when no issues are found

snyk · Jul 16, 2024 · e82fd27 · e82fd27
1 parent bfaecb0
commit e82fd27
Show file tree

Hide file tree

Showing 6 changed files with 15 additions and 8 deletions.
diff --git a/src/snyk/common/views/issueTreeProvider.ts b/src/snyk/common/views/issueTreeProvider.ts
@@ -294,7 +294,10 @@ export abstract class ProductIssueTreeProvider<T> extends AnalysisTreeNodeProvid
   }
 
   protected getIssueFoundText(nIssues: number, _: number): string {
-    return `Snyk found ${!nIssues ? 'no issues! ✅' : `${nIssues} issue${nIssues === 1 ? '' : 's'}`}`;
+    if (!nIssues) {
+      return '✅ Congrats! No issues found!';
+    }
+    return `Snyk found ${nIssues} issue${nIssues === 1 ? '' : 's'}`;
   }
 
   protected getIssueDescriptionText(dir: string | undefined, issueCount: number): string | undefined {

diff --git a/src/snyk/snykCode/views/securityIssueTreeProvider.ts b/src/snyk/snykCode/views/securityIssueTreeProvider.ts
@@ -55,7 +55,7 @@ export default class CodeSecurityIssueTreeProvider extends IssueTreeProvider {
       }
       return text;
     } else {
-      return '✅ Congrats! No vulnerabilities found!';
+      return '✅ Congrats! No issues found!';
     }
   }
 }
diff --git a/src/snyk/snykIac/views/iacIssueTreeProvider.ts b/src/snyk/snykIac/views/iacIssueTreeProvider.ts
@@ -49,7 +49,10 @@ export default class IacIssueTreeProvider extends ProductIssueTreeProvider<IacIs
   }
 
   getIssueFoundText(nIssues: number, _: number): string {
-    return `Snyk found ${!nIssues ? 'no issues! ✅' : `${nIssues} ${nIssues === 1 ? 'issue' : 'issues'}`}`;
+    if (!nIssues) {
+      return '✅ Congrats! No issues found!';
+    }
+    return `Snyk found ${nIssues} issue${nIssues === 1 ? '' : 's'}`;
   }
 
   filterIssues(issues: Issue<IacIssueData>[]): Issue<IacIssueData>[] {

diff --git a/src/snyk/snykOss/constants/messages.ts b/src/snyk/snykOss/constants/messages.ts
@@ -23,7 +23,7 @@ export const messages = {
   treeView: {
     cookingDependencies: 'Scanning...',
     runTest: 'Run scan for Open Source security vulnerabilities.',
-    noVulnerabilitiesFound: ' ✅ Congrats! Snyk found no vulnerabilities.',
+    noVulnerabilitiesFound: ' ✅ Congrats! No issues found!',
     singleVulnerabilityFound: 'Snyk found 1 vulnerability',
     vulnerability: 'vulnerability',
     vulnerabilities: 'vulnerabilities',

diff --git a/src/snyk/snykOss/providers/ossVulnerabilityTreeProvider.ts b/src/snyk/snykOss/providers/ossVulnerabilityTreeProvider.ts
@@ -154,9 +154,10 @@ export default class OssIssueTreeProvider extends ProductIssueTreeProvider<OssIs
   }
 
   getIssueFoundText(nIssues: number, _: number): string {
-    return `Snyk found ${
-      !nIssues ? 'no vulnerabilities! ✅' : `${nIssues} ${nIssues === 1 ? 'vulnerability' : 'vulnerabilities'}`
-    }`;
+    if (!nIssues) {
+      return '✅ Congrats! No issues found!';
+    }
+    return `Snyk found ${nIssues} issue${nIssues === 1 ? '' : 's'}`;
   }
 
   filterIssues(issues: Issue<OssIssueData>[]): Issue<OssIssueData>[] {

diff --git a/src/test/integration/issueTreeProvider.test.ts b/src/test/integration/issueTreeProvider.test.ts
@@ -82,7 +82,7 @@ suite('Code Issue Tree Provider', () => {
     sinon.stub(issueTreeProvider, 'getResultNodes').returns([]);
     const rootChildren = issueTreeProvider.getRootChildren();
     strictEqual(rootChildren.length, 2);
-    strictEqual(rootChildren[0].label, 'Snyk found no issues! ✅');
+    strictEqual(rootChildren[0].label, '✅ Congrats! No issues found!');
     strictEqual(rootChildren[1].label, 'There are no vulnerabilities fixable by Snyk DeepCode AI');
   });