Skip to content

Commit c9a83b3

Browse files
dlucdluc
committed
Fix typos and code style
1 parent 8c2e8fd commit c9a83b3

File tree

35 files changed

+193
-165
lines changed

35 files changed

+193
-165
lines changed

‎.editorconfig

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -131,12 +131,17 @@ dotnet_diagnostic.CA2201.severity = warning # Exception type System.Exception is
131131

132132
dotnet_naming_style.pascal_case_style.capitalization = pascal_case
133133

134+
dotnet_naming_style.camel_case_style.capitalization = camel_case
135+
134136
dotnet_naming_style.static_underscored.capitalization = camel_case
135137
dotnet_naming_style.static_underscored.required_prefix = s_
136138

137139
dotnet_naming_style.underscored.capitalization = camel_case
138140
dotnet_naming_style.underscored.required_prefix = _
139141

142+
dotnet_naming_style.uppercase_with_underscore_separator.capitalization = all_upper
143+
dotnet_naming_style.uppercase_with_underscore_separator.word_separator = _
144+
140145
dotnet_naming_style.end_in_async.required_prefix =
141146
dotnet_naming_style.end_in_async.required_suffix = Async
142147
dotnet_naming_style.end_in_async.capitalization = pascal_case
@@ -148,6 +153,10 @@ dotnet_naming_symbols.constant_fields.applicable_kinds = field
148153
dotnet_naming_symbols.constant_fields.applicable_accessibilities = *
149154
dotnet_naming_symbols.constant_fields.required_modifiers = const
150155

156+
dotnet_naming_symbols.local_constant.applicable_kinds = local
157+
dotnet_naming_symbols.local_constant.applicable_accessibilities = *
158+
dotnet_naming_symbols.local_constant.required_modifiers = const
159+
151160
dotnet_naming_symbols.private_static_fields.applicable_kinds = field
152161
dotnet_naming_symbols.private_static_fields.applicable_accessibilities = private
153162
dotnet_naming_symbols.private_static_fields.required_modifiers = static
@@ -161,9 +170,13 @@ dotnet_naming_symbols.any_async_methods.required_modifiers = async
161170

162171
# Rules
163172

164-
dotnet_naming_rule.constant_fields_should_be_pascal_case.severity = error
165-
dotnet_naming_rule.constant_fields_should_be_pascal_case.symbols = constant_fields
173+
dotnet_naming_rule.constant_fields_should_be_pascal_case.symbols = constant_fields
166174
dotnet_naming_rule.constant_fields_should_be_pascal_case.style = pascal_case_style
175+
dotnet_naming_rule.constant_fields_should_be_pascal_case.severity = error
176+
177+
dotnet_naming_rule.local_constant_should_be_uppercase.symbols = local_constant
178+
dotnet_naming_rule.local_constant_should_be_uppercase.style = uppercase_with_underscore_separator
179+
dotnet_naming_rule.local_constant_should_be_uppercase.severity = error
167180

168181
dotnet_naming_rule.private_static_fields_underscored.symbols = private_static_fields
169182
dotnet_naming_rule.private_static_fields_underscored.style = static_underscored

‎dotnet/Directory.Packages.props

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,23 +42,39 @@
4242
<!-- Symbols -->
4343
<PackageVersion Include="Microsoft.SourceLink.GitHub" Version="1.1.1" />
4444

45-
4645
<!-- Analyzers -->
46+
<!-- TODO: Not working with .NET Standard 2.0
47+
<PackageVersion Include="Microsoft.CodeDom.Providers.DotNetCompilerPlatform" Version="4.1.0" />
48+
<PackageReference Include="Microsoft.CodeDom.Providers.DotNetCompilerPlatform">
49+
<PrivateAssets>all</PrivateAssets>
50+
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
51+
</PackageReference>
52+
53+
<PackageVersion Include="Microsoft.CodeAnalysis.CSharp.CodeStyle" Version="4.5.0" />
54+
<PackageReference Include="Microsoft.CodeAnalysis.CSharp.CodeStyle">
55+
<PrivateAssets>all</PrivateAssets>
56+
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
57+
</PackageReference>
58+
-->
59+
4760
<PackageVersion Include="Microsoft.CodeAnalysis.Analyzers" Version="3.3.4" />
4861
<PackageReference Include="Microsoft.CodeAnalysis.Analyzers">
4962
<PrivateAssets>all</PrivateAssets>
5063
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
5164
</PackageReference>
65+
5266
<PackageVersion Include="Microsoft.VisualStudio.Threading.Analyzers" Version="17.5.22" />
5367
<PackageReference Include="Microsoft.VisualStudio.Threading.Analyzers">
5468
<PrivateAssets>all</PrivateAssets>
5569
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
5670
</PackageReference>
71+
5772
<PackageVersion Include="xunit.analyzers" Version="1.1.0" />
5873
<PackageReference Include="xunit.analyzers">
5974
<PrivateAssets>all</PrivateAssets>
6075
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
6176
</PackageReference>
77+
6278
<PackageVersion Include="Moq.Analyzers" Version="0.0.9" />
6379
<PackageReference Include="Moq.Analyzers">
6480
<PrivateAssets>all</PrivateAssets>

