Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Introduce cataloger naming conventions #1578

Closed
wagoodman opened this issue Feb 16, 2023 · 0 comments · Fixed by #2277
Closed

Introduce cataloger naming conventions #1578

wagoodman opened this issue Feb 16, 2023 · 0 comments · Fixed by #2277
Assignees
Labels
breaking-change Change is not backwards compatible bug Something isn't working
Milestone

Comments

@wagoodman
Copy link
Contributor

wagoodman commented Feb 16, 2023

Today the cataloger for java archives is called java-cataloger. Ideally there should be a more specific name such as java-archive-cataloger as it does not catalog all possible java package expressions, but only those found in archives (jar, war, ear, par, etc).

There are also inconsistencies between existing catalogers (e.g. go-mod-... vs go-module-... both exist today).

Since cataloger selection is done by name, this would be a breaking change for users explicitly passing java-cataloger.

This is one example of many. Overall there needs to be a single convention for cataloger names that applies to the cataloger.Name() values, the constructors of catalogers, and the packages catalogers are found within.

@wagoodman wagoodman added bug Something isn't working breaking-change Change is not backwards compatible labels Feb 16, 2023
@wagoodman wagoodman added this to the Stabilize user surfaces milestone Feb 16, 2023
@wagoodman wagoodman self-assigned this Oct 31, 2023
@wagoodman wagoodman changed the title Rename the java archive cataloger to be more specific introduce cataloger naming conventions Oct 31, 2023
@wagoodman wagoodman changed the title introduce cataloger naming conventions Introduce cataloger naming conventions Oct 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking-change Change is not backwards compatible bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant