Follow convention for naming catalogers #2277
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
wagoodman
force-pushed
the
rename-catalogers
branch
2 times, most recently
from
e978ed9 to
38f8d05
Compare
Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com>
wagoodman
force-pushed
the
rename-catalogers
branch
from
38f8d05 to
2735df6
Compare
kzantow
approved these changes
Nov 1, 2023
Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com>
GijsCalis
pushed a commit
to GijsCalis/syft
that referenced
this pull request
Feb 19, 2024
* follow convention for naming catalogers Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * fix cataloger name example Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> --------- Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR introduces a light set of conventions for cataloger names and renames the existing catalogers to follow this convention. Renames include changes to the
cataloger.Name(), constructors, and containing go package names.The following cataloger names were changed:
The following go packages within
syft/pkg/catalogerswere changed, mainly to encapsulate linux distros instead of their tooling:Constructors were augmented such that if it started (or nearly started) with the same word as the package name the prefix was removed (avoiding "package stutter", e.g.
rpm.NewRPMArchiveCataloger()->rpm.NewArchiveCataloger()).Closes #1578