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

Improved Camel Case linter to automatically detect if upper or lower … #1217

Merged
merged 5 commits into from
May 19, 2022
Merged

Improved Camel Case linter to automatically detect if upper or lower … #1217

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
84632ee
Improved Camel Case linter to automatically detect if upper or lower …
rchache May 10, 2022
b818a7f
optimizations on AUTO camel case validations
rchache May 11, 2022
cdc3955
CamelCase validator refactor strategy for deciding dominant camelcase…
rchache May 13, 2022
7f653c0
Better validation message, perform validations per service closure
rchache May 14, 2022
84be423
remove unused import
rchache May 14, 2022
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
40 changes: 36 additions & 4 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 @@ -21,6 +21,7 @@
import java.util.List;
import java.util.regex.Pattern;
import software.amazon.smithy.model.Model;
import software.amazon.smithy.model.loader.Prelude;
import software.amazon.smithy.model.node.NodeMapper;
import software.amazon.smithy.model.shapes.MemberShape;
import software.amazon.smithy.model.shapes.Shape;
Expand All @@ -42,7 +43,7 @@ public final class CamelCaseValidator extends AbstractValidator {
* CamelCase configuration settings.
*/
public static final class Config {
private MemberNameHandling memberNames = MemberNameHandling.LOWER;
private MemberNameHandling memberNames = MemberNameHandling.AUTO;

/**
* Gets how member names are to be cased.
Expand Down Expand Up @@ -87,6 +88,21 @@ Pattern getRegex() {
public String toString() {
return "lower";
}
},

/**
* Will ensure it is either all lower camel or all upper camel, but not a mixture.
*/
AUTO {
Pattern getRegex() {
// No Pattern associated with auto setting
return null;
}

@Override
public String toString() {
return "consistent";
rchache marked this conversation as resolved.
Show resolved Hide resolved
}
};

abstract Pattern getRegex();
Expand Down Expand Up @@ -135,11 +151,27 @@ public List<ValidationEvent> validate(Model model) {
shape.getType(), shape.getId().getName())))
.forEach(events::add);

Pattern isValidMemberName = config.getMemberNames().getRegex();
Pattern memberNamePattern;
if (MemberNameHandling.AUTO.equals(config.getMemberNames())) {
long upperMemberNameCount = model.shapes(MemberShape.class)
.filter(shape -> !shape.getContainer().getNamespace().equals(Prelude.NAMESPACE))
.filter(shape -> MemberNameHandling.UPPER.getRegex().matcher(shape.getMemberName()).find())
.count();
long lowerMemberNameCount = model.shapes(MemberShape.class)
.filter(shape -> !shape.getContainer().getNamespace().equals(Prelude.NAMESPACE))
.filter(shape -> MemberNameHandling.LOWER.getRegex().matcher(shape.getMemberName()).find())
.count();
rchache marked this conversation as resolved.
Show resolved Hide resolved

memberNamePattern = upperMemberNameCount > lowerMemberNameCount
? MemberNameHandling.UPPER.getRegex() : MemberNameHandling.LOWER.getRegex();
} else {
memberNamePattern = config.getMemberNames().getRegex();
}

model.shapes(MemberShape.class)
.filter(shape -> !isValidMemberName.matcher(shape.getMemberName()).find())
.filter(shape -> !memberNamePattern.matcher(shape.getMemberName()).find())
.map(shape -> danger(shape, format(
"Member shape member name, `%s`, is not %s camel case",
"Member shape member name, `%s`, is not %s camel case. (Member names must also all use consistent camel case)",
shape.getMemberName(), config.getMemberNames())))
.forEach(events::add);

