Skip to content

Commit afc3e34

Browse files
author
Kapil Borle
committed
Localize error messages in PlaceCloseBrace rule
1 parent c5c90c0 commit afc3e34

File tree

2 files changed

+31
-16
lines changed

2 files changed

+31
-16
lines changed

Rules/PlaceCloseBrace.cs

Lines changed: 24 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -82,13 +82,13 @@ public override IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string file
8282
}
8383

8484
AddToDiagnosticRecords(
85-
GetViolationForBraceOnSameLine(tokens, k, openBracePos, fileName),
85+
GetViolationForBraceShouldBeOnNewLine(tokens, k, openBracePos, fileName),
8686
ref diagnosticRecords);
8787

8888
if (NoEmptyLineBefore)
8989
{
9090
AddToDiagnosticRecords(
91-
GetViolationForEmptyLineBeforeBrace(tokens, k, openBracePos, fileName),
91+
GetViolationForBraceShouldNotFollowEmptyLine(tokens, k, openBracePos, fileName),
9292
ref diagnosticRecords);
9393
}
9494
}
@@ -102,7 +102,11 @@ public override IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string file
102102
return diagnosticRecords;
103103
}
104104

105-
private DiagnosticRecord GetViolationForEmptyLineBeforeBrace(Token[] tokens, int closeBracePos, int openBracePos, string fileName)
105+
private DiagnosticRecord GetViolationForBraceShouldNotFollowEmptyLine(
106+
Token[] tokens,
107+
int closeBracePos,
108+
int openBracePos,
109+
string fileName)
106110
{
107111
if (tokens.Length > 2 && tokens.Length > closeBracePos)
108112
{
@@ -113,20 +117,28 @@ private DiagnosticRecord GetViolationForEmptyLineBeforeBrace(Token[] tokens, int
113117
&& extraNewLineToken.Kind == TokenKind.NewLine)
114118
{
115119
return new DiagnosticRecord(
116-
"Extra new line before close brace",
120+
GetError(Strings.PlaceCloseBraceErrorShouldNotFollowEmptyLine),
117121
closeBraceToken.Extent,
118122
GetName(),
119123
GetDiagnosticSeverity(),
120124
fileName,
121125
null,
122-
GetSuggestedCorrectionsForEmptyLineBeforeBrace(tokens, closeBracePos, openBracePos, fileName));
126+
GetCorrectionsForBraceShouldNotFollowEmptyLine(
127+
tokens,
128+
closeBracePos,
129+
openBracePos,
130+
fileName));
123131
}
124132
}
125133

126134
return null;
127135
}
128136

129-
private List<CorrectionExtent> GetSuggestedCorrectionsForEmptyLineBeforeBrace(Token[] tokens, int closeBracePos, int openBracePos, string fileName)
137+
private List<CorrectionExtent> GetCorrectionsForBraceShouldNotFollowEmptyLine(
138+
Token[] tokens,
139+
int closeBracePos,
140+
int openBracePos,
141+
string fileName)
130142
{
131143
var corrections = new List<CorrectionExtent>();
132144
var newLineToken = tokens[closeBracePos - 2];
@@ -168,28 +180,28 @@ private string GetIndentation(Token[] tokens, int closeBracePos, int openBracePo
168180
return new String(' ', firstTokenOnOpenBraceLine.Extent.StartColumnNumber - 1);
169181
}
170182

171-
private DiagnosticRecord GetViolationForBraceOnSameLine(Token[] tokens, int closeBracePos, int openBracePos, string fileName)
183+
private DiagnosticRecord GetViolationForBraceShouldBeOnNewLine(Token[] tokens, int closeBracePos, int openBracePos, string fileName)
172184
{
173185
if (tokens.Length > 1 && tokens.Length > closeBracePos)
174186
{
175187
var closeBraceToken = tokens[closeBracePos];
176188
if (tokens[closeBracePos - 1].Kind != TokenKind.NewLine)
177189
{
178190
return new DiagnosticRecord(
179-
GetError(),
191+
GetError(Strings.PlaceCloseBraceErrorShouldBeOnNewLine),
180192
closeBraceToken.Extent,
181193
GetName(),
182194
GetDiagnosticSeverity(),
183195
fileName,
184196
null,
185-
GetSuggestedCorrectionsForBraceOnSameLine(tokens, closeBracePos, openBracePos, fileName));
197+
GetCorrectionsForBraceShouldBeOnNewLine(tokens, closeBracePos, openBracePos, fileName));
186198
}
187199
}
188200

189201
return null;
190202
}
191203

192-
private List<CorrectionExtent> GetSuggestedCorrectionsForBraceOnSameLine(
204+
private List<CorrectionExtent> GetCorrectionsForBraceShouldBeOnNewLine(
193205
Token[] tokens,
194206
int closeBracePos,
195207
int openBracePos,
@@ -249,9 +261,9 @@ private List<Token> GetTokens(Ast ast, List<Token> tokens, ref Dictionary<Ast, L
249261
/// <summary>
250262
/// Retrieves the error message of this rule
251263
/// </summary>
252-
private string GetError()
264+
private string GetError(string errorString)
253265
{
254-
return string.Format(CultureInfo.CurrentCulture, Strings.PlaceCloseBraceError);
266+
return string.Format(CultureInfo.CurrentCulture, errorString);
255267
}
256268

257269
/// <summary>

Rules/Strings.resx

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -883,10 +883,10 @@
883883
<value>Open brace not on same line as preceding keyword. It should be on the same line.</value>
884884
</data>
885885
<data name="PlaceOpenBraceErrorShouldNotBeOnSameLine" xml:space="preserve">
886-
<value>Open brace is on same line as preceding keyword. It should be on a new line.</value>
886+
<value>Open brace is not on a new line.</value>
887887
</data>
888888
<data name="PlaceOpenBraceErrorNoNewLineAfterBrace" xml:space="preserve">
889-
<value>No new line after open brace. A new line should follown an open brace.</value>
889+
<value>There is no new line after open brace.</value>
890890
</data>
891891
<data name="PlaceCloseBraceName" xml:space="preserve">
892892
<value>PlaceCloseBrace</value>
@@ -897,8 +897,11 @@
897897
<data name="PlaceCloseBraceDescription" xml:space="preserve">
898898
<value>Place close brace show be on a new line by itself.</value>
899899
</data>
900-
<data name="PlaceCloseBraceError" xml:space="preserve">
901-
<value>Close brace not on a new line</value>
900+
<data name="PlaceCloseBraceErrorShouldBeOnNewLine" xml:space="preserve">
901+
<value>Close brace is not on a new line.</value>
902+
</data>
903+
<data name="PlaceCloseBraceErrorShouldNotFollowEmptyLine" xml:space="preserve">
904+
<value>Close brace does not follow a non-empty line.</value>
902905
</data>
903906
<data name="UseConsistentIndentationName" xml:space="preserve">
904907
<value>UseConsistentIndentation</value>

0 commit comments

Comments
 (0)