‎dotnet/SK-dotnet.sln.DotSettings

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,7 @@
112112
<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/Abbreviations/=UI/@EntryIndexedValue">UI</s:String>
113113
<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/Abbreviations/=UID/@EntryIndexedValue">UID</s:String>
114114
<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/Abbreviations/=URL/@EntryIndexedValue">URL</s:String>
115+
<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/Abbreviations/=XML/@EntryIndexedValue">XML</s:String>
115116
<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/Abbreviations/=YAML/@EntryIndexedValue">YAML</s:String>
116117
<s:Boolean x:Key="/Default/CodeStyle/Naming/CSharpNaming/ApplyAutoDetectedRules/@EntryValue">False</s:Boolean>
117118
<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/PredefinedNamingRules/=Constants/@EntryIndexedValue">&lt;Policy Inspect="True" Prefix="" Suffix="" Style="AaBb" /&gt;</s:String>
@@ -183,6 +184,7 @@ public void It$SOMENAME$()
183184
<s:Boolean x:Key="/Default/UserDictionary/Words/=CHATGPT/@EntryIndexedValue">True</s:Boolean>
184185
<s:Boolean x:Key="/Default/UserDictionary/Words/=childrens/@EntryIndexedValue">True</s:Boolean>
185186
<s:Boolean x:Key="/Default/UserDictionary/Words/=Chunker/@EntryIndexedValue">True</s:Boolean>
187+
<s:Boolean x:Key="/Default/UserDictionary/Words/=Ctors/@EntryIndexedValue">True</s:Boolean>
186188
<s:Boolean x:Key="/Default/UserDictionary/Words/=davinci/@EntryIndexedValue">True</s:Boolean>
187189
<s:Boolean x:Key="/Default/UserDictionary/Words/=greaterthan/@EntryIndexedValue">True</s:Boolean>
188190
<s:Boolean x:Key="/Default/UserDictionary/Words/=Joinable/@EntryIndexedValue">True</s:Boolean>
@@ -192,6 +194,7 @@ public void It$SOMENAME$()
192194
<s:Boolean x:Key="/Default/UserDictionary/Words/=myfile/@EntryIndexedValue">True</s:Boolean>
193195
<s:Boolean x:Key="/Default/UserDictionary/Words/=Notegen/@EntryIndexedValue">True</s:Boolean>
194196
<s:Boolean x:Key="/Default/UserDictionary/Words/=Qdrant/@EntryIndexedValue">True</s:Boolean>
197+
<s:Boolean x:Key="/Default/UserDictionary/Words/=Roundtrips/@EntryIndexedValue">True</s:Boolean>
195198
<s:Boolean x:Key="/Default/UserDictionary/Words/=sandboxing/@EntryIndexedValue">True</s:Boolean>
196199
<s:Boolean x:Key="/Default/UserDictionary/Words/=SK/@EntryIndexedValue">True</s:Boolean>
197200
<s:Boolean x:Key="/Default/UserDictionary/Words/=SKHTTP/@EntryIndexedValue">True</s:Boolean>

