refactor: remove useFormat Preserve

NodeSecure · Aug 11, 2024 · 7759855 · 7759855
1 parent 8374c2c
commit 7759855
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -105,12 +105,9 @@ export interface ExtendedStrategy<
   ) => Promise<(VulnFormat | StandardVulnerability)[]>;
 }
 
-export type BaseStrategyFormat = "Preserve" | "Standard" | "OSV";
+export type BaseStrategyFormat = "Standard" | "OSV";
 
 export interface BaseStrategyOptions {
-  /**
-   * @default "Preserve"
-   */
   useFormat?: BaseStrategyFormat;
 }
 

diff --git a/src/formats/index.ts b/src/formats/index.ts
@@ -6,7 +6,9 @@ import {
   StandardizeKind
 } from "./standard/index.js";
 
-export function formatVulnsPayload(format: BaseStrategyFormat = "Preserve") {
+export function formatVulnsPayload(
+  format: BaseStrategyFormat | null = null
+) {
   return function formatVulnerabilities(
     strategy: StandardizeKind,
     vulnerabilities: any[]

diff --git a/src/strategies/types/api.ts b/src/strategies/types/api.ts
@@ -3,12 +3,9 @@ import type { Dependencies } from "./scanner.js";
 import type { StandardVulnerability } from "../../formats/standard/index.js";
 import type { Kind } from "../../constants.js";
 
-export type BaseStrategyFormat = "Preserve" | "Standard" | "OSV";
+export type BaseStrategyFormat = "Standard" | "OSV";
 
 export interface BaseStrategyOptions {
-  /**
-   * @default "Preserve"
-   */
   useFormat?: BaseStrategyFormat;
 }