chore: deprecate parser functions in favor of their extract equivalen…

…ts (#1253)

I think it's time to start getting the word out...

Resolves #1021

pkg/lockfile/apk-installed.go

@@ -56,6 +56,7 @@ func parseApkPackageGroup(group []string) PackageDetails {
 	return pkg
 }
 
+// Deprecated: use ApkInstalledExtractor.Extract instead
 func ParseApkInstalled(pathToLockfile string) ([]PackageDetails, error) {
 	return extractFromFile(pathToLockfile, ApkInstalledExtractor{})
 }

pkg/lockfile/dpkg-status.go

@@ -101,6 +101,7 @@ func parseDpkgPackageGroup(group []string) PackageDetails {
 	return pkg
 }
 
+// Deprecated: use DpkgStatusExtractor.Extract instead
 func ParseDpkgStatus(pathToLockfile string) ([]PackageDetails, error) {
 	return extractFromFile(pathToLockfile, DpkgStatusExtractor{})
 }

pkg/lockfile/osv-vuln-results.go

@@ -7,6 +7,7 @@ import (
 	"github.com/google/osv-scanner/pkg/models"
 )
 
+// Deprecated: use OSVScannerResultsExtractor.Extract instead
 func ParseOSVScannerResults(pathToLockfile string) ([]PackageDetails, error) {
 	return extractFromFile(pathToLockfile, OSVScannerResultsExtractor{})
 }

pkg/lockfile/parse-cargo-lock.go

@@ -55,6 +55,7 @@ func init() {
 	registerExtractor("Cargo.lock", CargoLockExtractor{})
 }
 
+// Deprecated: use CargoLockExtractor.Extract instead
 func ParseCargoLock(pathToLockfile string) ([]PackageDetails, error) {
 	return extractFromFile(pathToLockfile, CargoLockExtractor{})
 }

pkg/lockfile/parse-composer-lock.go

@@ -74,6 +74,7 @@ func init() {
 	registerExtractor("composer.lock", ComposerLockExtractor{})
 }
 
+// Deprecated: use ComposerLockExtractor.Extract instead
 func ParseComposerLock(pathToLockfile string) ([]PackageDetails, error) {
 	return extractFromFile(pathToLockfile, ComposerLockExtractor{})
 }

pkg/lockfile/parse-conan-lock.go

@@ -197,6 +197,7 @@ func init() {
 	registerExtractor("conan.lock", ConanLockExtractor{})
 }
 
+// Deprecated: use ConanLockExtractor.Extract instead
 func ParseConanLock(pathToLockfile string) ([]PackageDetails, error) {
 	return extractFromFile(pathToLockfile, ConanLockExtractor{})
 }

pkg/lockfile/parse-gemfile-lock.go

@@ -188,6 +188,7 @@ func init() {
 	registerExtractor("Gemfile.lock", GemfileLockExtractor{})
 }
 
+// Deprecated: use GemfileLockExtractor.Extract instead
 func ParseGemfileLock(pathToLockfile string) ([]PackageDetails, error) {
 	return extractFromFile(pathToLockfile, GemfileLockExtractor{})
 }

pkg/lockfile/parse-go-lock.go

@@ -102,6 +102,7 @@ func init() {
 	registerExtractor("go.mod", GoLockExtractor{})
 }
 
+// Deprecated: use GoLockExtractor.Extract instead
 func ParseGoLock(pathToLockfile string) ([]PackageDetails, error) {
 	return extractFromFile(pathToLockfile, GoLockExtractor{})
 }

pkg/lockfile/parse-gradle-lock.go

@@ -82,6 +82,7 @@ func init() {
 	registerExtractor("gradle.lockfile", GradleLockExtractor{})
 }
 
+// Deprecated: use GradleLockExtractor.Extract instead
 func ParseGradleLock(pathToLockfile string) ([]PackageDetails, error) {
 	return extractFromFile(pathToLockfile, GradleLockExtractor{})
 }

pkg/lockfile/parse-gradle-verification-metadata.go

@@ -50,6 +50,7 @@ func init() {
 	registerExtractor("gradle/verification-metadata.xml", GradleVerificationMetadataExtractor{})
 }
 
+// Deprecated: use GradleVerificationMetadataExtractor.Extract instead
 func ParseGradleVerificationMetadata(pathToLockfile string) ([]PackageDetails, error) {
 	return extractFromFile(pathToLockfile, GradleVerificationMetadataExtractor{})
 }

pkg/lockfile/parse-maven-lock.go

@@ -163,6 +163,7 @@ func init() {
 	registerExtractor("pom.xml", MavenLockExtractor{})
 }
 
+// Deprecated: use MavenLockExtractor.Extract instead
 func ParseMavenLock(pathToLockfile string) ([]PackageDetails, error) {
 	return extractFromFile(pathToLockfile, MavenLockExtractor{})
 }

pkg/lockfile/parse-mix-lock.go

@@ -85,6 +85,7 @@ func init() {
 	registerExtractor("mix.lock", MixLockExtractor{})
 }
 
+// Deprecated: use MixLockExtractor.Extract instead
 func ParseMixLock(pathToLockfile string) ([]PackageDetails, error) {
 	return extractFromFile(pathToLockfile, MixLockExtractor{})
 }

pkg/lockfile/parse-npm-lock.go

@@ -242,6 +242,7 @@ func init() {
 	registerExtractor("package-lock.json", NpmLockExtractor{})
 }
 
+// Deprecated: use NpmLockExtractor.Extract instead
 func ParseNpmLock(pathToLockfile string) ([]PackageDetails, error) {
 	return extractFromFile(pathToLockfile, NpmLockExtractor{})
 }

pkg/lockfile/parse-nuget-lock.go

@@ -80,6 +80,7 @@ func init() {
 	registerExtractor("packages.lock.json", NuGetLockExtractor{})
 }
 
+// Deprecated: use NuGetLockExtractor.Extract instead
 func ParseNuGetLock(pathToLockfile string) ([]PackageDetails, error) {
 	return extractFromFile(pathToLockfile, NuGetLockExtractor{})
 }

pkg/lockfile/parse-pdm-lock.go

@@ -74,6 +74,7 @@ func init() {
 	registerExtractor("pdm.lock", PdmLockExtractor{})
 }
 
+// Deprecated: use PdmLockExtractor.Extract instead
 func ParsePdmLock(pathToLockfile string) ([]PackageDetails, error) {
 	return extractFromFile(pathToLockfile, PdmLockExtractor{})
 }

pkg/lockfile/parse-pipenv-lock.go

@@ -72,6 +72,7 @@ func init() {
 	registerExtractor("Pipfile.lock", PipenvLockExtractor{})
 }
 
+// Deprecated: use PipenvLockExtractor.Extract instead
 func ParsePipenvLock(pathToLockfile string) ([]PackageDetails, error) {
 	return extractFromFile(pathToLockfile, PipenvLockExtractor{})
 }

pkg/lockfile/parse-pnpm-lock.go

@@ -215,6 +215,7 @@ func init() {
 	registerExtractor("pnpm-lock.yaml", PnpmLockExtractor{})
 }
 
+// Deprecated: use PnpmLockExtractor.Extract instead
 func ParsePnpmLock(pathToLockfile string) ([]PackageDetails, error) {
 	return extractFromFile(pathToLockfile, PnpmLockExtractor{})
 }

pkg/lockfile/parse-poetry-lock.go

@@ -67,6 +67,7 @@ func init() {
 	registerExtractor("poetry.lock", PoetryLockExtractor{})
 }
 
+// Deprecated: use PoetryLockExtractor.Extract instead
 func ParsePoetryLock(pathToLockfile string) ([]PackageDetails, error) {
 	return extractFromFile(pathToLockfile, PoetryLockExtractor{})
 }

pkg/lockfile/parse-pubspec-lock.go

@@ -111,6 +111,7 @@ func init() {
 	registerExtractor("pubspec.lock", PubspecLockExtractor{})
 }
 
+// Deprecated: use PubspecLockExtractor.Extract instead
 func ParsePubspecLock(pathToLockfile string) ([]PackageDetails, error) {
 	return extractFromFile(pathToLockfile, PubspecLockExtractor{})
 }

pkg/lockfile/parse-renv-lock.go

@@ -59,6 +59,7 @@ func init() {
 	registerExtractor("renv.lock", RenvLockExtractor{})
 }
 
+// Deprecated: use RenvLockExtractor.Extract instead
 func ParseRenvLock(pathToLockfile string) ([]PackageDetails, error) {
 	return extractFromFile(pathToLockfile, RenvLockExtractor{})
 }

pkg/lockfile/parse-requirements-txt.go

@@ -203,6 +203,7 @@ func init() {
 	registerExtractor("requirements.txt", RequirementsTxtExtractor{})
 }
 
+// Deprecated: use RequirementsTxtExtractor.Extract instead
 func ParseRequirementsTxt(pathToLockfile string) ([]PackageDetails, error) {
 	return extractFromFile(pathToLockfile, RequirementsTxtExtractor{})
 }

pkg/lockfile/parse-yarn-lock.go

@@ -212,6 +212,7 @@ func init() {
 	registerExtractor("yarn.lock", YarnLockExtractor{})
 }
 
+// Deprecated: use YarnLockExtractor.Extract instead
 func ParseYarnLock(pathToLockfile string) ([]PackageDetails, error) {
 	return extractFromFile(pathToLockfile, YarnLockExtractor{})
 }