http-client-java, use kebab case for code snippet id (microsoft#7417)

weidongxu-microsoft · web-flow · commit 1300a0e179ef · 2025-05-21T08:31:59.000Z
fix microsoft#7418 Mostly to get this code snippet id be cspell friendly. Context Azure/azure-sdk-for-java#44980 (comment) Java code copied from geeksforgeeks :-)
diff --git a/packages/http-client-java/generator/http-client-generator-core/src/main/java/com/microsoft/typespec/http/client/generator/core/mapper/ProxyMethodExampleMapper.java b/packages/http-client-java/generator/http-client-generator-core/src/main/java/com/microsoft/typespec/http/client/generator/core/mapper/ProxyMethodExampleMapper.java
@@ -63,14 +63,14 @@ public ProxyMethodExample map(XmsExampleWrapper exampleWrapper) {
         return builder.build();
     }
 
-    private String buildCodeSnippetIdentifier(String operationId, String exampleName) {
-        return String
-            .format("%s.generated.%s.%s", JavaSettings.getInstance().getPackage(), getValidName(operationId),
-                getValidName(exampleName))
-            .toLowerCase(Locale.ROOT);
+    static String buildCodeSnippetIdentifier(String operationId, String exampleName) {
+        return String.format("%s.generated.%s.%s", JavaSettings.getInstance().getPackage(),
+            getValidNameInKebabCase(operationId), getValidNameInKebabCase(exampleName));
     }
 
-    private String getValidName(String exampleName) {
-        return CodeNamer.getValidName(exampleName).replace("_", "");
+    private static String getValidNameInKebabCase(String exampleName) {
+        String removeInvalidChar = CodeNamer.getValidName(exampleName).replace("_", "-");
+        // convert camelCase to kebab-case
+        return removeInvalidChar.replaceAll("([a-z])([A-Z]+)", "$1-$2").toLowerCase(Locale.ROOT);
     }
 }
diff --git a/packages/http-client-java/generator/http-client-generator-core/src/test/java/com/microsoft/typespec/http/client/generator/core/mapper/ProxyMethodExampleMapperTests.java b/packages/http-client-java/generator/http-client-generator-core/src/test/java/com/microsoft/typespec/http/client/generator/core/mapper/ProxyMethodExampleMapperTests.java
@@ -0,0 +1,21 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+package com.microsoft.typespec.http.client.generator.core.mapper;
+
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.Test;
+
+public final class ProxyMethodExampleMapperTests {
+
+    @Test
+    public void testBuildCodeSnippetIdentifier() {
+        String operationId = "OnlineExperimentation_CreateOrUpdateMetric";
+        String exampleName = "CreateOrUpdateMetric_Average";
+
+        String codeSnippetIdentifier = ProxyMethodExampleMapper.buildCodeSnippetIdentifier(operationId, exampleName);
+        Assertions.assertEquals(
+            "com.azure.mock.generated.online-experimentation-create-or-update-metric.create-or-update-metric-average",
+            codeSnippetIdentifier);
+    }
+}
diff --git a/packages/http-client-java/generator/http-client-generator-test/src/samples/java/azure/example/basic/generated/BasicAction.java b/packages/http-client-java/generator/http-client-generator-test/src/samples/java/azure/example/basic/generated/BasicAction.java
@@ -18,14 +18,14 @@ public class BasicAction {
     public static void main(String[] args) {
         AzureExampleClient azureExampleClient
             = new AzureExampleClientBuilder().endpoint("http://localhost:3000").buildClient();
-        // BEGIN:azure.example.basic.generated.basicaction.basicaction
+        // BEGIN:azure.example.basic.generated.basic-action.basic-action
         ActionResponse response = azureExampleClient.basicAction("query", "header",
             new ActionRequest("text")
                 .setModelProperty(
                     new Model().setInt32Property(1).setFloat32Property(1.5D).setEnumProperty(Enum.ENUM_VALUE1))
                 .setArrayProperty(Arrays.asList("item"))
                 .setRecordProperty(mapOf("record", "value")));
-        // END:azure.example.basic.generated.basicaction.basicaction
+        // END:azure.example.basic.generated.basic-action.basic-action
     }
 
     // Use "Map.of" if available
diff --git a/packages/http-client-java/generator/http-client-generator-test/src/samples/java/tsptest/builtin/generated/BuiltinOpRead.java b/packages/http-client-java/generator/http-client-generator-test/src/samples/java/tsptest/builtin/generated/BuiltinOpRead.java
@@ -13,8 +13,8 @@ public class BuiltinOpRead {
     public static void main(String[] args) {
         BuiltinClient builtinClient
             = new BuiltinClientBuilder().endpoint(Configuration.getGlobalConfiguration().get("ENDPOINT")).buildClient();
-        // BEGIN:tsptest.builtin.generated.builtinopread.builtinopread
+        // BEGIN:tsptest.builtin.generated.builtin-op-read.builtin-op-read
         Builtin response = builtinClient.read(null, null, null, "myFilter", null, null);
-        // END:tsptest.builtin.generated.builtinopread.builtinopread
+        // END:tsptest.builtin.generated.builtin-op-read.builtin-op-read
     }
 }
diff --git a/packages/http-client-java/generator/http-client-generator-test/src/samples/java/tsptest/flatten/generated/FlattenOpSend.java b/packages/http-client-java/generator/http-client-generator-test/src/samples/java/tsptest/flatten/generated/FlattenOpSend.java
@@ -13,8 +13,8 @@ public class FlattenOpSend {
     public static void main(String[] args) {
         FlattenClient flattenClient
             = new FlattenClientBuilder().endpoint(Configuration.getGlobalConfiguration().get("ENDPOINT")).buildClient();
-        // BEGIN:tsptest.flatten.generated.send.flattenopsend
+        // BEGIN:tsptest.flatten.generated.send.flatten-op-send
         flattenClient.send("myRequiredId", null, "myRequiredInput", 0, 50, new User("myOptionalUser"));
-        // END:tsptest.flatten.generated.send.flattenopsend
+        // END:tsptest.flatten.generated.send.flatten-op-send
     }
 }
diff --git a/packages/http-client-java/generator/http-client-generator-test/src/samples/java/tsptest/flatten/generated/FlattenOpSendLong.java b/packages/http-client-java/generator/http-client-generator-test/src/samples/java/tsptest/flatten/generated/FlattenOpSendLong.java
@@ -15,7 +15,7 @@ public class FlattenOpSendLong {
     public static void main(String[] args) {
         FlattenClient flattenClient
             = new FlattenClientBuilder().endpoint(Configuration.getGlobalConfiguration().get("ENDPOINT")).buildClient();
-        // BEGIN:tsptest.flatten.generated.sendlong.flattenopsendlong
+        // BEGIN:tsptest.flatten.generated.send-long.flatten-op-send-long
         flattenClient.sendLong(
             new SendLongOptions("myRequiredId", "myRequiredInput", 11, null, "title", SendLongRequestStatus.NOT_STARTED)
                 .setFilter("name=myName")
@@ -24,6 +24,6 @@ public static void main(String[] args) {
                 .setDataLong(13L)
                 .setDataFloat(14.0D)
                 .setDescription("description"));
-        // END:tsptest.flatten.generated.sendlong.flattenopsendlong
+        // END:tsptest.flatten.generated.send-long.flatten-op-send-long
     }
 }
diff --git a/packages/http-client-java/generator/http-client-generator-test/src/samples/java/tsptest/longrunning/generated/LongRunningCreateJob.java b/packages/http-client-java/generator/http-client-generator-test/src/samples/java/tsptest/longrunning/generated/LongRunningCreateJob.java
@@ -19,10 +19,10 @@ public static void main(String[] args) {
         LongRunningClient longRunningClient
             = new LongRunningClientBuilder().endpoint(Configuration.getGlobalConfiguration().get("ENDPOINT"))
                 .buildClient();
-        // BEGIN:tsptest.longrunning.generated.createjob.longrunningcreatejob
+        // BEGIN:tsptest.longrunning.generated.create-job.long-running-create-job
         SyncPoller<JobResult, JobResultResult> response = longRunningClient
             .beginCreateJob(new JobData(mapOf("max", 15.0D, "min", 14.0D, "average", 14.3D)).setConfiguration("{}"));
-        // END:tsptest.longrunning.generated.createjob.longrunningcreatejob
+        // END:tsptest.longrunning.generated.create-job.long-running-create-job
     }
 
     // Use "Map.of" if available
diff --git a/packages/http-client-java/generator/http-client-generator-test/src/samples/java/tsptest/model/generated/ModelOpPutNested.java b/packages/http-client-java/generator/http-client-generator-test/src/samples/java/tsptest/model/generated/ModelOpPutNested.java
@@ -13,8 +13,8 @@ public class ModelOpPutNested {
     public static void main(String[] args) {
         ModelClient modelClient
             = new ModelClientBuilder().endpoint(Configuration.getGlobalConfiguration().get("ENDPOINT")).buildClient();
-        // BEGIN:tsptest.model.generated.modelopputnested.modelopputnested
+        // BEGIN:tsptest.model.generated.model-op-put-nested.model-op-put-nested
         NestedModel response = modelClient.putNested(null);
-        // END:tsptest.model.generated.modelopputnested.modelopputnested
+        // END:tsptest.model.generated.model-op-put-nested.model-op-put-nested
     }
 }
diff --git a/packages/http-client-java/generator/http-client-generator-test/src/samples/java/tsptest/multicontenttypes/generated/SingleContentTypeUploadImageForSingleContentType.java b/packages/http-client-java/generator/http-client-generator-test/src/samples/java/tsptest/multicontenttypes/generated/SingleContentTypeUploadImageForSingleContentType.java
@@ -15,9 +15,9 @@ public static void main(String[] args) {
         SingleContentTypeClient singleContentTypeClient
             = new MultiContentTypesClientBuilder().endpoint(Configuration.getGlobalConfiguration().get("ENDPOINT"))
                 .buildSingleContentTypeClient();
-        // BEGIN:tsptest.multicontenttypes.generated.singlecontenttypeuploadimageforsinglecontenttype.singlecontenttypeuploadimageforsinglecontenttype
+        // BEGIN:tsptest.multicontenttypes.generated.single-content-type-upload-image-for-single-content-type.single-content-type-upload-image-for-single-content-type
         singleContentTypeClient.uploadImageForSingleContentType(
             BinaryData.fromBytes("\"D:\\Program Files\"".getBytes(StandardCharsets.UTF_8)));
-        // END:tsptest.multicontenttypes.generated.singlecontenttypeuploadimageforsinglecontenttype.singlecontenttypeuploadimageforsinglecontenttype
+        // END:tsptest.multicontenttypes.generated.single-content-type-upload-image-for-single-content-type.single-content-type-upload-image-for-single-content-type
     }
 }
diff --git a/packages/http-client-java/generator/http-client-generator-test/src/samples/java/tsptest/response/generated/ResponseOpExists.java b/packages/http-client-java/generator/http-client-generator-test/src/samples/java/tsptest/response/generated/ResponseOpExists.java
@@ -13,8 +13,8 @@ public static void main(String[] args) {
         ResponseClient responseClient
             = new ResponseClientBuilder().endpoint(Configuration.getGlobalConfiguration().get("ENDPOINT"))
                 .buildClient();
-        // BEGIN:tsptest.response.generated.exists.responseopexists
+        // BEGIN:tsptest.response.generated.exists.response-op-exists
         boolean response = responseClient.exists();
-        // END:tsptest.response.generated.exists.responseopexists
+        // END:tsptest.response.generated.exists.response-op-exists
     }
 }
diff --git a/packages/http-client-java/generator/http-client-generator-test/src/samples/java/tsptest/response/generated/ResponseOpListStrings.java b/packages/http-client-java/generator/http-client-generator-test/src/samples/java/tsptest/response/generated/ResponseOpListStrings.java
@@ -14,8 +14,8 @@ public static void main(String[] args) {
         ResponseClient responseClient
             = new ResponseClientBuilder().endpoint(Configuration.getGlobalConfiguration().get("ENDPOINT"))
                 .buildClient();
-        // BEGIN:tsptest.response.generated.liststrings.responseopliststrings
+        // BEGIN:tsptest.response.generated.list-strings.response-op-list-strings
         PagedIterable<String> response = responseClient.listStrings();
-        // END:tsptest.response.generated.liststrings.responseopliststrings
+        // END:tsptest.response.generated.list-strings.response-op-list-strings
     }
 }
diff --git a/packages/http-client-java/generator/http-client-generator-test/src/samples/java/tsptest/specialchars/generated/BuiltinOpRead.java b/packages/http-client-java/generator/http-client-generator-test/src/samples/java/tsptest/specialchars/generated/BuiltinOpRead.java
@@ -14,8 +14,8 @@ public static void main(String[] args) {
         SpecialCharsClient specialCharsClient
             = new SpecialCharsClientBuilder().endpoint(Configuration.getGlobalConfiguration().get("ENDPOINT"))
                 .buildClient();
-        // BEGIN:tsptest.specialchars.generated.builtinopread.builtinopread
+        // BEGIN:tsptest.specialchars.generated.builtin-op-read.builtin-op-read
         Resource response = specialCharsClient.read(null);
-        // END:tsptest.specialchars.generated.builtinopread.builtinopread
+        // END:tsptest.specialchars.generated.builtin-op-read.builtin-op-read
     }
 }
