Skip to content

Commit 8633f9e

Browse files
josefpihrtjosefpihrt
authored
Spellcheck file name (#1368)
1 parent 2ed4a08 commit 8633f9e

12 files changed

+250
-169
lines changed

‎ChangeLog.md

+2
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1212
- Publish NuGet packages that provide [refactorings](https://www.nuget.org/packages/roslynator.refactorings) and [code fixes for compiler diagnostics](https://www.nuget.org/packages/roslynator.codefixes) ([PR](https://github.com/dotnet/roslynator/pull/1358))
1313
- These packages are recommended to be used in an environment where Roslynator IDE extension cannot be used, e.g. VS Code + C# Dev Kit (see related [issue](https://github.com/dotnet/vscode-csharp/issues/6790))
1414
- Add analyzer "Remove redundant catch block" [RCS1265](https://josefpihrt.github.io/docs/roslynator/analyzers/RCS1265) ([PR](https://github.com/dotnet/roslynator/pull/1364) by @jakubreznak)
15+
- [CLI] Spellcheck file names ([PR](https://github.com/dotnet/roslynator/pull/1368))
16+
- `roslynator spellcheck --scope file-name`
1517

1618
### Fixed
1719

‎src/CSharp.Workspaces/CSharp/Spelling/CSharpSpellingService.CSharpSpellingAnalyzer.cs

+3
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,9 @@ private void AnalyzeSyntaxTree(SyntaxTreeAnalysisContext context)
5454
_options,
5555
context.CancellationToken);
5656

57+
if ((_options.ScopeFilter & SpellingScopeFilter.FileName) != 0)
58+
analysisContext.AnalyzeFileName(tree);
59+
5760
CSharpSpellingWalker walker = CSharpSpellingWalker.Create(analysisContext);
5861

5962
walker.Visit(root);

‎src/CommandLine/Commands/SpellcheckCommand.cs

+3-6
Original file line numberDiff line numberDiff line change
@@ -60,9 +60,6 @@ public override async Task<SpellcheckCommandResult> ExecuteAsync(ProjectOrSoluti
6060
MinWordLength = Options.MinWordLength,
6161
MaxWordLength = Options.MaxWordLength,
6262
IncludeGeneratedCode = Options.IncludeGeneratedCode,
63-
#if DEBUG
64-
Autofix = !Options.NoAutofix,
65-
#endif
6663
Interactive = Options.Interactive,
6764
DryRun = Options.DryRun,
6865
};
@@ -87,7 +84,7 @@ private async Task<SpellcheckCommandResult> FixAsync(
8784

8885
Solution solution = project.Solution;
8986

90-
spellingFixer = GetSpellingFixer(solution);
87+
spellingFixer = GetSpellcheckAnalyzer(solution);
9188

9289
WriteLine($"Analyze '{project.Name}'", ConsoleColors.Cyan, Verbosity.Minimal);
9390

@@ -103,7 +100,7 @@ private async Task<SpellcheckCommandResult> FixAsync(
103100
{
104101
Solution solution = projectOrSolution.AsSolution();
105102

106-
spellingFixer = GetSpellingFixer(solution);
103+
spellingFixer = GetSpellcheckAnalyzer(solution);
107104

108105
results = await spellingFixer.FixSolutionAsync(f => IsMatch(f), cancellationToken);
109106
}
@@ -118,7 +115,7 @@ private async Task<SpellcheckCommandResult> FixAsync(
118115
: CommandStatus.NotSuccess,
119116
results);
120117

121-
SpellcheckAnalyzer GetSpellingFixer(Solution solution)
118+
SpellcheckAnalyzer GetSpellcheckAnalyzer(Solution solution)
122119
{
123120
return new SpellcheckAnalyzer(
124121
solution,

‎src/CommandLine/Options/SpellcheckCommandLineOptions.cs

+3-8
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ public sealed class SpellcheckCommandLineOptions : MSBuildCommandLineOptions
3333

3434
[Option(
3535
longName: OptionNames.IgnoredScope,
36-
HelpText = "Defines syntax that should not be analyzed. Allowed values are comment, type, member, local, parameter, literal, non-symbol and symbol.",
36+
HelpText = "Defines syntax that should not be analyzed. Allowed values are comment, type, member, local, parameter, literal, non-symbol, symbol and file-name.",
3737
MetaValue = "<SCOPE>")]
3838
public IEnumerable<string> IgnoredScope { get; set; }
3939

@@ -60,15 +60,10 @@ public sealed class SpellcheckCommandLineOptions : MSBuildCommandLineOptions
6060
HelpText = "Specifies minimal word length to be checked. Default value is 3.",
6161
MetaValue = "<NUM>")]
6262
public int MinWordLength { get; set; }
63-
#if DEBUG
64-
[Option(
65-
longName: OptionNames.NoAutofix,
66-
HelpText = "Disable applying predefined fixes.")]
67-
public bool NoAutofix { get; set; }
68-
#endif
63+
6964
[Option(
7065
longName: OptionNames.Scope,
71-
HelpText = "Defines syntax that should be analyzed. Allowed values are comment, type, member, local, parameter, literal, non-symbol, symbol and all. Literals are not analyzed by default.",
66+
HelpText = "Defines syntax that should be analyzed. Allowed values are comment, type, member, local, parameter, literal, non-symbol, symbol, file-name and all. Literals and file names are not analyzed by default.",
7267
MetaValue = "<SCOPE>")]
7368
public IEnumerable<string> Scope { get; set; }
7469

‎src/CommandLine/Rename/CliSymbolRenameState.cs

+13-1
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,16 @@ namespace Roslynator.CommandLine.Rename;
1818

1919
internal class CliSymbolRenameState : SymbolRenameState
2020
{
21+
private static readonly SymbolDisplayFormat _symbolDefinitionFormat = SymbolDisplayFormat.CSharpErrorMessageFormat.Update(
22+
typeQualificationStyle: SymbolDisplayTypeQualificationStyle.NameAndContainingTypesAndNamespaces,
23+
parameterOptions: SymbolDisplayParameterOptions.IncludeParamsRefOut
24+
| SymbolDisplayParameterOptions.IncludeType
25+
| SymbolDisplayParameterOptions.IncludeName
26+
| SymbolDisplayParameterOptions.IncludeDefaultValue,
27+
miscellaneousOptions: SymbolDisplayMiscellaneousOptions.EscapeKeywordIdentifiers
28+
| SymbolDisplayMiscellaneousOptions.UseSpecialTypes
29+
| SymbolDisplayMiscellaneousOptions.UseErrorTypeSymbolName);
30+
2131
public CliSymbolRenameState(
2232
Solution solution,
2333
Func<ISymbol, bool> predicate,
@@ -103,7 +113,9 @@ public override async Task RenameSymbolsAsync(Project project, CancellationToken
103113
Document document,
104114
CancellationToken cancellationToken)
105115
{
106-
LogHelpers.WriteSymbolDefinition(symbol, baseDirectoryPath: Path.GetDirectoryName(document.Project.FilePath), " ", Verbosity.Normal);
116+
string text = DiagnosticFormatter.FormatSymbolDefinition(symbol, baseDirectoryPath: Path.GetDirectoryName(document.Project.FilePath), " ", _symbolDefinitionFormat);
117+
118+
WriteLine(text, ConsoleColors.Cyan, Verbosity.Normal);
107119

108120
if (ShouldWrite(Verbosity.Detailed)
109121
|| CodeContext >= 0)

‎src/Core/FileSystemHelpers.cs

+29
Original file line numberDiff line numberDiff line change
@@ -80,4 +80,33 @@ public static string DetermineRelativePath(string baseDirectoryPath, string file
8080

8181
return directoryUri.MakeRelativeUri(baseDirectoryUri).ToString().TrimEnd('/');
8282
}
83+
84+
public static int LastIndexOfDirectorySeparator(string path)
85+
{
86+
for (int i = path.Length - 1; i >= 0; i--)
87+
{
88+
if (IsDirectorySeparator(path[i]))
89+
return i;
90+
}
91+
92+
return -1;
93+
}
94+
95+
public static int GetExtensionIndex(string path)
96+
{
97+
int length = path.Length;
98+
99+
for (int i = length - 1; i >= 0; i--)
100+
{
101+
char ch = path[i];
102+
103+
if (ch == '.')
104+
return i;
105+
106+
if (IsDirectorySeparator(ch))
107+
break;
108+
}
109+
110+
return path.Length;
111+
}
83112
}

‎src/Workspaces.Core/DiagnosticFormatter.cs

+138-26
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
// Copyright (c) .NET Foundation and Contributors. Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
22

33
using System;
4+
using System.Diagnostics;
45
using System.Text;
56
using Microsoft.CodeAnalysis;
67
using Microsoft.CodeAnalysis.Text;
@@ -13,28 +14,39 @@ internal static class DiagnosticFormatter
1314
public static string FormatDiagnostic(
1415
Diagnostic diagnostic,
1516
string? baseDirectoryPath = null,
16-
IFormatProvider? formatProvider = null)
17+
IFormatProvider? formatProvider = null,
18+
bool omitSpan = false)
1719
{
1820
StringBuilder sb = StringBuilderCache.GetInstance();
1921

20-
FormatLocation(diagnostic.Location, baseDirectoryPath, ref sb);
22+
FormatLocation(diagnostic.Location, baseDirectoryPath, ref sb, omitSpan);
2123

2224
sb.Append(GetSeverityText(diagnostic.Severity));
2325
sb.Append(' ');
2426
sb.Append(diagnostic.Id);
2527
sb.Append(": ");
26-
27-
string message = diagnostic.GetMessage(formatProvider);
28-
29-
sb.Append(message);
28+
sb.Append(diagnostic.GetMessage(formatProvider));
3029

3130
return StringBuilderCache.GetStringAndFree(sb);
31+
32+
static string GetSeverityText(DiagnosticSeverity severity)
33+
{
34+
return severity switch
35+
{
36+
DiagnosticSeverity.Hidden => "hidden",
37+
DiagnosticSeverity.Info => "info",
38+
DiagnosticSeverity.Warning => "warning",
39+
DiagnosticSeverity.Error => "error",
40+
_ => throw new InvalidOperationException(),
41+
};
42+
}
3243
}
3344

34-
internal static void FormatLocation(
45+
private static void FormatLocation(
3546
Location location,
3647
string? baseDirectoryPath,
37-
ref StringBuilder sb)
48+
ref StringBuilder sb,
49+
bool omitSpan = false)
3850
{
3951
switch (location.Kind)
4052
{
@@ -48,34 +60,134 @@ internal static void FormatLocation(
4860
{
4961
sb.Append(PathUtilities.TrimStart(span.Path, baseDirectoryPath));
5062

51-
LinePosition linePosition = span.StartLinePosition;
63+
if (omitSpan)
64+
{
65+
sb.Append(": ");
66+
}
67+
else
68+
{
69+
LinePosition linePosition = span.StartLinePosition;
5270

53-
sb.Append('(');
54-
sb.Append(linePosition.Line + 1);
55-
sb.Append(',');
56-
sb.Append(linePosition.Character + 1);
57-
sb.Append("): ");
71+
sb.Append('(');
72+
sb.Append(linePosition.Line + 1);
73+
sb.Append(',');
74+
sb.Append(linePosition.Character + 1);
75+
sb.Append("): ");
76+
}
5877
}
5978

6079
break;
6180
}
6281
}
6382
}
6483

65-
private static string GetSeverityText(DiagnosticSeverity diagnosticSeverity)
84+
public static string FormatSymbolDefinition(
85+
ISymbol symbol,
86+
string? baseDirectoryPath = null,
87+
string? indentation = null,
88+
SymbolDisplayFormat? format = null)
6689
{
67-
switch (diagnosticSeverity)
90+
StringBuilder sb = StringBuilderCache.GetInstance();
91+
92+
sb.Append(indentation);
93+
94+
FormatLocation(symbol.Locations[0], baseDirectoryPath, ref sb);
95+
96+
sb.Append(GetSymbolTitle(symbol));
97+
98+
if (symbol.IsKind(SymbolKind.Parameter, SymbolKind.TypeParameter))
6899
{
69-
case DiagnosticSeverity.Hidden:
70-
return "hidden";
71-
case DiagnosticSeverity.Info:
72-
return "info";
73-
case DiagnosticSeverity.Warning:
74-
return "warning";
75-
case DiagnosticSeverity.Error:
76-
return "error";
77-
default:
78-
throw new InvalidOperationException();
100+
sb.Append(" '");
101+
sb.Append(symbol.Name);
102+
sb.Append("': ");
103+
104+
if (symbol.ContainingSymbol is IMethodSymbol { MethodKind: MethodKind.LambdaMethod })
105+
{
106+
sb.Append("anonymous function");
107+
}
108+
else
109+
{
110+
Debug.Assert(symbol.ContainingSymbol.IsKind(SymbolKind.NamedType, SymbolKind.Method, SymbolKind.Property), symbol.Kind.ToString());
111+
112+
sb.Append(symbol.ContainingSymbol.ToDisplayString(format));
113+
}
114+
}
115+
else
116+
{
117+
sb.Append(": ");
118+
sb.Append(symbol.ToDisplayString(format));
119+
}
120+
121+
return StringBuilderCache.GetStringAndFree(sb);
122+
123+
static string GetSymbolTitle(ISymbol symbol)
124+
{
125+
switch (symbol.Kind)
126+
{
127+
case SymbolKind.Event:
128+
{
129+
return "event";
130+
}
131+
case SymbolKind.Field:
132+
{
133+
return (symbol.ContainingType.TypeKind == TypeKind.Enum) ? "enum field" : "field";
134+
}
135+
case SymbolKind.Local:
136+
{
137+
return "local";
138+
}
139+
case SymbolKind.Method:
140+
{
141+
var methodSymbol = (IMethodSymbol)symbol;
142+
143+
switch (methodSymbol.MethodKind)
144+
{
145+
case MethodKind.Ordinary:
146+
return "method";
147+
case MethodKind.LocalFunction:
148+
return "local function";
149+
}
150+
151+
Debug.Fail(methodSymbol.MethodKind.ToString());
152+
break;
153+
}
154+
case SymbolKind.NamedType:
155+
{
156+
var typeSymbol = (INamedTypeSymbol)symbol;
157+
158+
switch (typeSymbol.TypeKind)
159+
{
160+
case TypeKind.Class:
161+
return "class";
162+
case TypeKind.Delegate:
163+
return "delegate";
164+
case TypeKind.Enum:
165+
return "enum";
166+
case TypeKind.Interface:
167+
return "interface";
168+
case TypeKind.Struct:
169+
return "struct";
170+
}
171+
172+
Debug.Fail(typeSymbol.TypeKind.ToString());
173+
break;
174+
}
175+
case SymbolKind.Parameter:
176+
{
177+
return "parameter";
178+
}
179+
case SymbolKind.Property:
180+
{
181+
return (((IPropertySymbol)symbol).IsIndexer) ? "indexer" : "property";
182+
}
183+
case SymbolKind.TypeParameter:
184+
{
185+
return "type parameter";
186+
}
187+
}
188+
189+
Debug.Fail(symbol.Kind.ToString());
190+
return symbol.Kind.ToString();
79191
}
80192
}
81193
}

0 commit comments

Comments
 (0)