Add support for Miscellaneous Files #1252
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| using System; | ||
| using System.Composition; | ||
| using OmniSharp.Services; | ||
|
|
||
| namespace OmniSharp.Mef | ||
| { | ||
| [MetadataAttribute] | ||
| [AttributeUsage(AttributeTargets.Class, AllowMultiple = false)] | ||
| public class ExportProjectSystemAttribute: ExportAttribute | ||
| { | ||
| public string Name { get; } | ||
|
|
||
| public ExportProjectSystemAttribute(string name) : base(typeof(IProjectSystem)) | ||
| { | ||
| Name = name; | ||
| } | ||
| } | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| namespace OmniSharp.Mef | ||
| { | ||
| public class ProjectSystemMetadata | ||
| { | ||
| public string Name { get; set; } | ||
| } | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| namespace OmniSharp | ||
| { | ||
| public static class ProjectSystemNames | ||
| { | ||
| public const string MSBuildProjectSystem = "MSBuildProjectSystem"; | ||
| public const string CakeProjectSystem = "CakeProjectSystem"; | ||
| public const string DotNetProjectSystem = "DotNetProjectSystem"; | ||
| public const string ScriptProjectSystem = "ScriptProjectSystem"; | ||
| public const string MiscellaneousFilesProjectSystem = "MiscellaneousFilesProjectSystem"; | ||
| } | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| using System.Threading.Tasks; | ||
|
|
||
| namespace OmniSharp.Services | ||
| { | ||
| public interface IWaitableProjectSystem: IProjectSystem | ||
| { | ||
| Task WaitForUpdatesAsync(); | ||
| } | ||
| } |
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,111 @@ | ||
| using System; | ||
| using System.Collections.Generic; | ||
| using System.Composition; | ||
| using System.IO; | ||
| using System.Linq; | ||
| using System.Threading.Tasks; | ||
| using Microsoft.CodeAnalysis; | ||
| using Microsoft.Extensions.Configuration; | ||
| using Microsoft.Extensions.Logging; | ||
| using OmniSharp.FileSystem; | ||
| using OmniSharp.FileWatching; | ||
| using OmniSharp.Mef; | ||
| using OmniSharp.Models.WorkspaceInformation; | ||
| using OmniSharp.Services; | ||
|
|
||
| namespace OmniSharp.MiscellaneousFile | ||
| { | ||
| [ExtensionOrder(After = ProjectSystemNames.MSBuildProjectSystem)] | ||
| [ExtensionOrder(After = ProjectSystemNames.DotNetProjectSystem)] | ||
| [ExportProjectSystem(ProjectSystemNames.MiscellaneousFilesProjectSystem), Shared] | ||
| public class MiscellaneousFilesProjectSystem : IProjectSystem | ||
| { | ||
| private const string miscFileExtension = ".cs"; | ||
| public string Key => ProjectSystemNames.MiscellaneousFilesProjectSystem; | ||
| public string Language => LanguageNames.CSharp; | ||
| IEnumerable<string> IProjectSystem.Extensions => new[] { miscFileExtension }; | ||
| public bool EnabledByDefault { get; } = true; | ||
|
|
||
| private readonly OmniSharpWorkspace _workspace; | ||
| private readonly IFileSystemWatcher _fileSystemWatcher; | ||
| private readonly FileSystemHelper _fileSystemHelper; | ||
| private readonly List<IWaitableProjectSystem> _projectSystems; | ||
| private readonly ILogger _logger; | ||
|
|
||
| [ImportingConstructor] | ||
| public MiscellaneousFilesProjectSystem(OmniSharpWorkspace workspace, IFileSystemWatcher fileSystemWatcher, FileSystemHelper fileSystemHelper, | ||
| ILoggerFactory loggerFactory, [ImportMany] IEnumerable<Lazy<IProjectSystem, ProjectSystemMetadata>> projectSystems) | ||
| { | ||
| _workspace = workspace; | ||
| _fileSystemWatcher = fileSystemWatcher; | ||
| _fileSystemHelper = fileSystemHelper; | ||
| _logger = loggerFactory.CreateLogger<MiscellaneousFilesProjectSystem>(); | ||
| _projectSystems = projectSystems | ||
| .Where(ps => ps.Metadata.Name == ProjectSystemNames.MSBuildProjectSystem || | ||
| ps.Metadata.Name == ProjectSystemNames.DotNetProjectSystem) | ||
| .Select(ps => ps.Value) | ||
| .Cast<IWaitableProjectSystem>() | ||
| .ToList(); | ||
| } | ||
|
|
||
| Task<object> IProjectSystem.GetProjectModelAsync(string filePath) | ||
| { | ||
| return Task.FromResult<object>(null); | ||
| } | ||
|
|
||
| Task<object> IProjectSystem.GetWorkspaceModelAsync(WorkspaceInformationRequest request) | ||
| { | ||
| return Task.FromResult<object>(null); | ||
| } | ||
|
|
||
| void IProjectSystem.Initalize(IConfiguration configuration) | ||
| { | ||
| var allFiles = _fileSystemHelper.GetFiles("**/*.cs"); | ||
| foreach (var filePath in allFiles) | ||
| TryAddMiscellaneousFile(filePath); | ||
|
|
||
| _fileSystemWatcher.Watch(miscFileExtension, OnMiscellaneousFileChanged); | ||
| } | ||
|
|
||
| private async void TryAddMiscellaneousFile(string filePath) | ||
| { | ||
| //wait for the project systems to finish processing the updates | ||
| foreach (var projectSystem in _projectSystems) | ||
| { | ||
| await projectSystem.WaitForUpdatesAsync(); | ||
| } | ||
|
|
||
| var absoluteFilePath = new FileInfo(filePath).FullName; | ||
| if (!File.Exists(absoluteFilePath)) | ||
| return; | ||
|
|
||
| if (_workspace.TryAddMiscellaneousDocument(absoluteFilePath, Language) != null) | ||
| { | ||
| _logger.LogInformation($"Successfully added file '{absoluteFilePath}' to workspace"); | ||
| } | ||
| } | ||
|
|
||
| private void OnMiscellaneousFileChanged(string filePath, FileChangeType changeType) | ||
| { | ||
| if (changeType == FileChangeType.Unspecified && File.Exists(filePath) || | ||
| changeType == FileChangeType.Create) | ||
| { | ||
| TryAddMiscellaneousFile(filePath); | ||
| } | ||
|
|
||
| else if (changeType == FileChangeType.Unspecified && !File.Exists(filePath) || | ||
| changeType == FileChangeType.Delete) | ||
| { | ||
| RemoveFromWorkspace(filePath); | ||
| } | ||
| } | ||
|
|
||
| private void RemoveFromWorkspace(string filePath) | ||
| { | ||
| if (_workspace.TryRemoveMiscellaneousDocument(filePath)) | ||
| { | ||
| _logger.LogDebug($"Removed file '{filePath}' from the workspace."); | ||
| } | ||
| } | ||
| } | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| <Project Sdk="Microsoft.NET.Sdk"> | ||
|
|
||
| <PropertyGroup> | ||
| <TargetFramework>net461</TargetFramework> | ||
| <PlatformTarget>AnyCPU</PlatformTarget> | ||
| </PropertyGroup> | ||
|
|
||
| <ItemGroup> | ||
| <PackageReference Include="Microsoft.CodeAnalysis" Version="2.8.2" /> | ||
| </ItemGroup> | ||
|
|
||
| <ItemGroup> | ||
| <ProjectReference Include="..\OmniSharp.Abstractions\OmniSharp.Abstractions.csproj" /> | ||
| <ProjectReference Include="..\OmniSharp.Roslyn\OmniSharp.Roslyn.csproj" /> | ||
| </ItemGroup> | ||
|
|
||
| </Project> |
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
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
why are the project + folder + namespace called
OmniSharp.MiscellaneousFile(singular) but everywhere we refer toMiscellaneousFiles(plural)? I believe for consistency, the project and folder and namespace should be renamed toOmniSharp.MiscellaneousFilestoo