Expand Down
6 changes: 6 additions & 0 deletions ...software/amazon/smithy/linters/errorfiles/camel-case-validator-defaults-test-lower.errors
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
[DANGER] ns.foo#InvalidTrait: string trait definition, `InvalidTrait`, is not lower camel case | DefaultCamelCase
[DANGER] ns.foo#bam: string shape name, `bam`, is not upper camel case | DefaultCamelCase
[DANGER] ns.foo#snake_case: string shape name, `snake_case`, is not upper camel case | DefaultCamelCase
[DANGER] ns.foo#Structure$snake_case: Member shape member name, `snake_case`, is not consistent camel case. (Member names must also all use consistent camel case) | DefaultCamelCase
[DANGER] ns.foo#upperStructureTrait$UpperCamelCase: Member shape member name, `UpperCamelCase`, is not consistent camel case. (Member names must also all use consistent camel case) | DefaultCamelCase
[DANGER] ns.foo#upperStructureTrait$snake_case: Member shape member name, `snake_case`, is not consistent camel case. (Member names must also all use consistent camel case) | DefaultCamelCase
105 changes: 105 additions & 0 deletions ...s/software/amazon/smithy/linters/errorfiles/camel-case-validator-defaults-test-lower.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
{
"smithy": "1.0",
"shapes": {
"ns.foo#InvalidTrait": {
"type": "string",
"traits": {
"smithy.api#trait": {}
}
},
"ns.foo#validTrait": {
"type": "string",
"traits": {
"smithy.api#trait": {}
}
},
"ns.foo#lowerStructureTrait": {
"type": "structure",
"members": {
"lowerCamelCase": {
"target": "ns.foo#Foo"
}
},
"traits": {
"smithy.api#trait": {}
}
},
"ns.foo#upperStructureTrait": {
"type": "structure",
"members": {
"UpperCamelCase": {
"target": "ns.foo#Foo"
},
"snake_case": {
"target": "ns.foo#Foo"
}
},
"traits": {
"smithy.api#trait": {}
}
},
"ns.foo#Foo": {
"type": "string"
},
"ns.foo#BazBar": {
"type": "string"
},
"ns.foo#bam": {
"type": "string"
},
"ns.foo#snake_case": {
"type": "string"
},
"ns.foo#Structure": {
"type": "structure",
"members": {
"lowerCamelCase": {
"target": "ns.foo#Foo"
},
"snake_case": {
"target": "ns.foo#Foo"
}
}
},
"foo.protocols#fooJson1_1": {
"type": "structure",
"members": {
"foo": {
"target": "smithy.api#String"
}
},
"traits": {
"smithy.api#trait": {
"selector": "service"
},
"smithy.api#protocolDefinition": {
"traits": [
"smithy.api#jsonName"
]
}
}
},
"foo.auth#v1_1": {
"type": "structure",
"members": {
"name": {
"target": "smithy.api#String"
}
},
"traits": {
"smithy.api#trait": {
"selector": "service"
},
"smithy.api#authDefinition": {}
}
}
},
"metadata": {
"validators": [
{
"name": "CamelCase",
"id": "DefaultCamelCase"
}
]
}
}
6 changes: 6 additions & 0 deletions ...software/amazon/smithy/linters/errorfiles/camel-case-validator-defaults-test-upper.errors
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
[DANGER] ns.foo#InvalidTrait: string trait definition, `InvalidTrait`, is not lower camel case | DefaultCamelCase
[DANGER] ns.foo#bam: string shape name, `bam`, is not upper camel case | DefaultCamelCase
[DANGER] ns.foo#snake_case: string shape name, `snake_case`, is not upper camel case | DefaultCamelCase
[DANGER] ns.foo#Structure$snake_case: Member shape member name, `snake_case`, is not consistent camel case. (Member names must also all use consistent camel case) | DefaultCamelCase
[DANGER] ns.foo#upperStructureTrait$snake_case: Member shape member name, `snake_case`, is not consistent camel case. (Member names must also all use consistent camel case) | DefaultCamelCase
[DANGER] ns.foo#Structure$lowerCamelCase: Member shape member name, `lowerCamelCase`, is not consistent camel case. (Member names must also all use consistent camel case) | DefaultCamelCase
103 changes: 103 additions & 0 deletions ...s/software/amazon/smithy/linters/errorfiles/camel-case-validator-defaults-test-upper.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
{
"smithy": "1.0",
"shapes": {
"ns.foo#InvalidTrait": {
"type": "string",
"traits": {
"smithy.api#trait": {}
}
},
"ns.foo#validTrait": {
"type": "string",
"traits": {
"smithy.api#trait": {}
}
},
"ns.foo#lowerStructureTrait": {
"type": "structure",
"traits": {
"smithy.api#trait": {}
}
},
"ns.foo#upperStructureTrait": {
"type": "structure",
"members": {
"UpperCamelCase": {
"target": "ns.foo#Foo"
},
"snake_case": {
"target": "ns.foo#Foo"
}
},
"traits": {
"smithy.api#trait": {}
}
},
"ns.foo#Foo": {
"type": "string"
},
"ns.foo#BazBar": {
"type": "string"
},
"ns.foo#bam": {
"type": "string"
},
"ns.foo#snake_case": {
"type": "string"
},
"ns.foo#Structure": {
"type": "structure",
"members": {
"lowerCamelCase": {
"target": "ns.foo#Foo"
},
"UpperCamelCase": {
"target": "ns.foo#Foo"
},
"snake_case": {
"target": "ns.foo#Foo"
}
}
},
"foo.protocols#fooJson1_1": {
"type": "structure",
"members": {
"Foo": {
"target": "smithy.api#String"
}
},
"traits": {
"smithy.api#trait": {
"selector": "service"
},
"smithy.api#protocolDefinition": {
"traits": [
"smithy.api#jsonName"
]
}
}
},
"foo.auth#v1_1": {
"type": "structure",
"members": {
"Name": {
"target": "smithy.api#String"
}
},
"traits": {
"smithy.api#trait": {
"selector": "service"
},
"smithy.api#authDefinition": {}
}
}
},
"metadata": {
"validators": [
{
"name": "CamelCase",
"id": "DefaultCamelCase"
}
]
}
}
40 changes: 26 additions & 14 deletions ...urces/software/amazon/smithy/linters/errorfiles/camel-case-validator-defaults-test.errors
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,28 @@
[DANGER] ns.foo#Structure$UpperCamelCase: Member shape member name, `UpperCamelCase`, is not lower camel case | DefaultCamelCase
[DANGER] ns.foo#Structure$lowerCamelCase: Member shape member name, `lowerCamelCase`, is not upper camel case | OppositeOfDefaults
[DANGER] ns.foo#Structure$snake_case: Member shape member name, `snake_case`, is not lower camel case | DefaultCamelCase
[DANGER] ns.foo#Structure$snake_case: Member shape member name, `snake_case`, is not upper camel case | OppositeOfDefaults
[DANGER] ns.foo#Structure$UpperCamelCase: Member shape member name, `UpperCamelCase`, is not lower camel case. (Member names must also all use consistent camel case) | LowerCamelCase
[DANGER] ns.foo#Structure$snake_case: Member shape member name, `snake_case`, is not lower camel case. (Member names must also all use consistent camel case) | LowerCamelCase
[DANGER] ns.foo#bam: string shape name, `bam`, is not upper camel case | LowerCamelCase
[DANGER] ns.foo#snake_case: string shape name, `snake_case`, is not upper camel case | LowerCamelCase
[DANGER] ns.foo#InvalidTrait: string trait definition, `InvalidTrait`, is not lower camel case | LowerCamelCase
[DANGER] ns.foo#InvalidTrait: string trait definition, `InvalidTrait`, is not lower camel case | UpperCamelCase
[DANGER] ns.foo#upperStructureTrait$UpperCamelCase: Member shape member name, `UpperCamelCase`, is not lower camel case. (Member names must also all use consistent camel case) | LowerCamelCase
[DANGER] ns.foo#upperStructureTrait$snake_case: Member shape member name, `snake_case`, is not lower camel case. (Member names must also all use consistent camel case) | LowerCamelCase
[DANGER] ns.foo#Structure$SecondUpperCamelCase: Member shape member name, `SecondUpperCamelCase`, is not lower camel case. (Member names must also all use consistent camel case) | LowerCamelCase
[DANGER] ns.foo#Structure$ThirdUpperCamelCase: Member shape member name, `ThirdUpperCamelCase`, is not lower camel case. (Member names must also all use consistent camel case) | LowerCamelCase
[DANGER] ns.foo#Structure$FourthUpperCamelCase: Member shape member name, `FourthUpperCamelCase`, is not lower camel case. (Member names must also all use consistent camel case) | LowerCamelCase
[DANGER] ns.foo#Structure$lowerCamelCase: Member shape member name, `lowerCamelCase`, is not upper camel case. (Member names must also all use consistent camel case) | UpperCamelCase
[DANGER] ns.foo#Structure$snake_case: Member shape member name, `snake_case`, is not upper camel case. (Member names must also all use consistent camel case) | UpperCamelCase
[DANGER] ns.foo#bam: string shape name, `bam`, is not upper camel case | UpperCamelCase
[DANGER] ns.foo#snake_case: string shape name, `snake_case`, is not upper camel case | UpperCamelCase
[DANGER] ns.foo#upperStructureTrait$snake_case: Member shape member name, `snake_case`, is not upper camel case. (Member names must also all use consistent camel case) | UpperCamelCase
[DANGER] ns.foo#lowerStructureTrait$lowerCamelCase: Member shape member name, `lowerCamelCase`, is not upper camel case. (Member names must also all use consistent camel case) | UpperCamelCase
[DANGER] foo.protocols#fooJson1_1$foo: Member shape member name, `foo`, is not upper camel case. (Member names must also all use consistent camel case) | UpperCamelCase
[DANGER] foo.auth#v1_1$name: Member shape member name, `name`, is not upper camel case. (Member names must also all use consistent camel case) | UpperCamelCase
[DANGER] ns.foo#InvalidTrait: string trait definition, `InvalidTrait`, is not lower camel case | DefaultCamelCase
[DANGER] ns.foo#upperStructureTrait$snake_case: Member shape member name, `snake_case`, is not consistent camel case. (Member names must also all use consistent camel case) | DefaultCamelCase
[DANGER] ns.foo#bam: string shape name, `bam`, is not upper camel case | DefaultCamelCase
[DANGER] ns.foo#bam: string shape name, `bam`, is not upper camel case | OppositeOfDefaults
[DANGER] ns.foo#snake_case: string shape name, `snake_case`, is not upper camel case | DefaultCamelCase
[DANGER] ns.foo#snake_case: string shape name, `snake_case`, is not upper camel case | OppositeOfDefaults
[DANGER] ns.foo#InvalidTrait: string trait definition, `InvalidTrait`, is not lower camel case | DefaultCamelCase
[DANGER] ns.foo#InvalidTrait: string trait definition, `InvalidTrait`, is not lower camel case | OppositeOfDefaults
[DANGER] ns.foo#upperStructureTrait$UpperCamelCase: Member shape member name, `UpperCamelCase`, is not lower camel case | DefaultCamelCase
[DANGER] ns.foo#upperStructureTrait$snake_case: Member shape member name, `snake_case`, is not lower camel case | DefaultCamelCase
[DANGER] ns.foo#upperStructureTrait$snake_case: Member shape member name, `snake_case`, is not upper camel case | OppositeOfDefaults
[DANGER] ns.foo#lowerStructureTrait$lowerCamelCase: Member shape member name, `lowerCamelCase`, is not upper camel case | OppositeOfDefaults
[DANGER] foo.protocols#fooJson1_1$foo: Member shape member name, `foo`, is not upper camel case | OppositeOfDefaults
[DANGER] foo.auth#v1_1$name: Member shape member name, `name`, is not upper camel case | OppositeOfDefaults
[DANGER] ns.foo#Structure$snake_case: Member shape member name, `snake_case`, is not consistent camel case. (Member names must also all use consistent camel case) | DefaultCamelCase
[DANGER] ns.foo#lowerStructureTrait$lowerCamelCase: Member shape member name, `lowerCamelCase`, is not consistent camel case. (Member names must also all use consistent camel case) | DefaultCamelCase
[DANGER] ns.foo#Structure$lowerCamelCase: Member shape member name, `lowerCamelCase`, is not consistent camel case. (Member names must also all use consistent camel case) | DefaultCamelCase
[DANGER] foo.protocols#fooJson1_1$foo: Member shape member name, `foo`, is not consistent camel case. (Member names must also all use consistent camel case) | DefaultCamelCase
[DANGER] foo.auth#v1_1$name: Member shape member name, `name`, is not consistent camel case. (Member names must also all use consistent camel case) | DefaultCamelCase
20 changes: 18 additions & 2 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 @@ -59,6 +59,15 @@
"UpperCamelCase": {
"target": "ns.foo#Foo"
},
"SecondUpperCamelCase": {
"target": "ns.foo#Foo"
},
"ThirdUpperCamelCase": {
"target": "ns.foo#Foo"
},
"FourthUpperCamelCase": {
"target": "ns.foo#Foo"
},
"snake_case": {
"target": "ns.foo#Foo"
}
Expand Down Expand Up @@ -101,14 +110,21 @@
"validators": [
{
"name": "CamelCase",
"id": "DefaultCamelCase"
"id": "LowerCamelCase",
"configuration": {
"memberNames": "lower"
}
},
{
"name": "CamelCase",
"id": "OppositeOfDefaults",
"id": "UpperCamelCase",
"configuration": {
"memberNames": "upper"
}
},
{
"name": "CamelCase",
"id": "DefaultCamelCase"
}
]
}
Expand Down