Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Remove DocumentWithOptions and pass around DocumentIds #695

Merged
merged 1 commit into from
Jun 1, 2020
Merged

Remove DocumentWithOptions and pass around DocumentIds #695

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
20 changes: 8 additions & 12 deletions src/CodeFormatter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,7 @@ static void LogWorkspaceDiagnostics(ILogger logger, bool logWorkspaceWarnings, I

private static async Task<Solution> RunCodeFormattersAsync(
Solution solution,
ImmutableArray<DocumentWithOptions> formattableDocuments,
ImmutableArray<DocumentId> formattableDocuments,
FormatOptions options,
ILogger logger,
List<FormattedFile> formattedFiles,
Expand All @@ -249,7 +249,7 @@ static void LogWorkspaceDiagnostics(ILogger logger, bool logWorkspaceWarnings, I
return formattedSolution;
}

internal static async Task<(int, ImmutableArray<DocumentWithOptions>)> DetermineFormattableFilesAsync(
internal static async Task<(int, ImmutableArray<DocumentId>)> DetermineFormattableFilesAsync(
Solution solution,
string projectPath,
Matcher fileMatcher,
Expand All @@ -258,10 +258,10 @@ static void LogWorkspaceDiagnostics(ILogger logger, bool logWorkspaceWarnings, I
CancellationToken cancellationToken)
{
var totalFileCount = solution.Projects.Sum(project => project.DocumentIds.Count);
int projectFileCount = 0;
var projectFileCount = 0;

var documentsCoveredByEditorConfig = ImmutableArray.CreateBuilder<DocumentWithOptions>(totalFileCount);
var documentsNotCoveredByEditorConfig = ImmutableArray.CreateBuilder<DocumentWithOptions>(totalFileCount);
var documentsCoveredByEditorConfig = ImmutableArray.CreateBuilder<DocumentId>(totalFileCount);
var documentsNotCoveredByEditorConfig = ImmutableArray.CreateBuilder<DocumentId>(totalFileCount);

var addedFilePaths = new HashSet<string>(totalFileCount);

Expand Down Expand Up @@ -317,19 +317,15 @@ await GeneratedCodeUtilities.IsGeneratedCodeAsync(syntaxTree, cancellationToken)
continue;
}

var analyzerConfigOptions = document.Project.AnalyzerOptions.AnalyzerConfigOptionsProvider.GetOptions(syntaxTree);
var optionSet = await document.GetOptionsAsync(cancellationToken).ConfigureAwait(false);

var formattableDocument = new DocumentWithOptions(document, optionSet, analyzerConfigOptions);

// Track files covered by an editorconfig separately from those not covered.
var analyzerConfigOptions = document.Project.AnalyzerOptions.AnalyzerConfigOptionsProvider.GetOptions(syntaxTree);
if (analyzerConfigOptions is object)
{
documentsCoveredByEditorConfig.Add(formattableDocument);
documentsCoveredByEditorConfig.Add(document.Id);
}
else
{
documentsNotCoveredByEditorConfig.Add(formattableDocument);
documentsNotCoveredByEditorConfig.Add(document.Id);
}
}
}
Expand Down
31 changes: 0 additions & 31 deletions src/DocumentWithOptions.cs
View file
Open in desktop

This file was deleted.

23 changes: 17 additions & 6 deletions src/Formatters/DocumentFormatter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ internal abstract class DocumentFormatter : ICodeFormatter
/// </summary>
public async Task<Solution> FormatAsync(
Solution solution,
ImmutableArray<DocumentWithOptions> formattableDocuments,
ImmutableArray<DocumentId> formattableDocuments,
FormatOptions formatOptions,
ILogger logger,
List<FormattedFile> formattedFiles,
Expand All @@ -52,21 +52,32 @@ internal abstract class DocumentFormatter : ICodeFormatter
/// </summary>
private ImmutableArray<(Document, Task<(SourceText originalText, SourceText? formattedText)>)> FormatFiles(
Solution solution,
ImmutableArray<DocumentWithOptions> formattableDocuments,
ImmutableArray<DocumentId> formattableDocuments,
FormatOptions formatOptions,
ILogger logger,
CancellationToken cancellationToken)
{
var formattedDocuments = ImmutableArray.CreateBuilder<(Document, Task<(SourceText originalText, SourceText? formattedText)>)>(formattableDocuments.Length);

foreach (var formattableDocument in formattableDocuments)
foreach (var documentId in formattableDocuments)
{
var document = solution.GetDocument(formattableDocument.Document.Id);
var document = solution.GetDocument(documentId);
if (document is null)
continue;

var formatTask = Task.Run(async ()
=> await GetFormattedSourceTextAsync(document, formattableDocument.OptionSet, formattableDocument.AnalyzerConfigOptions, formatOptions, logger, cancellationToken).ConfigureAwait(false), cancellationToken);
var formatTask = Task.Run(async () =>
{
var originalSourceText = await document.GetTextAsync(cancellationToken).ConfigureAwait(false);

var syntaxTree = await document.GetSyntaxTreeAsync(cancellationToken).ConfigureAwait(false);
if (syntaxTree is null)
return (originalSourceText, null);

var analyzerConfigOptions = document.Project.AnalyzerOptions.AnalyzerConfigOptionsProvider.GetOptions(syntaxTree);
var optionSet = await document.GetOptionsAsync(cancellationToken).ConfigureAwait(false);

return await GetFormattedSourceTextAsync(document, optionSet, analyzerConfigOptions, formatOptions, logger, cancellationToken).ConfigureAwait(false);
}, cancellationToken);

formattedDocuments.Add((document, formatTask));
}
Expand Down
2 changes: 1 addition & 1 deletion src/Formatters/ICodeFormatter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ internal interface ICodeFormatter
/// </summary>
Task<Solution> FormatAsync(
Solution solution,
ImmutableArray<DocumentWithOptions> formattableDocuments,
ImmutableArray<DocumentId> formattableDocuments,
FormatOptions options,
ILogger logger,
List<FormattedFile> formattedFiles,
Expand Down
18 changes: 4 additions & 14 deletions tests/Formatters/AbstractFormatterTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ private protected async Task<SourceText> TestAsync(string testCode, string expec
reportPath: string.Empty,
includeGeneratedFiles: false);

var pathsToFormat = await GetOnlyFileToFormatAsync(solution);
var pathsToFormat = GetOnlyFileToFormat(solution);

var formattedSolution = await Formatter.FormatAsync(solution, pathsToFormat, formatOptions, Logger, new List<FormattedFile>(), default);
var formattedDocument = GetOnlyDocument(formattedSolution);
Expand All @@ -137,21 +137,11 @@ private protected async Task<SourceText> TestAsync(string testCode, string expec
}

/// <summary>
/// Gets the only <see cref="Document"/> along with related options and conventions.
/// Gets the only <see cref="DocumentId"/>.
/// </summary>
/// <param name="solution">A Solution containing a single Project containing a single Document.</param>
/// <param name="editorConfig">The editorconfig to apply to the documents options set.</param>
/// <returns>The document contained within along with option set and coding conventions.</returns>
internal async Task<ImmutableArray<DocumentWithOptions>> GetOnlyFileToFormatAsync(Solution solution)
{
var document = GetOnlyDocument(solution);
var options = (OptionSet)await document.GetOptionsAsync();

var syntaxTree = await document.GetSyntaxTreeAsync();
var analyzerConfigOptions = document.Project.AnalyzerOptions.AnalyzerConfigOptionsProvider.GetOptions(syntaxTree);

return ImmutableArray.Create(new DocumentWithOptions(document, options, analyzerConfigOptions));
}
/// <returns>The only document id.</returns>
internal ImmutableArray<DocumentId> GetOnlyFileToFormat(Solution solution) => ImmutableArray.Create(GetOnlyDocument(solution).Id);

/// <summary>
/// Gets the only <see cref="Document"/> contained within the only <see cref="Project"/> within the <see cref="Solution"/>.
Expand Down
2 changes: 1 addition & 1 deletion tests/Formatters/FormattedFilesTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ private async Task<List<FormattedFile>> TestFormattedFiles(string testCode)
reportPath: string.Empty,
includeGeneratedFiles: false);

var pathsToFormat = await GetOnlyFileToFormatAsync(solution);
var pathsToFormat = GetOnlyFileToFormat(solution);

var formattedFiles = new List<FormattedFile>();
await Formatter.FormatAsync(solution, pathsToFormat, formatOptions, new TestLogger(), formattedFiles, default);
Expand Down