Skip to content

Commit 4f816f1

Browse files
authored
Rename analyzers RCS0030, RCS0033 (#1314)
1 parent 3b15578 commit 4f816f1

File tree

10 files changed

+51
-48
lines changed

10 files changed

+51
-48
lines changed

ChangeLog.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
2020
- Group code fix "Change accessibility to ..." ([PR](https://github.com/dotnet/roslynator/pull/1305))
2121
- [CLI] Bump Roslyn to 4.8.0 ([PR](https://github.com/dotnet/roslynator/pull/1307)).
2222
- Group refactoring "Remove members above/below'" ([PR](https://github.com/dotnet/roslynator/pull/1308))
23+
- Rename analyzers ([PR](https://github.com/dotnet/roslynator/pull/1314))
24+
- "Add new line before embedded statement" -> "Put embedded statement on its own line" ([RCS0030](https://josefpihrt.github.io/docs/roslynator/analyzers/RCS0030))
25+
- "Add new line before statement" -> "Put statement on its own line" ([RCS0033](https://josefpihrt.github.io/docs/roslynator/analyzers/RCS0033))
2326

2427
### Fixed
2528

src/Analyzers.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -782,8 +782,8 @@ namespace N
782782
</Analyzer>
783783
<Analyzer>
784784
<Id>RCS0030</Id>
785-
<Identifier>AddNewLineBeforeEmbeddedStatement</Identifier>
786-
<Title>Add new line before embedded statement</Title>
785+
<Identifier>PutEmbeddedStatementOnItsOwnLine</Identifier>
786+
<Title>Put embedded statement on its own line</Title>
787787
<DefaultSeverity>Info</DefaultSeverity>
788788
<IsEnabledByDefault>false</IsEnabledByDefault>
789789
<Samples>
@@ -850,8 +850,8 @@ namespace N
850850
</Analyzer>
851851
<Analyzer>
852852
<Id>RCS0033</Id>
853-
<Identifier>AddNewLineBeforeStatement</Identifier>
854-
<Title>Add new line before statement</Title>
853+
<Identifier>PutStatementOnItsOwnLine</Identifier>
854+
<Title>Put statement on its own line</Title>
855855
<DefaultSeverity>Info</DefaultSeverity>
856856
<IsEnabledByDefault>false</IsEnabledByDefault>
857857
<Samples>

src/Formatting.Analyzers.CodeFixes/CSharp/StatementCodeFixProvider.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ public override ImmutableArray<string> FixableDiagnosticIds
2323
get
2424
{
2525
return ImmutableArray.Create(
26-
DiagnosticIdentifiers.AddNewLineBeforeStatement,
27-
DiagnosticIdentifiers.AddNewLineBeforeEmbeddedStatement,
26+
DiagnosticIdentifiers.PutStatementOnItsOwnLine,
27+
DiagnosticIdentifiers.PutEmbeddedStatementOnItsOwnLine,
2828
DiagnosticIdentifiers.AddNewLineAfterSwitchLabel,
2929
DiagnosticIdentifiers.AddBlankLineAfterEmbeddedStatement);
3030
}
@@ -42,8 +42,8 @@ public override async Task RegisterCodeFixesAsync(CodeFixContext context)
4242

4343
switch (diagnostic.Id)
4444
{
45-
case DiagnosticIdentifiers.AddNewLineBeforeStatement:
46-
case DiagnosticIdentifiers.AddNewLineBeforeEmbeddedStatement:
45+
case DiagnosticIdentifiers.PutStatementOnItsOwnLine:
46+
case DiagnosticIdentifiers.PutEmbeddedStatementOnItsOwnLine:
4747
case DiagnosticIdentifiers.AddNewLineAfterSwitchLabel:
4848
{
4949
CodeAction codeAction = CodeAction.Create(

src/Formatting.Analyzers/CSharp/DiagnosticIdentifiers.Generated.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,10 @@ public static partial class DiagnosticIdentifiers
3232
public const string PlaceNewLineAfterOrBeforeBinaryOperator = "RCS0027";
3333
public const string PlaceNewLineAfterOrBeforeConditionalOperator = "RCS0028";
3434
public const string PutConstructorInitializerOnItsOwnLine = "RCS0029";
35-
public const string AddNewLineBeforeEmbeddedStatement = "RCS0030";
35+
public const string PutEmbeddedStatementOnItsOwnLine = "RCS0030";
3636
public const string PutEnumMemberOnItsOwnLine = "RCS0031";
3737
public const string PlaceNewLineAfterOrBeforeArrowToken = "RCS0032";
38-
public const string AddNewLineBeforeStatement = "RCS0033";
38+
public const string PutStatementOnItsOwnLine = "RCS0033";
3939
public const string PutTypeParameterConstraintOnItsOwnLine = "RCS0034";
4040
public const string RemoveBlankLineBetweenSingleLineDeclarationsOfSameKind = "RCS0036";
4141
public const string RemoveBlankLineBetweenUsingDirectivesWithSameRootNamespace = "RCS0038";

src/Formatting.Analyzers/CSharp/DiagnosticRules.Generated.cs

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -298,15 +298,15 @@ public static partial class DiagnosticRules
298298
customTags: Array.Empty<string>());
299299

300300
/// <summary>RCS0030</summary>
301-
public static readonly DiagnosticDescriptor AddNewLineBeforeEmbeddedStatement = DiagnosticDescriptorFactory.Create(
302-
id: DiagnosticIdentifiers.AddNewLineBeforeEmbeddedStatement,
303-
title: "Add new line before embedded statement",
304-
messageFormat: "Add new line before embedded statement",
301+
public static readonly DiagnosticDescriptor PutEmbeddedStatementOnItsOwnLine = DiagnosticDescriptorFactory.Create(
302+
id: DiagnosticIdentifiers.PutEmbeddedStatementOnItsOwnLine,
303+
title: "Put embedded statement on its own line",
304+
messageFormat: "Put embedded statement on its own line",
305305
category: DiagnosticCategories.Roslynator,
306306
defaultSeverity: DiagnosticSeverity.Info,
307307
isEnabledByDefault: false,
308308
description: null,
309-
helpLinkUri: DiagnosticIdentifiers.AddNewLineBeforeEmbeddedStatement,
309+
helpLinkUri: DiagnosticIdentifiers.PutEmbeddedStatementOnItsOwnLine,
310310
customTags: Array.Empty<string>());
311311

312312
/// <summary>RCS0031</summary>
@@ -334,15 +334,15 @@ public static partial class DiagnosticRules
334334
customTags: Array.Empty<string>());
335335

336336
/// <summary>RCS0033</summary>
337-
public static readonly DiagnosticDescriptor AddNewLineBeforeStatement = DiagnosticDescriptorFactory.Create(
338-
id: DiagnosticIdentifiers.AddNewLineBeforeStatement,
339-
title: "Add new line before statement",
340-
messageFormat: "Add new line before statement",
337+
public static readonly DiagnosticDescriptor PutStatementOnItsOwnLine = DiagnosticDescriptorFactory.Create(
338+
id: DiagnosticIdentifiers.PutStatementOnItsOwnLine,
339+
title: "Put statement on its own line",
340+
messageFormat: "Put statement on its own line",
341341
category: DiagnosticCategories.Roslynator,
342342
defaultSeverity: DiagnosticSeverity.Info,
343343
isEnabledByDefault: false,
344344
description: null,
345-
helpLinkUri: DiagnosticIdentifiers.AddNewLineBeforeStatement,
345+
helpLinkUri: DiagnosticIdentifiers.PutStatementOnItsOwnLine,
346346
customTags: Array.Empty<string>());
347347

348348
/// <summary>RCS0034</summary>

src/Formatting.Analyzers/CSharp/AddNewLineBeforeEmbeddedStatementAnalyzer.cs renamed to src/Formatting.Analyzers/CSharp/PutEmbeddedStatementOnItsOwnLineAnalyzer.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
namespace Roslynator.Formatting.CSharp;
1212

1313
[DiagnosticAnalyzer(LanguageNames.CSharp)]
14-
public sealed class AddNewLineBeforeEmbeddedStatementAnalyzer : BaseDiagnosticAnalyzer
14+
public sealed class PutEmbeddedStatementOnItsOwnLineAnalyzer : BaseDiagnosticAnalyzer
1515
{
1616
private static ImmutableArray<DiagnosticDescriptor> _supportedDiagnostics;
1717

@@ -20,7 +20,7 @@ public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics
2020
get
2121
{
2222
if (_supportedDiagnostics.IsDefault)
23-
Immutable.InterlockedInitialize(ref _supportedDiagnostics, DiagnosticRules.AddNewLineBeforeEmbeddedStatement);
23+
Immutable.InterlockedInitialize(ref _supportedDiagnostics, DiagnosticRules.PutEmbeddedStatementOnItsOwnLine);
2424

2525
return _supportedDiagnostics;
2626
}
@@ -125,7 +125,7 @@ private static void ReportDiagnostic(SyntaxNodeAnalysisContext context, Statemen
125125
{
126126
DiagnosticHelpers.ReportDiagnostic(
127127
context,
128-
DiagnosticRules.AddNewLineBeforeEmbeddedStatement,
128+
DiagnosticRules.PutEmbeddedStatementOnItsOwnLine,
129129
Location.Create(statement.SyntaxTree, statement.Span.WithLength(0)));
130130
}
131131
}

src/Formatting.Analyzers/CSharp/AddNewLineBeforeStatementAnalyzer.cs renamed to src/Formatting.Analyzers/CSharp/PutStatementOnItsOwnLineAnalyzer.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
namespace Roslynator.Formatting.CSharp;
1111

1212
[DiagnosticAnalyzer(LanguageNames.CSharp)]
13-
public sealed class AddNewLineBeforeStatementAnalyzer : BaseDiagnosticAnalyzer
13+
public sealed class PutStatementOnItsOwnLineAnalyzer : BaseDiagnosticAnalyzer
1414
{
1515
private static ImmutableArray<DiagnosticDescriptor> _supportedDiagnostics;
1616

@@ -19,7 +19,7 @@ public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics
1919
get
2020
{
2121
if (_supportedDiagnostics.IsDefault)
22-
Immutable.InterlockedInitialize(ref _supportedDiagnostics, DiagnosticRules.AddNewLineBeforeStatement);
22+
Immutable.InterlockedInitialize(ref _supportedDiagnostics, DiagnosticRules.PutStatementOnItsOwnLine);
2323

2424
return _supportedDiagnostics;
2525
}
@@ -63,7 +63,7 @@ private static void Analyze(SyntaxNodeAnalysisContext context, SyntaxList<Statem
6363
{
6464
DiagnosticHelpers.ReportDiagnostic(
6565
context,
66-
DiagnosticRules.AddNewLineBeforeStatement,
66+
DiagnosticRules.PutStatementOnItsOwnLine,
6767
Location.Create(statement.SyntaxTree, statement.Span.WithLength(0)));
6868
}
6969

src/Tests/Formatting.Analyzers.Tests/RCS0030AddNewLineBeforeEmbeddedStatementTests.cs renamed to src/Tests/Formatting.Analyzers.Tests/RCS0030PutEmbeddedStatementOnItsOwnLineTests.cs

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@
88

99
namespace Roslynator.Formatting.CSharp.Tests;
1010

11-
public class RCS0030AddNewLineBeforeEmbeddedStatementTests : AbstractCSharpDiagnosticVerifier<AddNewLineBeforeEmbeddedStatementAnalyzer, StatementCodeFixProvider>
11+
public class RCS0030PutEmbeddedStatementOnItsOwnLineTests : AbstractCSharpDiagnosticVerifier<PutEmbeddedStatementOnItsOwnLineAnalyzer, StatementCodeFixProvider>
1212
{
13-
public override DiagnosticDescriptor Descriptor { get; } = DiagnosticRules.AddNewLineBeforeEmbeddedStatement;
13+
public override DiagnosticDescriptor Descriptor { get; } = DiagnosticRules.PutEmbeddedStatementOnItsOwnLine;
1414

15-
[Fact, Trait(Traits.Analyzer, DiagnosticIdentifiers.AddNewLineBeforeEmbeddedStatement)]
15+
[Fact, Trait(Traits.Analyzer, DiagnosticIdentifiers.PutEmbeddedStatementOnItsOwnLine)]
1616
public async Task Test_If()
1717
{
1818
await VerifyDiagnosticAndFixAsync(@"
@@ -39,7 +39,7 @@ void M()
3939
");
4040
}
4141

42-
[Fact, Trait(Traits.Analyzer, DiagnosticIdentifiers.AddNewLineBeforeEmbeddedStatement)]
42+
[Fact, Trait(Traits.Analyzer, DiagnosticIdentifiers.PutEmbeddedStatementOnItsOwnLine)]
4343
public async Task Test_Else()
4444
{
4545
await VerifyDiagnosticAndFixAsync(@"
@@ -70,7 +70,7 @@ void M()
7070
");
7171
}
7272

73-
[Fact, Trait(Traits.Analyzer, DiagnosticIdentifiers.AddNewLineBeforeEmbeddedStatement)]
73+
[Fact, Trait(Traits.Analyzer, DiagnosticIdentifiers.PutEmbeddedStatementOnItsOwnLine)]
7474
public async Task Test_ForEach()
7575
{
7676
await VerifyDiagnosticAndFixAsync(@"
@@ -103,7 +103,7 @@ void M()
103103
");
104104
}
105105

106-
[Fact, Trait(Traits.Analyzer, DiagnosticIdentifiers.AddNewLineBeforeEmbeddedStatement)]
106+
[Fact, Trait(Traits.Analyzer, DiagnosticIdentifiers.PutEmbeddedStatementOnItsOwnLine)]
107107
public async Task Test_ForEachVariable()
108108
{
109109
await VerifyDiagnosticAndFixAsync(@"
@@ -136,7 +136,7 @@ void M()
136136
");
137137
}
138138

139-
[Fact, Trait(Traits.Analyzer, DiagnosticIdentifiers.AddNewLineBeforeEmbeddedStatement)]
139+
[Fact, Trait(Traits.Analyzer, DiagnosticIdentifiers.PutEmbeddedStatementOnItsOwnLine)]
140140
public async Task Test_For()
141141
{
142142
await VerifyDiagnosticAndFixAsync(@"
@@ -169,7 +169,7 @@ void M()
169169
");
170170
}
171171

172-
[Fact, Trait(Traits.Analyzer, DiagnosticIdentifiers.AddNewLineBeforeEmbeddedStatement)]
172+
[Fact, Trait(Traits.Analyzer, DiagnosticIdentifiers.PutEmbeddedStatementOnItsOwnLine)]
173173
public async Task Test_Using()
174174
{
175175
await VerifyDiagnosticAndFixAsync(@"
@@ -200,7 +200,7 @@ void M()
200200
");
201201
}
202202

203-
[Fact, Trait(Traits.Analyzer, DiagnosticIdentifiers.AddNewLineBeforeEmbeddedStatement)]
203+
[Fact, Trait(Traits.Analyzer, DiagnosticIdentifiers.PutEmbeddedStatementOnItsOwnLine)]
204204
public async Task Test_While()
205205
{
206206
await VerifyDiagnosticAndFixAsync(@"
@@ -227,7 +227,7 @@ void M()
227227
");
228228
}
229229

230-
[Fact, Trait(Traits.Analyzer, DiagnosticIdentifiers.AddNewLineBeforeEmbeddedStatement)]
230+
[Fact, Trait(Traits.Analyzer, DiagnosticIdentifiers.PutEmbeddedStatementOnItsOwnLine)]
231231
public async Task Test_Do()
232232
{
233233
await VerifyDiagnosticAndFixAsync(@"
@@ -256,7 +256,7 @@ void M()
256256
");
257257
}
258258

259-
[Fact, Trait(Traits.Analyzer, DiagnosticIdentifiers.AddNewLineBeforeEmbeddedStatement)]
259+
[Fact, Trait(Traits.Analyzer, DiagnosticIdentifiers.PutEmbeddedStatementOnItsOwnLine)]
260260
public async Task Test_Lock()
261261
{
262262
await VerifyDiagnosticAndFixAsync(@"
@@ -283,7 +283,7 @@ void M()
283283
");
284284
}
285285

286-
[Fact, Trait(Traits.Analyzer, DiagnosticIdentifiers.AddNewLineBeforeEmbeddedStatement)]
286+
[Fact, Trait(Traits.Analyzer, DiagnosticIdentifiers.PutEmbeddedStatementOnItsOwnLine)]
287287
public async Task Test_Fixed()
288288
{
289289
await VerifyDiagnosticAndFixAsync(@"
@@ -316,7 +316,7 @@ void M()
316316
", options: Options.WithAllowUnsafe(true));
317317
}
318318

319-
[Fact, Trait(Traits.Analyzer, DiagnosticIdentifiers.AddNewLineBeforeEmbeddedStatement)]
319+
[Fact, Trait(Traits.Analyzer, DiagnosticIdentifiers.PutEmbeddedStatementOnItsOwnLine)]
320320
public async Task TestNoDiagnostic_EmbeddedStatement()
321321
{
322322
await VerifyNoDiagnosticAsync(@"
@@ -367,7 +367,7 @@ private static void M()
367367
", options: Options.WithAllowUnsafe(true));
368368
}
369369

370-
[Fact, Trait(Traits.Analyzer, DiagnosticIdentifiers.AddNewLineBeforeEmbeddedStatement)]
370+
[Fact, Trait(Traits.Analyzer, DiagnosticIdentifiers.PutEmbeddedStatementOnItsOwnLine)]
371371
public async Task TestNoDiagnostic_Block()
372372
{
373373
await VerifyNoDiagnosticAsync(@"

src/Tests/Formatting.Analyzers.Tests/RCS0033AddNewLineBeforeStatementTests.cs renamed to src/Tests/Formatting.Analyzers.Tests/RCS0033PutStatementOnItsOwnLineTests.cs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@
88

99
namespace Roslynator.Formatting.CSharp.Tests;
1010

11-
public class RCS0033AddNewLineBeforeStatementTests : AbstractCSharpDiagnosticVerifier<AddNewLineBeforeStatementAnalyzer, StatementCodeFixProvider>
11+
public class RCS0033PutStatementOnItsOwnLineTests : AbstractCSharpDiagnosticVerifier<PutStatementOnItsOwnLineAnalyzer, StatementCodeFixProvider>
1212
{
13-
public override DiagnosticDescriptor Descriptor { get; } = DiagnosticRules.AddNewLineBeforeStatement;
13+
public override DiagnosticDescriptor Descriptor { get; } = DiagnosticRules.PutStatementOnItsOwnLine;
1414

15-
[Fact, Trait(Traits.Analyzer, DiagnosticIdentifiers.AddNewLineBeforeStatement)]
15+
[Fact, Trait(Traits.Analyzer, DiagnosticIdentifiers.PutStatementOnItsOwnLine)]
1616
public async Task Test_Block()
1717
{
1818
await VerifyDiagnosticAndFixAsync(@"
@@ -35,7 +35,7 @@ void M()
3535
");
3636
}
3737

38-
[Fact, Trait(Traits.Analyzer, DiagnosticIdentifiers.AddNewLineBeforeStatement)]
38+
[Fact, Trait(Traits.Analyzer, DiagnosticIdentifiers.PutStatementOnItsOwnLine)]
3939
public async Task Test_Block_SingleLine()
4040
{
4141
await VerifyDiagnosticAndFixAsync(@"
@@ -55,7 +55,7 @@ void M()
5555
");
5656
}
5757

58-
[Fact, Trait(Traits.Analyzer, DiagnosticIdentifiers.AddNewLineBeforeStatement)]
58+
[Fact, Trait(Traits.Analyzer, DiagnosticIdentifiers.PutStatementOnItsOwnLine)]
5959
public async Task Test_SwitchSection()
6060
{
6161
await VerifyDiagnosticAndFixAsync(@"
@@ -90,7 +90,7 @@ void M()
9090
");
9191
}
9292

93-
[Fact, Trait(Traits.Analyzer, DiagnosticIdentifiers.AddNewLineBeforeStatement)]
93+
[Fact, Trait(Traits.Analyzer, DiagnosticIdentifiers.PutStatementOnItsOwnLine)]
9494
public async Task TestNoDiagnostic_EmptyStatement()
9595
{
9696
await VerifyNoDiagnosticAsync(@"

src/VisualStudioCode/package/src/configurationFiles.generated.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -218,7 +218,7 @@ roslynator_analyzers.enabled_by_default = true|false
218218
# Put constructor initializer on its own line
219219
#dotnet_diagnostic.rcs0029.severity = none
220220
221-
# Add new line before embedded statement
221+
# Put embedded statement on its own line
222222
#dotnet_diagnostic.rcs0030.severity = none
223223
224224
# Put enum member on its own line
@@ -228,7 +228,7 @@ roslynator_analyzers.enabled_by_default = true|false
228228
#dotnet_diagnostic.rcs0032.severity = none
229229
# Options: roslynator_arrow_token_new_line
230230
231-
# Add new line before statement
231+
# Put statement on its own line
232232
#dotnet_diagnostic.rcs0033.severity = none
233233
234234
# Put type parameter constraint on its own line

0 commit comments

Comments
 (0)