CM-48119 - Add detection sorting by line number in addition to severity (#128)

Author: MarshalX

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## [Unreleased]
 
+## [v1.16.0]
+
+- Add detection sorting by line number in addition to severity
+
 ## [v1.15.0]
 
 - Add proper support for disabled modules
@@ -141,6 +145,8 @@
 
 The first stable release with the support of Secrets, SCA, TreeView, Violation Card, and more.
 
+[v1.16.0]: https://github.com/cycodehq/vscode-extension/releases/tag/v1.16.0
+
 [v1.15.0]: https://github.com/cycodehq/vscode-extension/releases/tag/v1.15.0
 
 [v1.14.0]: https://github.com/cycodehq/vscode-extension/releases/tag/v1.14.0

package.json

@@ -1,7 +1,7 @@
 {
   "name": "cycode",
   "displayName": "Cycode",
-  "version": "1.15.0",
+  "version": "1.16.0",
   "publisher": "cycode",
   "description": "Boost security in your dev lifecycle via SAST, SCA, Secrets & IaC scanning.",
   "repository": {

src/cli/models/scan-result/iac/iac-detection-details.ts

@@ -17,4 +17,8 @@ export class IacDetectionDetails extends ScanDetectionDetailsBase {
   getFilepath(): string {
     return this.fileName;
   }
+
+  getLineInFile(): number {
+    return this.lineInFile;
+  }
 }

src/cli/models/scan-result/iac/iac-detection.ts

@@ -22,6 +22,6 @@ export class IacDetection extends DetectionBase {
   }
 
   getFormattedNodeTitle(): string {
-    return `line ${this.detectionDetails.lineInFile + 1}: ${this.getFormattedMessage()}`;
+    return `line ${this.detectionDetails.getLineInFile()}: ${this.getFormattedMessage()}`;
   }
 }

src/cli/models/scan-result/sast/sast-detection-details.ts

@@ -19,4 +19,8 @@ export class SastDetectionDetails extends ScanDetectionDetailsBase {
   getFilepath(): string {
     return this.filePath.startsWith('/') ? this.filePath : `/${this.filePath}`;
   }
+
+  getLineInFile(): number {
+    return this.lineInFile;
+  }
 }

src/cli/models/scan-result/sast/sast-detection.ts

@@ -22,6 +22,6 @@ export class SastDetection extends DetectionBase {
   }
 
   getFormattedNodeTitle(): string {
-    return `line ${this.detectionDetails.lineInFile}: ${this.getFormattedMessage()}`;
+    return `line ${this.detectionDetails.getLineInFile()}: ${this.getFormattedMessage()}`;
   }
 }

src/cli/models/scan-result/sca/sca-detection-details.ts

@@ -25,4 +25,8 @@ export class ScaDetectionDetails extends ScanDetectionDetailsBase {
   getFilepath(): string {
     return this.fileName;
   }
+
+  getLineInFile(): number {
+    return this.lineInFile;
+  }
 }

src/cli/models/scan-result/sca/sca-detection.ts

@@ -23,6 +23,6 @@ export class ScaDetection extends DetectionBase {
   }
 
   getFormattedNodeTitle(): string {
-    return `line ${this.detectionDetails.lineInFile}: ${this.getFormattedTitle()}`;
+    return `line ${this.detectionDetails.getLineInFile()}: ${this.getFormattedTitle()}`;
   }
 }

src/cli/models/scan-result/scan-detection-details-base.ts

@@ -1,3 +1,4 @@
 export abstract class ScanDetectionDetailsBase {
   public abstract getFilepath(): string;
+  public abstract getLineInFile(): number;
 }

src/cli/models/scan-result/secret/secret-detection-details.ts

@@ -1,6 +1,8 @@
 import { Exclude } from 'class-transformer';
 import { ScanDetectionDetailsBase } from '../scan-detection-details-base';
 
+const IDE_ENTRY_LINE_NUMBER = 1;
+
 export class SecretDetectionDetails extends ScanDetectionDetailsBase {
   sha512: string;
   provider: string;
@@ -22,4 +24,8 @@ export class SecretDetectionDetails extends ScanDetectionDetailsBase {
   public getFilepath(): string {
     return `${this.filePath}${this.fileName}`;
   }
+
+  public getLineInFile(): number {
+    return this.line + IDE_ENTRY_LINE_NUMBER;
+  }
 }