Make UnreferencedShape an opt-in linter instead #2119
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
JordonPhillips
requested changes
Jan 31, 2024
smithy-linters/src/main/java/software/amazon/smithy/linters/UnreferencedShapeValidator.java
Outdated
Show resolved
Hide resolved
UnreferencedShape is no longer an on-by-default validator that ensures shapes must be connected to a service shape. There are plenty of cases where teams might create models that define shared shapes and don't necessarily connect those shapes to services. Emitting an UnreferencedShape validation event for these cases is harmless, but also annoying and desensitizing developers for when a shape is actually unreferenced. This commit instead adds a new smithy-model linter called UnreferencedShape that allows an optional "rootShapeSelector" to be provided that defines the "root" shapes that all other shape must be connected to. It defaults to "service". You might want to customize this to indicate that other shapes are your roots (e.g., maybe there is a specific trait that makes a shape a root). Closes #2093
mtdowling
force-pushed
the
customize-unreferenced-shapes
branch
from
be1a157
to
bfd19a8
Compare
kstich
reviewed
Feb 8, 2024
...hy-model/src/test/java/software/amazon/smithy/model/loader/ValidationEventDecoratorTest.java
Outdated
Show resolved
Hide resolved
…/ValidationEventDecoratorTest.java Co-authored-by: Kevin Stich <[email protected]>
kstich
approved these changes
Feb 8, 2024
kstich
requested review from
JordonPhillips
and removed request for
sugmanue and
JordonPhillips
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.
UnreferencedShape is no longer an on-by-default validator that ensures shapes must be connected to a service shape. There are plenty of cases where teams might create models that define shared shapes and don't necessarily connect those shapes to services. Emitting an UnreferencedShape validation event for these cases is harmless, but also annoying and desensitizing developers for when a shape is actually unreferenced.
This commit instead adds a new smithy-linters validator called UnreferencedShape that allows an optional "rootShapeSelector" to be provided that defines the "root" shapes that all other shape must be connected to. It defaults to "service". You might want to customize this to indicate that other shapes are your roots (e.g., maybe there is a specific trait that makes a shape a root).
Closes #2093
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.