diff --git a/packages/http-client-java/generator/http-client-generator-test/src/samples/java/tsptest/specialheaders/generated/EtagHeadersListWithEtag.java b/packages/http-client-java/generator/http-client-generator-test/src/samples/java/tsptest/specialheaders/generated/EtagHeadersListWithEtag.java
@@ -15,8 +15,8 @@ public static void main(String[] args) {
         EtagHeadersClient etagHeadersClient
             = new SpecialHeadersClientBuilder().endpoint(Configuration.getGlobalConfiguration().get("ENDPOINT"))
                 .buildEtagHeadersClient();
-        // BEGIN:tsptest.specialheaders.generated.etagheaderslistwithetag.etagheaderslistwithetag
+        // BEGIN:tsptest.specialheaders.generated.etag-headers-list-with-etag.etag-headers-list-with-etag
         PagedIterable<Resource> response = etagHeadersClient.listWithEtag();
-        // END:tsptest.specialheaders.generated.etagheaderslistwithetag.etagheaderslistwithetag
+        // END:tsptest.specialheaders.generated.etag-headers-list-with-etag.etag-headers-list-with-etag
     }
 }
diff --git a/packages/http-client-java/generator/http-client-generator-test/src/samples/java/tsptest/specialheaders/generated/EtagHeadersPutWithRequestHeaders.java b/packages/http-client-java/generator/http-client-generator-test/src/samples/java/tsptest/specialheaders/generated/EtagHeadersPutWithRequestHeaders.java
@@ -15,10 +15,10 @@ public static void main(String[] args) {
         EtagHeadersClient etagHeadersClient
             = new SpecialHeadersClientBuilder().endpoint(Configuration.getGlobalConfiguration().get("ENDPOINT"))
                 .buildEtagHeadersClient();
-        // BEGIN:tsptest.specialheaders.generated.etagheadersputwithrequestheaders.etagheadersputwithrequestheaders
+        // BEGIN:tsptest.specialheaders.generated.etag-headers-put-with-request-headers.etag-headers-put-with-request-headers
         Resource response = etagHeadersClient.putWithRequestHeaders("name",
             new Resource().setDescription("This is sample for Etag headers").setType("myType"),
             new RequestConditions().setIfMatch("\"64e005\""));
-        // END:tsptest.specialheaders.generated.etagheadersputwithrequestheaders.etagheadersputwithrequestheaders
+        // END:tsptest.specialheaders.generated.etag-headers-put-with-request-headers.etag-headers-put-with-request-headers
     }
 }