‎dotnet/src/Connectors/Connectors.UnitTests/HuggingFace/TextCompletion/HuggingFaceTextCompletionTests.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,13 @@ public class HuggingFaceTextCompletionTests : IDisposable
3232
public async Task ItReturnsCompletionCorrectlyAsync()
3333
{
3434
// Arrange
35-
const string prompt = "This is test";
35+
const string PROMPT = "This is test";
3636
CompleteRequestSettings requestSettings = new();
3737

3838
using var service = this.CreateService(HuggingFaceTestHelper.GetTestResponse("completion_test_response.json"));
3939

4040
// Act
41-
var completion = await service.CompleteAsync(prompt, requestSettings);
41+
var completion = await service.CompleteAsync(PROMPT, requestSettings);
4242

4343
// Assert
4444
Assert.Equal("This is test completion response", completion);

‎dotnet/src/Connectors/Connectors.UnitTests/HuggingFace/TextEmbedding/HuggingFaceEmbeddingGenerationTests.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ public class HuggingFaceEmbeddingGenerationTests : IDisposable
3232
public async Task ItReturnsEmbeddingsCorrectlyAsync()
3333
{
3434
// Arrange
35-
const int expectedEmbeddingCount = 1;
36-
const int expectedVectorCount = 8;
35+
const int EXPECTED_EMBEDDING_COUNT = 1;
36+
const int EXPECTED_VECTOR_COUNT = 8;
3737
List<string> data = new() { "test_string_1", "test_string_2", "test_string_3" };
3838

3939
using var service = this.CreateService(HuggingFaceTestHelper.GetTestResponse("embeddings_test_response.json"));
@@ -43,8 +43,8 @@ public async Task ItReturnsEmbeddingsCorrectlyAsync()
4343

4444
// Assert
4545
Assert.NotNull(embeddings);
46-
Assert.Equal(expectedEmbeddingCount, embeddings.Count);
47-
Assert.Equal(expectedVectorCount, embeddings.First().Count);
46+
Assert.Equal(EXPECTED_EMBEDDING_COUNT, embeddings.Count);
47+
Assert.Equal(EXPECTED_VECTOR_COUNT, embeddings.First().Count);
4848
}
4949

5050
/// <summary>

‎dotnet/src/Connectors/Connectors.UnitTests/OpenAI/Tokenizers/GPT3TokenizerTests.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -98,13 +98,13 @@ public void ItReturnsTheCorrectTokens(string text, string tokens)
9898
public void ItDoesntTimeOutForABigText()
9999
{
100100
// Arrange
101-
const int oneMb = 1000 * 1000;
101+
const int ONE_MB = 1000 * 1000;
102102
var watch = new Stopwatch();
103103
Random rnd = new();
104104
StringBuilder text = new();
105105
watch.Start();
106106
var count = 0;
107-
while (text.Length < oneMb)
107+
while (text.Length < ONE_MB)
108108
{
109109
text.Append(GenerateWord(rnd, count++));
110110
}

‎dotnet/src/Extensions/Planning.SequentialPlanner/SequentialPlannerConfig.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,17 +33,17 @@ public sealed class SequentialPlannerConfig
3333
/// <summary>
3434
/// A list of skills to exclude from the plan creation request.
3535
/// </summary>
36-
public HashSet<string> ExcludedSkills { get; } = new() { };
36+
public HashSet<string> ExcludedSkills { get; } = new();
3737

3838
/// <summary>
3939
/// A list of functions to exclude from the plan creation request.
4040
/// </summary>
41-
public HashSet<string> ExcludedFunctions { get; } = new() { };
41+
public HashSet<string> ExcludedFunctions { get; } = new();
4242

4343
/// <summary>
4444
/// A list of functions to include in the plan creation request.
4545
/// </summary>
46-
public HashSet<string> IncludedFunctions { get; } = new() { };
46+
public HashSet<string> IncludedFunctions { get; } = new();
4747

4848
/// <summary>
4949
/// The maximum number of tokens to allow in a plan.

‎dotnet/src/IntegrationTests/Connectors/HuggingFace/TextCompletion/HuggingFaceTextCompletionTests.cs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,21 +33,21 @@ public HuggingFaceTextCompletionTests()
3333
public async Task HuggingFaceLocalAndRemoteTextCompletionAsync()
3434
{
3535
// Arrange
36-
const string input = "This is test";
36+
const string INPUT = "This is test";
3737

3838
using var huggingFaceLocal = new HuggingFaceTextCompletion(new Uri(Endpoint), Model);
3939
using var huggingFaceRemote = new HuggingFaceTextCompletion(this.GetApiKey(), Model);
4040

4141
// Act
42-
var localResponse = await huggingFaceLocal.CompleteAsync(input, new CompleteRequestSettings());
43-
var remoteResponse = await huggingFaceRemote.CompleteAsync(input, new CompleteRequestSettings());
42+
var localResponse = await huggingFaceLocal.CompleteAsync(INPUT, new CompleteRequestSettings());
43+
var remoteResponse = await huggingFaceRemote.CompleteAsync(INPUT, new CompleteRequestSettings());
4444

4545
// Assert
4646
Assert.NotNull(localResponse);
4747
Assert.NotNull(remoteResponse);
4848

49-
Assert.StartsWith(input, localResponse, StringComparison.Ordinal);
50-
Assert.StartsWith(input, remoteResponse, StringComparison.Ordinal);
49+
Assert.StartsWith(INPUT, localResponse, StringComparison.Ordinal);
50+
Assert.StartsWith(INPUT, remoteResponse, StringComparison.Ordinal);
5151
}
5252

5353
private string GetApiKey()

‎dotnet/src/IntegrationTests/Connectors/OpenAI/OpenAICompletionTests.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -198,7 +198,7 @@ public async Task CompletionWithDifferentLineEndingsAsync(string lineEnding, AIS
198198
$"Put the result in between <result></result> tags{lineEnding}" +
199199
$"Input:{lineEnding}{{\"name\": \"John\", \"age\": 30}}{lineEnding}{lineEnding}Request:{lineEnding}name";
200200

201-
const string expectedAnswerContains = "<result>John</result>";
201+
const string EXPECTED_ANSWER_CONTAINS = "<result>John</result>";
202202

203203
IKernel target = Kernel.Builder.WithLogger(this._logger).Build();
204204

@@ -210,7 +210,7 @@ public async Task CompletionWithDifferentLineEndingsAsync(string lineEnding, AIS
210210
SKContext actual = await target.RunAsync(prompt, skill["Chat"]);
211211

212212
// Assert
213-
Assert.Contains(expectedAnswerContains, actual.Result, StringComparison.OrdinalIgnoreCase);
213+
Assert.Contains(EXPECTED_ANSWER_CONTAINS, actual.Result, StringComparison.OrdinalIgnoreCase);
214214
}
215215

216216
#region internals

‎dotnet/src/IntegrationTests/TemplateLanguage/PromptTemplateEngineTests.cs

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -27,54 +27,54 @@ public PromptTemplateEngineTests(ITestOutputHelper output)
2727
public async Task ItSupportsVariablesAsync()
2828
{
2929
// Arrange
30-
const string input = "template tests";
31-
const string winner = "SK";
32-
const string template = "And the winner\n of {{$input}} \nis: {{ $winner }}!";
30+
const string INPUT = "template tests";
31+
const string WINNER = "SK";
32+
const string TEMPLATE = "And the winner\n of {{$input}} \nis: {{ $winner }}!";
3333

3434
var kernel = Kernel.Builder.Build();
3535
var context = kernel.CreateNewContext();
36-
context["input"] = input;
37-
context["winner"] = winner;
36+
context["input"] = INPUT;
37+
context["winner"] = WINNER;
3838

3939
// Act
40-
var result = await this._target.RenderAsync(template, context);
40+
var result = await this._target.RenderAsync(TEMPLATE, context);
4141

4242
// Assert
43-
var expected = template
44-
.Replace("{{$input}}", input, StringComparison.OrdinalIgnoreCase)
45-
.Replace("{{ $winner }}", winner, StringComparison.OrdinalIgnoreCase);
43+
var expected = TEMPLATE
44+
.Replace("{{$input}}", INPUT, StringComparison.OrdinalIgnoreCase)
45+
.Replace("{{ $winner }}", WINNER, StringComparison.OrdinalIgnoreCase);
4646
Assert.Equal(expected, result);
4747
}
4848

4949
[Fact]
5050
public async Task ItSupportsValuesAsync()
5151
{
5252
// Arrange
53-
const string template = "And the winner\n of {{'template\ntests'}} \nis: {{ \"SK\" }}!";
54-
const string expected = "And the winner\n of template\ntests \nis: SK!";
53+
const string TEMPLATE = "And the winner\n of {{'template\ntests'}} \nis: {{ \"SK\" }}!";
54+
const string EXPECTED = "And the winner\n of template\ntests \nis: SK!";
5555

5656
var kernel = Kernel.Builder.Build();
5757
var context = kernel.CreateNewContext();
5858

5959
// Act
60-
var result = await this._target.RenderAsync(template, context);
60+
var result = await this._target.RenderAsync(TEMPLATE, context);
6161

6262
// Assert
63-
Assert.Equal(expected, result);
63+
Assert.Equal(EXPECTED, result);
6464
}
6565

6666
[Fact]
6767
public async Task ItAllowsToPassVariablesToFunctionsAsync()
6868
{
6969
// Arrange
70-
const string template = "== {{my.check123 $call}} ==";
70+
const string TEMPLATE = "== {{my.check123 $call}} ==";
7171
var kernel = Kernel.Builder.Build();
7272
kernel.ImportSkill(new MySkill(), "my");
7373
var context = kernel.CreateNewContext();
7474
context["call"] = "123";
7575

7676
// Act
77-
var result = await this._target.RenderAsync(template, context);
77+
var result = await this._target.RenderAsync(TEMPLATE, context);
7878

7979
// Assert
8080
Assert.Equal("== 123 ok ==", result);
@@ -84,13 +84,13 @@ public async Task ItAllowsToPassVariablesToFunctionsAsync()
8484
public async Task ItAllowsToPassValuesToFunctionsAsync()
8585
{
8686
// Arrange
87-
const string template = "== {{my.check123 '234'}} ==";
87+
const string TEMPLATE = "== {{my.check123 '234'}} ==";
8888
var kernel = Kernel.Builder.Build();
8989
kernel.ImportSkill(new MySkill(), "my");
9090
var context = kernel.CreateNewContext();
9191

9292
// Act
93-
var result = await this._target.RenderAsync(template, context);
93+
var result = await this._target.RenderAsync(TEMPLATE, context);
9494

9595
// Assert
9696
Assert.Equal("== 234 != 123 ==", result);

0 commit comments

Comments
 (0)