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.

Sign up for GitHub

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

Jump to bottom

Exclude enum and intEnum from some linting #1133

Merged
merged 1 commit into from
Mar 15, 2022
Merged

Exclude enum and intEnum from some linting #1133

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions smithy-linters/src/main/java/software/amazon/smithy/linters/AbbreviationNameValidator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,11 +76,20 @@ private AbbreviationNameValidator(Config config) {
@Override
public List<ValidationEvent> validate(Model model) {
return model.shapes()
.flatMap(this::validateShapeName)
.flatMap(shape -> validateShapeName(model, shape))
.collect(Collectors.toList());
}

private Stream<ValidationEvent> validateShapeName(Shape shape) {
private Stream<ValidationEvent> validateShapeName(Model model, Shape shape) {
// Exclude members of enums from AbbreviationName validation,
// as they're intended to be CAPS_SNAKE.
if (shape.isMemberShape()) {
Shape container = model.expectShape(shape.asMemberShape().get().getContainer());
if (container.isEnumShape() || container.isIntEnumShape()) {
return Stream.empty();
}
}

String descriptor = shape.isMemberShape() ? "member" : "shape";
String name = shape.asMemberShape()
.map(MemberShape::getMemberName)
Expand Down
6 changes: 6 additions & 0 deletions smithy-linters/src/main/java/software/amazon/smithy/linters/CamelCaseValidator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,12 @@ public List<ValidationEvent> validate(Model model) {

Pattern isValidMemberName = config.getMemberNames().getRegex();
model.shapes(MemberShape.class)
// Exclude members of enums from CamelCase validation,
// as they're intended to be CAPS_SNAKE.
.filter(shape -> {
Shape container = model.expectShape(shape.asMemberShape().get().getContainer());
return !container.isEnumShape() && !container.isIntEnumShape();
})
.filter(shape -> !isValidMemberName.matcher(shape.getMemberName()).find())
.map(shape -> danger(shape, format(
"Member shape member name, `%s`, is not %s camel case",
Expand Down
22 changes: 22 additions & 0 deletions ...resources/software/amazon/smithy/linters/errorfiles/abbreviation-name-validator-test.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,28 @@
"target": "ns.foo#FooId"
}
}
},
"ns.foo#Enum": {
"type": "enum",
"members": {
"NAME": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "foo"
}
}
}
},
"ns.foo#IntEnum": {
"type": "intEnum",
"members": {
"NAME": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": 1
}
}
}
}
},
"metadata": {
Expand Down
22 changes: 22 additions & 0 deletions ...sources/software/amazon/smithy/linters/errorfiles/camel-case-validator-defaults-test.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,28 @@
},
"smithy.api#authDefinition": {}
}
},
"ns.foo#Enum": {
"type": "enum",
"members": {
"NAME": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "foo"
}
}
}
},
"ns.foo#IntEnum": {
"type": "intEnum",
"members": {
"NAME": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": 1
}
}
}
}
},
"metadata": {
Expand Down