diff --git a/packages/http-client-java/generator/http-client-generator-test/src/samples/java/tsptest/versioning/generated/VersioningOpList.java b/packages/http-client-java/generator/http-client-generator-test/src/samples/java/tsptest/versioning/generated/VersioningOpList.java
@@ -16,8 +16,8 @@ public static void main(String[] args) {
         VersioningClient versioningClient
             = new VersioningClientBuilder().endpoint(Configuration.getGlobalConfiguration().get("ENDPOINT"))
                 .buildClient();
-        // BEGIN:tsptest.versioning.generated.versioningoplist.versioningoplist
+        // BEGIN:tsptest.versioning.generated.versioning-op-list.versioning-op-list
         PagedIterable<Resource> response = versioningClient.list(Arrays.asList("name=name"), null);
-        // END:tsptest.versioning.generated.versioningoplist.versioningoplist
+        // END:tsptest.versioning.generated.versioning-op-list.versioning-op-list
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -63,14 +63,14 @@ public ProxyMethodExample map(XmsExampleWrapper exampleWrapper) {`
`63`	`63`	`return builder.build();`
`64`	`64`	`}`
`65`	`65`
`66`		`- private String buildCodeSnippetIdentifier(String operationId, String exampleName) {`
`67`		`- return String`
`68`		`- .format("%s.generated.%s.%s", JavaSettings.getInstance().getPackage(), getValidName(operationId),`
`69`		`- getValidName(exampleName))`
`70`		`- .toLowerCase(Locale.ROOT);`
	`66`	`+ static String buildCodeSnippetIdentifier(String operationId, String exampleName) {`
	`67`	`+ return String.format("%s.generated.%s.%s", JavaSettings.getInstance().getPackage(),`
	`68`	`+ getValidNameInKebabCase(operationId), getValidNameInKebabCase(exampleName));`
`71`	`69`	`}`
`72`	`70`
`73`		`- private String getValidName(String exampleName) {`
`74`		`- return CodeNamer.getValidName(exampleName).replace("_", "");`
	`71`	`+ private static String getValidNameInKebabCase(String exampleName) {`
	`72`	`+ String removeInvalidChar = CodeNamer.getValidName(exampleName).replace("_", "-");`
	`73`	`+ // convert camelCase to kebab-case`
	`74`	`+ return removeInvalidChar.replaceAll("([a-z])([A-Z]+)", "$1-$2").toLowerCase(Locale.ROOT);`
`75`	`75`	`}`
`76`	`76`	`}`
Original file line number	Diff line number	Diff line change
`@@ -13,8 +13,8 @@ public class BuiltinOpRead {`
`13`	`13`	`public static void main(String[] args) {`
`14`	`14`	`BuiltinClient builtinClient`
`15`	`15`	`= new BuiltinClientBuilder().endpoint(Configuration.getGlobalConfiguration().get("ENDPOINT")).buildClient();`
`16`		`- // BEGIN:tsptest.builtin.generated.builtinopread.builtinopread`
	`16`	`+ // BEGIN:tsptest.builtin.generated.builtin-op-read.builtin-op-read`
`17`	`17`	`Builtin response = builtinClient.read(null, null, null, "myFilter", null, null);`
`18`		`- // END:tsptest.builtin.generated.builtinopread.builtinopread`
	`18`	`+ // END:tsptest.builtin.generated.builtin-op-read.builtin-op-read`
`19`	`19`	`}`
`20`	`20`	`}`
Original file line number	Diff line number	Diff line change
`@@ -13,8 +13,8 @@ public class FlattenOpSend {`
`13`	`13`	`public static void main(String[] args) {`
`14`	`14`	`FlattenClient flattenClient`
`15`	`15`	`= new FlattenClientBuilder().endpoint(Configuration.getGlobalConfiguration().get("ENDPOINT")).buildClient();`
`16`		`- // BEGIN:tsptest.flatten.generated.send.flattenopsend`
	`16`	`+ // BEGIN:tsptest.flatten.generated.send.flatten-op-send`
`17`	`17`	`flattenClient.send("myRequiredId", null, "myRequiredInput", 0, 50, new User("myOptionalUser"));`
`18`		`- // END:tsptest.flatten.generated.send.flattenopsend`
	`18`	`+ // END:tsptest.flatten.generated.send.flatten-op-send`
`19`	`19`	`}`
`20`	`20`	`}`
Original file line number	Diff line number	Diff line change
`@@ -13,8 +13,8 @@ public class ModelOpPutNested {`
`13`	`13`	`public static void main(String[] args) {`
`14`	`14`	`ModelClient modelClient`
`15`	`15`	`= new ModelClientBuilder().endpoint(Configuration.getGlobalConfiguration().get("ENDPOINT")).buildClient();`
`16`		`- // BEGIN:tsptest.model.generated.modelopputnested.modelopputnested`
	`16`	`+ // BEGIN:tsptest.model.generated.model-op-put-nested.model-op-put-nested`
`17`	`17`	`NestedModel response = modelClient.putNested(null);`
`18`		`- // END:tsptest.model.generated.modelopputnested.modelopputnested`
	`18`	`+ // END:tsptest.model.generated.model-op-put-nested.model-op-put-nested`
`19`	`19`	`}`
`20`	`20`	`}`
Original file line number	Diff line number	Diff line change
`@@ -15,9 +15,9 @@ public static void main(String[] args) {`
`15`	`15`	`SingleContentTypeClient singleContentTypeClient`
`16`	`16`	`= new MultiContentTypesClientBuilder().endpoint(Configuration.getGlobalConfiguration().get("ENDPOINT"))`
`17`	`17`	`.buildSingleContentTypeClient();`
`18`		`- // BEGIN:tsptest.multicontenttypes.generated.singlecontenttypeuploadimageforsinglecontenttype.singlecontenttypeuploadimageforsinglecontenttype`
	`18`	`+ // BEGIN:tsptest.multicontenttypes.generated.single-content-type-upload-image-for-single-content-type.single-content-type-upload-image-for-single-content-type`
`19`	`19`	`singleContentTypeClient.uploadImageForSingleContentType(`
`20`	`20`	`BinaryData.fromBytes("\"D:\\Program Files\"".getBytes(StandardCharsets.UTF_8)));`
`21`		`- // END:tsptest.multicontenttypes.generated.singlecontenttypeuploadimageforsinglecontenttype.singlecontenttypeuploadimageforsinglecontenttype`
	`21`	`+ // END:tsptest.multicontenttypes.generated.single-content-type-upload-image-for-single-content-type.single-content-type-upload-image-for-single-content-type`
`22`	`22`	`}`
`23`	`23`	`}`
Original file line number	Diff line number	Diff line change
`@@ -13,8 +13,8 @@ public static void main(String[] args) {`
`13`	`13`	`ResponseClient responseClient`
`14`	`14`	`= new ResponseClientBuilder().endpoint(Configuration.getGlobalConfiguration().get("ENDPOINT"))`
`15`	`15`	`.buildClient();`
`16`		`- // BEGIN:tsptest.response.generated.exists.responseopexists`
	`16`	`+ // BEGIN:tsptest.response.generated.exists.response-op-exists`
`17`	`17`	`boolean response = responseClient.exists();`
`18`		`- // END:tsptest.response.generated.exists.responseopexists`
	`18`	`+ // END:tsptest.response.generated.exists.response-op-exists`
`19`	`19`	`}`
`20`	`20`	`}`