Load XML docs when using #r directives in scripting #1027
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
DustinCampbell
approved these changes
Nov 13, 2017
src/OmniSharp.Script/ScriptHelper.cs
Outdated
| @@ -7,11 +7,19 @@ | |||
| using Microsoft.CodeAnalysis.Scripting; | |||
| using Microsoft.CodeAnalysis.Scripting.Hosting; | |||
| using Microsoft.Extensions.Configuration; | |||
| using System.IO; | |||
There was a problem hiding this comment.
nit: sort System using directives on top.
| @@ -5,6 +5,7 @@ | |||
| using TestUtility; | |||
| using Xunit; | |||
| using Xunit.Abstractions; | |||
| using System.IO; | |||
There was a problem hiding this comment.
Sort usings with System namespaces an top
| @@ -215,6 +215,7 @@ private void AddMetadataReference(ISet<MetadataReference> referenceCollection, s | |||
| _logger.LogDebug($"Added reference to '{fileReference}'"); | |||
| } | |||
|
|
|||
|
|
|||
There was a problem hiding this comment.
nit: Extra blank line
src/OmniSharp.Script/ScriptHelper.cs
Outdated
| return MetadataReference.CreateFromFile(path, properties, documentationProvider); | ||
| })); | ||
| } | ||
|
|
There was a problem hiding this comment.
nit: extra blank line.
src/OmniSharp.Script/ScriptHelper.cs
Outdated
| : new CachingScriptMetadataResolver(ScriptMetadataResolver.Default); | ||
| return enableScriptNuGetReferences ? | ||
| new CachingScriptMetadataResolver(new NuGetMetadataReferenceResolver(_resolver)) : | ||
| new CachingScriptMetadataResolver(_resolver); |
There was a problem hiding this comment.
nit: for this conditional expression, you have the ? and : at the end of the lines. However, below, you have them at the start of the lines. Maybe make these consistent? (I personally prefer the bottom one.)
| @@ -47,7 +47,7 @@ public MetadataReference GetMetadataReference(string filePath) | |||
| } | |||
|
|
|||
| var displayText = assemblyMetadata.GetModules().FirstOrDefault()?.Name; | |||
|
|
|||
There was a problem hiding this comment.
unintentional whitespace-only change?
filipw
force-pushed
the
bugfix/csx-docs
branch
from
fdd796b
to
15fdbbe
Compare
|
thanks! pushed the requested changes. Also added a changelog entry that I forgot before. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #1026
At the moment, the
RuntimeMetadataReferenceResolveron which we rely when processing#rdirectives in scripts, completely ignores XML docs https://github.com/dotnet/roslyn/blob/version-2.4.0/src/Scripting/Core/Hosting/Resolvers/RuntimeMetadataReferenceResolver.cs#L69There is no simple hook in which we can inject it (unless we rewrite/copy entire resolver and all its dependencies), so the fix is applied via 😔 reflection 😔. I'll talk to Tomas to see if we can do something better on the Scripting API side, but for now this should at least fix the problem.
Also attached a test that verifies the functionality.