Update trait examples to use smithy-trait-package plugin

custom-trait-examples/custom-annotation-trait/build.gradle.kts

@@ -1,9 +1,8 @@
 description = "A package used to define an annotation trait"
 
 plugins {
-    `java-library`
     id("com.github.spotbugs").version("4.7.1")
-    id("software.amazon.smithy.gradle.smithy-jar")
+    id("software.amazon.smithy.gradle.smithy-trait-package")
 }
 
 java {
@@ -55,11 +54,5 @@ dependencies {
     val smithyVersion: String by project
 
     smithyCli("software.amazon.smithy:smithy-cli:$smithyVersion")
-
     implementation("software.amazon.smithy:smithy-model:$smithyVersion")
 }
-
-smithy {
-    // Set to an empty list because no smithy-build config files are used
-    smithyBuildConfigs.set(project.files())
-}

custom-trait-examples/custom-annotation-trait/model/custom-trait.smithy

@@ -1,6 +1,6 @@
 $version: "2.0"
 
-namespace smithy.example
+namespace example.traits
 
 @trait(selector: "structure")
 structure special {}

custom-trait-examples/custom-annotation-trait/settings.gradle.kts

@@ -12,7 +12,7 @@ rootProject.name = "custom-annotation-trait"
 pluginManagement {
     val smithyGradleVersion: String by settings
     plugins {
-        id("software.amazon.smithy.gradle.smithy-jar").version(smithyGradleVersion)
+        id("software.amazon.smithy.gradle.smithy-trait-package").version(smithyGradleVersion)
     }
 
     repositories {

custom-trait-examples/custom-annotation-trait/smithy-build.json

@@ -1,3 +1,13 @@
 {
-  "version": "1.0"
-}
+  "version": "1.0",
+  "plugins": {
+    "trait-codegen": {
+      "package": "io.examples.traits",
+      "namespace": "example.traits",
+      "header": [
+        "Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.",
+        "SPDX-License-Identifier: MIT-0"
+      ]
+    }
+  }
+}

custom-trait-examples/custom-string-trait/README.md

@@ -29,7 +29,7 @@ Finally, update the `io.smithy.examples.traits.JsonNameTrait` entry in the
 `src/main/resources/META-INF/services/software.amazon.smithy.model.traits.TraitService` file to reflect the
 new name and package of your updated trait.
 
-If you updated the validator, also update the `io.smithy.examples.validators.JsonNameTraitValidator` 
+If you updated the validator, also update the `io.examples.validators.JsonNameTraitValidator` 
 entry in the `src/main/resources/META-INF/services/software.amazon.smithy.model.validation.Validator`
 file as well.
 
@@ -46,4 +46,4 @@ depend on this package.
 
 ## Distribution
 If you want to distribute the JAR file create by this package, consider adding the
-[maven-publish](https://docs.gradle.org/current/userguide/publishing_maven.html) plugin to the project to publish the JAR to a maven repository.
+[maven-publish](https://docs.gradle.org/current/userguide/publishing_maven.html) plugin to the project to publish the JAR to a maven repository.

custom-trait-examples/custom-string-trait/build.gradle.kts

@@ -2,9 +2,8 @@
 description = "Package for a custom Smithy string trait"
 
 plugins {
-    `java-library`
     id("com.github.spotbugs").version("4.7.3")
-    id("software.amazon.smithy.gradle.smithy-jar")
+    id("software.amazon.smithy.gradle.smithy-trait-package")
 }
 
 java {
@@ -63,8 +62,3 @@ dependencies {
     testImplementation("org.junit.jupiter:junit-jupiter-engine:5.10.3")
     testImplementation("org.junit.jupiter:junit-jupiter-params:5.10.3")
 }
-
-smithy {
-    // Set to an empty list because no smithy-build config files are used
-    smithyBuildConfigs.set(project.files())
-}

custom-trait-examples/custom-string-trait/model/custom-trait.smithy

@@ -1,6 +1,6 @@
 $version: "2.0"
 
-namespace io.smithy.example
+namespace example.traits
 
 @trait(selector: "member")
 string jsonName

custom-trait-examples/custom-string-trait/settings.gradle.kts

@@ -12,7 +12,7 @@ rootProject.name = "custom-string-trait"
 pluginManagement {
     val smithyGradleVersion: String by settings
     plugins {
-        id("software.amazon.smithy.gradle.smithy-jar").version(smithyGradleVersion)
+        id("software.amazon.smithy.gradle.smithy-trait-package").version(smithyGradleVersion)
     }
 
     repositories {

custom-trait-examples/custom-string-trait/smithy-build.json

@@ -0,0 +1,13 @@
+{
+  "version": "1.0",
+  "plugins": {
+    "trait-codegen": {
+      "package": "io.examples.traits",
+      "namespace": "example.traits",
+      "header": [
+        "Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.",
+        "SPDX-License-Identifier: MIT-0"
+      ]
+    }
+  }
+}

custom-trait-examples/custom-string-trait/src/main/java/io/smithy/examples/validators/JsonNameTraitValidator.java → custom-trait-examples/custom-string-trait/src/main/java/io/examples/validators/JsonNameTraitValidator.java

@@ -3,9 +3,9 @@
  * SPDX-License-Identifier: MIT-0
  */
 
-package io.smithy.examples.validators;
+package io.examples.validators;
 
-import io.smithy.examples.traits.JsonNameTrait;
+import io.examples.traits.JsonNameTrait;
 import java.util.List;
 import java.util.stream.Collectors;
 import software.amazon.smithy.model.Model;
@@ -17,11 +17,11 @@ public class JsonNameTraitValidator extends AbstractValidator {
     @Override
     public List<ValidationEvent> validate(Model model) {
         return model.shapes()
-            .filter(shape -> shape.hasTrait(JsonNameTrait.class))
-            .filter(Shape::isMemberShape)
-            .filter(shape -> shape.hasTrait(software.amazon.smithy.model.traits.JsonNameTrait.class))
-            .map(shape -> error(shape,
-                "This shape cannot apply both the root jsonName trait and the custom jsonName trait!"))
-            .collect(Collectors.toList());
+                .filter(shape -> shape.hasTrait(JsonNameTrait.class))
+                .filter(Shape::isMemberShape)
+                .filter(shape -> shape.hasTrait(software.amazon.smithy.model.traits.JsonNameTrait.class))
+                .map(shape -> error(shape,
+                        "This shape cannot apply both the root jsonName trait and the custom jsonName trait!"))
+                .collect(Collectors.toList());
     }
 }

custom-trait-examples/custom-string-trait/src/main/resources/META-INF/services/software.amazon.smithy.model.validation.Validator

@@ -1 +1 @@
-io.smithy.examples.validators.JsonNameTraitValidator
+io.examples.validators.JsonNameTraitValidator

custom-trait-examples/custom-string-trait/src/test/java/io/smithy/examples/traits/JsonNameTraitTest.java → custom-trait-examples/custom-string-trait/src/test/java/io/examples/traits/JsonNameTraitTest.java

@@ -1,8 +1,9 @@
-package io.smithy.examples.traits;
+package io.examples.traits;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertTrue;
 
+import java.util.Objects;
 import org.junit.jupiter.api.Test;
 import software.amazon.smithy.model.Model;
 import software.amazon.smithy.model.shapes.Shape;
@@ -13,7 +14,7 @@ public class JsonNameTraitTest {
     public void loadsFromModel() {
         Model result = Model.assembler()
             .discoverModels(getClass().getClassLoader())
-            .addImport(getClass().getResource("custom-trait-test.smithy"))
+            .addImport(Objects.requireNonNull(getClass().getResource("custom-trait-test.smithy")))
             .assemble()
             .unwrap();
 

custom-trait-examples/custom-string-trait/src/test/java/io/smithy/examples/validators/JsonNameTraitValidatorTest.java → custom-trait-examples/custom-string-trait/src/test/java/io/examples/validators/JsonNameTraitValidatorTest.java

@@ -1,7 +1,8 @@
-package io.smithy.examples.validators;
+package io.examples.validators;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
 
+import java.util.Objects;
 import org.junit.jupiter.api.Test;
 import software.amazon.smithy.model.Model;
 import software.amazon.smithy.model.shapes.ShapeId;
@@ -13,14 +14,14 @@ public class JsonNameTraitValidatorTest {
     public void dectectsViolationModel() {
         ValidatedResult<Model> validatedResult = Model.assembler()
             .discoverModels(getClass().getClassLoader())
-            .addImport(getClass().getResource("validator-test.smithy"))
+            .addImport(Objects.requireNonNull(getClass().getResource("validator-test.smithy")))
             .assemble();
         var validationEvents = validatedResult.getValidationEvents();
 
         assertEquals(validationEvents.size(), 1);
         var validationEvent = validationEvents.get(0);
         assertEquals(validationEvent.getId(), "JsonNameTrait");
         assertEquals(validationEvent.getSeverity(), Severity.ERROR);
-        assertEquals(validationEvent.getShapeId().get(), ShapeId.from("io.smithy.example.test#TestStructure$testMember"));
+        assertEquals(validationEvent.getShapeId().get(), ShapeId.from("example.test#TestStructure$testMember"));
     }
 }

custom-trait-examples/custom-string-trait/src/test/resources/io/smithy/examples/traits/custom-trait-test.smithy → custom-trait-examples/custom-string-trait/src/test/resources/io/examples/traits/custom-trait-test.smithy

@@ -2,7 +2,7 @@ $version: "2.0"
 
 namespace io.smithy.example.test
 
-use io.smithy.example#jsonName
+use example.traits#jsonName
 
 structure TestStructure {
     @jsonName("TESTING")

custom-trait-examples/custom-string-trait/src/test/resources/io/smithy/examples/validators/validator-test.smithy → custom-trait-examples/custom-string-trait/src/test/resources/io/examples/validators/validator-test.smithy

@@ -1,9 +1,9 @@
 $version: "2.0"
 
-namespace io.smithy.example.test
+namespace example.test
 
 structure TestStructure {
-    @io.smithy.example#jsonName("TESTING")
+    @example.traits#jsonName("TESTING")
     @smithy.api#jsonName("OOPS! DUPLICATION!")
     testMember: String
 }

custom-trait-examples/custom-structure-trait/README.md

@@ -29,7 +29,7 @@ Finally, update the `io.smithy.examples.traits.ResourceMetadataTrait` entry in t
 `src/main/resources/META-INF/services/software.amazon.smithy.model.traits.TraitService` file to reflect the
 new name and package of your updated trait.
 
-If you updated the validator, also update the `io.smithy.examples.validators.ResourceMetadataTraitValidator`
+If you updated the validator, also update the `io.examples.validators.ResourceMetadataTraitValidator`
 entry in the `src/main/resources/META-INF/services/software.amazon.smithy.model.validation.Validator`
 file as well.
 
@@ -46,4 +46,4 @@ depend on this package.
 
 ## Distribution
 If you want to distribute the JAR file create by this package, consider adding the
-[maven-publish](https://docs.gradle.org/current/userguide/publishing_maven.html) plugin to the project to publish the JAR to a maven repository.
+[maven-publish](https://docs.gradle.org/current/userguide/publishing_maven.html) plugin to the project to publish the JAR to a maven repository.

custom-trait-examples/custom-structure-trait/build.gradle.kts

@@ -2,9 +2,8 @@
 description = "Custom Smithy structure trait with multiple inputs"
 
 plugins {
-    `java-library`
     id("com.github.spotbugs").version("4.7.3")
-    id("software.amazon.smithy.gradle.smithy-jar")
+    id("software.amazon.smithy.gradle.smithy-trait-package")
 }
 
 java {
@@ -41,6 +40,11 @@ spotbugs {
     }
 }
 
+// Exclude generated code from checkstyle
+tasks.withType<Checkstyle>().configureEach {
+    exclude("io/examples/traits/**")
+}
+
 repositories {
     mavenLocal()
     mavenCentral()
@@ -58,8 +62,3 @@ dependencies {
     testImplementation("org.junit.jupiter:junit-jupiter-engine:5.10.3")
     testImplementation("org.junit.jupiter:junit-jupiter-params:5.10.3")
 }
-
-smithy {
-    // Set to an empty list because no smithy-build config files are used
-    smithyBuildConfigs.set(project.files())
-}

custom-trait-examples/custom-structure-trait/model/custom-trait.smithy

@@ -1,6 +1,6 @@
 $version: "2.0"
 
-namespace io.smithy.example
+namespace example.traits
 
 @trait(
     selector: "resource"
@@ -31,6 +31,8 @@ enum ResourceType {
 
 @private
 list StructureIdList {
-    @idRef(failWhenMissing: true, selector: "structure")
-    member: String
+    member: IdRefString
 }
+
+@idRef(failWhenMissing: true, selector: "structure")
+string IdRefString

custom-trait-examples/custom-structure-trait/settings.gradle.kts

@@ -2,7 +2,7 @@
 pluginManagement {
     val smithyGradleVersion: String by settings
     plugins {
-        id("software.amazon.smithy.gradle.smithy-jar").version(smithyGradleVersion)
+        id("software.amazon.smithy.gradle.smithy-trait-package").version(smithyGradleVersion)
     }
 
     repositories {

custom-trait-examples/custom-structure-trait/smithy-build.json

@@ -0,0 +1,13 @@
+{
+  "version": "1.0",
+  "plugins": {
+    "trait-codegen": {
+      "package": "io.examples.traits",
+      "namespace": "example.traits",
+      "header": [
+        "Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.",
+        "SPDX-License-Identifier: MIT-0"
+      ]
+    }
+  }
+}

custom-trait-examples/custom-structure-trait/src/main/java/io/smithy/examples/validators/ResourceMetadataTraitValidator.java → custom-trait-examples/custom-structure-trait/src/main/java/io/examples/validators/ResourceMetadataTraitValidator.java

@@ -3,9 +3,9 @@
  * SPDX-License-Identifier: MIT-0
  */
 
-package io.smithy.examples.validators;
+package io.examples.validators;
 
-import io.smithy.examples.traits.ResourceMetadataTrait;
+import io.examples.traits.ResourceMetadataTrait;
 import java.util.List;
 import java.util.stream.Collectors;
 import software.amazon.smithy.model.Model;