chore(docs): Update lists of catalogers (#1780)

Signed-off-by: Jeff Squyres <jeff@squyres.com>
2025-11-17 08:23:15 +01:00 · 2023-05-04 15:36:22 -04:00 · 2023-05-04 15:36:22 -04:00 · d63a1f5f80
commit d63a1f5f80
parent 645206735e
2 changed files with 132 additions and 105 deletions
--- a/README.md
+++ b/README.md
@ -152,39 +152,53 @@ This default behavior can be overridden with the `default-image-pull-source` con

 ##### Image Scanning:
 - alpmdb
- rpmdb
- dpkgdb
 - apkdb
- portage
- ruby-gemspec
- python-package
- php-composer-installed Cataloger
- javascript-package
- java
- go-module-binary
+- binary
 - dotnet-deps
+- dpkgdb
+- go-module-binary
+- graalvm-native-image
+- java
+- javascript-package
+- linux-kernel
+- nix-store
+- php-composer-installed
+- portage
+- python-package
+- rpm-db
+- ruby-gemspec
+- sbom

 ##### Directory Scanning:
 - alpmdb
 - apkdb
- dpkgdb
- portage
- rpmdb
- ruby-gemfile
- python-index
- python-package
- php-composer-lock
- javascript-lock
- java
- java-pom
- go-module-binary
- go-mod-file
- rust-cargo-lock
- dartlang-lock
- dotnet-deps
+- binary
 - cocoapods
 - conan
- hackage
+- dartlang-lock
+- dotnet-deps
+- dpkgdb
+- elixir-mix-lock
+- erlang-rebar-lock
+- go-mod-file
+- go-module-binary
+- graalvm-native-image
+- haskell
+- java
+- java-gradle-lockfile
+- java-pom
+- javascript-lock
+- linux-kernel
+- nix-store
+- php-composer-lock
+- portage
+- python-index
+- python-package
+- rpm-db
+- rpm-file
+- ruby-gemfile
+- rust-cargo-lock
+- sbom

 ##### Non Default:
 - cargo-auditable-binary
@ -462,26 +476,39 @@ platform: ""
 # set the list of package catalogers to use when generating the SBOM
 # default = empty (cataloger set determined automatically by the source type [image or file/directory])
 # catalogers:
-#   - ruby-gemfile
-#   - ruby-gemspec
-#   - python-index
-#   - python-package
-#   - javascript-lock
-#   - javascript-package
-#   - php-composer-installed
-#   - php-composer-lock
-#   - alpmdb
-#   - dpkgdb
-#   - rpmdb
-#   - java
-#   - apkdb
-#   - go-module-binary
-#   - go-mod-file
-#   - dartlang-lock
-#   - rust
-#   - dotnet-deps
-# rust-audit-binary scans Rust binaries built with https://github.com/Shnatsel/rust-audit
-#   - rust-audit-binary
+#   - alpmdb-cataloger
+#   - apkdb-cataloger
+#   - binary-cataloger
+#   - cargo-auditable-binary-cataloger
+#   - cocoapods-cataloger
+#   - conan-cataloger
+#   - dartlang-lock-cataloger
+#   - dotnet-deps-cataloger
+#   - dpkgdb-cataloger
+#   - elixir-mix-lock-cataloger
+#   - erlang-rebar-lock-cataloger
+#   - go-mod-file-cataloger
+#   - go-module-binary-cataloger
+#   - graalvm-native-image-cataloger
+#   - haskell-cataloger
+#   - java-cataloger
+#   - java-gradle-lockfile-cataloger
+#   - java-pom-cataloger
+#   - javascript-lock-cataloger
+#   - javascript-package-cataloger
+#   - linux-kernel-cataloger
+#   - nix-store-cataloger
+#   - php-composer-installed-cataloger
+#   - php-composer-lock-cataloger
+#   - portage-cataloger
+#   - python-index-cataloger
+#   - python-package-cataloger
+#   - rpm-db-cataloger
+#   - rpm-file-cataloger
+#   - ruby-gemfile-cataloger
+#   - ruby-gemspec-cataloger
+#   - rust-cargo-lock-cataloger
+#   - sbom-cataloger
 catalogers:

 # cataloging packages is exposed through the packages and power-user subcommands
--- a/syft/pkg/cataloger/cataloger.go
+++ b/syft/pkg/cataloger/cataloger.go
@ -41,22 +41,22 @@ const AllCatalogersPattern = "all"
 func ImageCatalogers(cfg Config) []pkg.Cataloger {
 	return filterCatalogers([]pkg.Cataloger{
 		alpm.NewAlpmdbCataloger(),
-		ruby.NewGemSpecCataloger(),
-		python.NewPythonPackageCataloger(),
-		php.NewComposerInstalledCataloger(),
-		javascript.NewPackageCataloger(),
+		apkdb.NewApkdbCataloger(),
+		binary.NewCataloger(),
 		deb.NewDpkgdbCataloger(),
-		rpm.NewRpmDBCataloger(),
+		dotnet.NewDotnetDepsCataloger(),
+		golang.NewGoModuleBinaryCataloger(cfg.Go()),
 		java.NewJavaCataloger(cfg.Java()),
 		java.NewNativeImageCataloger(),
-		apkdb.NewApkdbCataloger(),
-		golang.NewGoModuleBinaryCataloger(cfg.Go()),
-		dotnet.NewDotnetDepsCataloger(),
-		portage.NewPortageCataloger(),
-		nix.NewStoreCataloger(),
-		sbom.NewSBOMCataloger(),
-		binary.NewCataloger(),
+		javascript.NewPackageCataloger(),
 		kernel.NewLinuxKernelCataloger(cfg.Kernel()),
+		nix.NewStoreCataloger(),
+		php.NewComposerInstalledCataloger(),
+		portage.NewPortageCataloger(),
+		python.NewPythonPackageCataloger(),
+		rpm.NewRpmDBCataloger(),
+		ruby.NewGemSpecCataloger(),
+		sbom.NewSBOMCataloger(),
 	}, cfg.Catalogers)
 }

@ -64,34 +64,34 @@ func ImageCatalogers(cfg Config) []pkg.Cataloger {
 func DirectoryCatalogers(cfg Config) []pkg.Cataloger {
 	return filterCatalogers([]pkg.Cataloger{
 		alpm.NewAlpmdbCataloger(),
-		ruby.NewGemFileLockCataloger(),
-		python.NewPythonIndexCataloger(),
-		python.NewPythonPackageCataloger(),
-		php.NewComposerLockCataloger(),
-		javascript.NewLockCataloger(),
-		deb.NewDpkgdbCataloger(),
-		rpm.NewRpmDBCataloger(),
-		rpm.NewFileCataloger(),
-		java.NewJavaCataloger(cfg.Java()),
-		java.NewJavaPomCataloger(),
-		java.NewNativeImageCataloger(),
-		java.NewJavaGradleLockfileCataloger(),
 		apkdb.NewApkdbCataloger(),
-		golang.NewGoModuleBinaryCataloger(cfg.Go()),
-		golang.NewGoModFileCataloger(cfg.Go()),
-		rust.NewCargoLockCataloger(),
-		dart.NewPubspecLockCataloger(),
-		dotnet.NewDotnetDepsCataloger(),
-		swift.NewCocoapodsCataloger(),
-		cpp.NewConanCataloger(),
-		portage.NewPortageCataloger(),
-		haskell.NewHackageCataloger(),
-		sbom.NewSBOMCataloger(),
 		binary.NewCataloger(),
+		cpp.NewConanCataloger(),
+		dart.NewPubspecLockCataloger(),
+		deb.NewDpkgdbCataloger(),
+		dotnet.NewDotnetDepsCataloger(),
 		elixir.NewMixLockCataloger(),
 		erlang.NewRebarLockCataloger(),
+		golang.NewGoModFileCataloger(cfg.Go()),
+		golang.NewGoModuleBinaryCataloger(cfg.Go()),
+		haskell.NewHackageCataloger(),
+		java.NewJavaCataloger(cfg.Java()),
+		java.NewJavaGradleLockfileCataloger(),
+		java.NewJavaPomCataloger(),
+		java.NewNativeImageCataloger(),
+		javascript.NewLockCataloger(),
 		kernel.NewLinuxKernelCataloger(cfg.Kernel()),
 		nix.NewStoreCataloger(),
+		php.NewComposerLockCataloger(),
+		portage.NewPortageCataloger(),
+		python.NewPythonIndexCataloger(),
+		python.NewPythonPackageCataloger(),
+		rpm.NewFileCataloger(),
+		rpm.NewRpmDBCataloger(),
+		ruby.NewGemFileLockCataloger(),
+		rust.NewCargoLockCataloger(),
+		sbom.NewSBOMCataloger(),
+		swift.NewCocoapodsCataloger(),
 	}, cfg.Catalogers)
 }

@ -99,38 +99,38 @@ func DirectoryCatalogers(cfg Config) []pkg.Cataloger {
 func AllCatalogers(cfg Config) []pkg.Cataloger {
 	return filterCatalogers([]pkg.Cataloger{
 		alpm.NewAlpmdbCataloger(),
-		ruby.NewGemFileLockCataloger(),
-		ruby.NewGemSpecCataloger(),
-		python.NewPythonIndexCataloger(),
-		python.NewPythonPackageCataloger(),
-		javascript.NewLockCataloger(),
-		javascript.NewPackageCataloger(),
-		deb.NewDpkgdbCataloger(),
-		rpm.NewRpmDBCataloger(),
-		rpm.NewFileCataloger(),
-		java.NewJavaCataloger(cfg.Java()),
-		java.NewJavaPomCataloger(),
-		java.NewNativeImageCataloger(),
-		java.NewJavaGradleLockfileCataloger(),
 		apkdb.NewApkdbCataloger(),
-		golang.NewGoModuleBinaryCataloger(cfg.Go()),
-		golang.NewGoModFileCataloger(cfg.Go()),
-		rust.NewCargoLockCataloger(),
-		rust.NewAuditBinaryCataloger(),
-		dart.NewPubspecLockCataloger(),
-		dotnet.NewDotnetDepsCataloger(),
-		php.NewComposerInstalledCataloger(),
-		php.NewComposerLockCataloger(),
-		swift.NewCocoapodsCataloger(),
-		cpp.NewConanCataloger(),
-		portage.NewPortageCataloger(),
-		haskell.NewHackageCataloger(),
-		sbom.NewSBOMCataloger(),
 		binary.NewCataloger(),
+		cpp.NewConanCataloger(),
+		dart.NewPubspecLockCataloger(),
+		deb.NewDpkgdbCataloger(),
+		dotnet.NewDotnetDepsCataloger(),
 		elixir.NewMixLockCataloger(),
 		erlang.NewRebarLockCataloger(),
+		golang.NewGoModFileCataloger(cfg.Go()),
+		golang.NewGoModuleBinaryCataloger(cfg.Go()),
+		haskell.NewHackageCataloger(),
+		java.NewJavaCataloger(cfg.Java()),
+		java.NewJavaGradleLockfileCataloger(),
+		java.NewJavaPomCataloger(),
+		java.NewNativeImageCataloger(),
+		javascript.NewLockCataloger(),
+		javascript.NewPackageCataloger(),
 		kernel.NewLinuxKernelCataloger(cfg.Kernel()),
 		nix.NewStoreCataloger(),
+		php.NewComposerInstalledCataloger(),
+		php.NewComposerLockCataloger(),
+		portage.NewPortageCataloger(),
+		python.NewPythonIndexCataloger(),
+		python.NewPythonPackageCataloger(),
+		rpm.NewFileCataloger(),
+		rpm.NewRpmDBCataloger(),
+		ruby.NewGemFileLockCataloger(),
+		ruby.NewGemSpecCataloger(),
+		rust.NewAuditBinaryCataloger(),
+		rust.NewCargoLockCataloger(),
+		sbom.NewSBOMCataloger(),
+		swift.NewCocoapodsCataloger(),
 	}, cfg.Catalogers)
 }