Skip to content

Add NameVisitor #50869

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.

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ protected override void Configure()
AddVisitor(new RestClientVisitor());
AddVisitor(new ResourceVisitor());
AddVisitor(new InheritableSystemObjectModelVisitor());
AddVisitor(new NameVisitor());
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

using Microsoft.TypeSpec.Generator.ClientModel;
using Microsoft.TypeSpec.Generator.Input;
using Microsoft.TypeSpec.Generator.Providers;
using System;
using System.Diagnostics.CodeAnalysis;

namespace Azure.Generator.Management
{
internal class NameVisitor : ScmLibraryVisitor
{
protected override ModelProvider? PreVisitModel(InputModelType model, ModelProvider? type)
{
if (type is not null && TryTransformUrlToUri(model.Name, out var newName))
{
type.Update(name: newName);
}

foreach (var property in model.Properties)
{
if (TryTransformUrlToUri(property.Name, out var newPropertyName))
{
// property.Update(name: newPropertyName);
Copy link
Preview

Copilot AI Jun 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The property rename logic is commented out. If renaming model properties is intended, uncomment and implement this line; otherwise, remove the loop to avoid confusion.

Suggested change
// property.Update(name: newPropertyName);
property.Update(name: newPropertyName);

Copilot uses AI. Check for mistakes.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

}
}
return base.PreVisitModel(model, type);
}

private bool TryTransformUrlToUri(string name, [MaybeNullWhen(false)] out string newName)
{
const char i = 'i';
const string UrlSuffix = "Url";
newName = null;
if (name.Length < UrlSuffix.Length)
{
return false;
}

var span = name.AsSpan();
// check if this ends with `Url`
if (span.EndsWith(UrlSuffix.AsSpan(), StringComparison.Ordinal))
{
Span<char> newSpan = span.ToArray();
newSpan[^1] = i;

newName = new string(newSpan);
return true;
}

return false;
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

using Azure.Generator.Management;
using Azure.Generator.Management.Tests.TestHelpers;
using Azure.Generator.Tests.Common;
using Microsoft.TypeSpec.Generator.Input;
using Microsoft.TypeSpec.Generator.Providers;
using NUnit.Framework;

namespace Azure.Generator.Mgmt.Tests
{
internal class NameVisitorTests
{
private const string TestClientName = "TestClient";

[Test]
public void TestTransformUrlToUri()
{
var model = InputFactory.Model("TestModelUrl");
var responseType = InputFactory.OperationResponse(statusCodes: [200], bodytype: model);
var testNameParameter = InputFactory.Parameter("testName", InputPrimitiveType.String, location: InputRequestLocation.Path);
var operation = InputFactory.Operation(name: "get", responses: [responseType], parameters: [testNameParameter], path: "/providers/a/test/{testName}", decorators: []);

var client = InputFactory.Client(
TestClientName,
methods: [InputFactory.BasicServiceMethod("Get", operation, parameters: [testNameParameter])],
crossLanguageDefinitionId: $"Test.{TestClientName}",
decorators: []);

var plugin = ManagementMockHelpers.LoadMockPlugin(inputModels: () => [model], clients: () => [client]);
var visitor = new TestVisitor();
var type = plugin.Object.TypeFactory.CreateModel(model);
var transformedModel = visitor.InvokeVisit(model, type);
Assert.That(transformedModel?.Name, Is.EqualTo("TestModelUri"));
}

private class TestVisitor : NameVisitor
{
public ModelProvider? InvokeVisit(InputModelType model, ModelProvider? type)
{
return base.PreVisitModel(model, type);
}
}
}
}