formatting support

Author: TylerLeonhardt

src/PowerShellEditorServices.Engine/LanguageServer/OmnisharpLanguageServer.cs

@@ -73,7 +73,9 @@ public async Task StartAsync()
                     .WithHandler<TextDocumentHandler>()
                     .WithHandler<GetVersionHandler>()
                     .WithHandler<ConfigurationHandler>()
-                    .WithHandler<FoldingRangeHandler>();
+                    .WithHandler<FoldingRangeHandler>()
+                    .WithHandler<DocumentFormattingHandler>()
+                    .WithHandler<DocumentRangeFormattingHandler>();
             });
 
             _serverStart.SetResult(true);

src/PowerShellEditorServices.Engine/Services/TextDocument/Handlers/FormattingHandlers.cs

@@ -0,0 +1,174 @@
+using System;
+using System.Collections.Generic;
+using System.Threading;
+using System.Threading.Tasks;
+using Microsoft.Extensions.Logging;
+using Microsoft.PowerShell.EditorServices;
+using OmniSharp.Extensions.LanguageServer.Protocol.Client.Capabilities;
+using OmniSharp.Extensions.LanguageServer.Protocol.Models;
+using OmniSharp.Extensions.LanguageServer.Protocol.Server;
+
+namespace PowerShellEditorServices.Engine.Services.Handlers
+{
+    public class DocumentFormattingHandler : IDocumentFormattingHandler
+    {
+        private readonly DocumentSelector _documentSelector = new DocumentSelector(
+            new DocumentFilter()
+            {
+                Pattern = "**/*.ps*1"
+            }
+        );
+
+        private readonly ILogger _logger;
+        private readonly AnalysisService _analysisService;
+        private readonly ConfigurationService _configurationService;
+        private readonly WorkspaceService _workspaceService;
+        private DocumentFormattingCapability _capability;
+
+        public DocumentFormattingHandler(ILoggerFactory factory, AnalysisService analysisService, ConfigurationService configurationService, WorkspaceService workspaceService)
+        {
+            _logger = factory.CreateLogger<DocumentFormattingHandler>();
+            _analysisService = analysisService;
+            _configurationService = configurationService;
+            _workspaceService = workspaceService;
+        }
+
+        public TextDocumentRegistrationOptions GetRegistrationOptions()
+        {
+            return new TextDocumentRegistrationOptions
+            {
+                DocumentSelector = _documentSelector
+            };
+        }
+
+        public async Task<TextEditContainer> Handle(DocumentFormattingParams request, CancellationToken cancellationToken)
+        {
+            var scriptFile = _workspaceService.GetFile(request.TextDocument.Uri.ToString());
+            var pssaSettings = _configurationService.CurrentSettings.CodeFormatting.GetPSSASettingsHashtable(
+                (int)request.Options.TabSize,
+                request.Options.InsertSpaces);
+
+
+            // TODO raise an error event in case format returns null;
+            string formattedScript;
+            Range editRange;
+            var extent = scriptFile.ScriptAst.Extent;
+
+            // todo create an extension for converting range to script extent
+            editRange = new Range
+            {
+                Start = new Position
+                {
+                    Line = extent.StartLineNumber - 1,
+                    Character = extent.StartColumnNumber - 1
+                },
+                End = new Position
+                {
+                    Line = extent.EndLineNumber - 1,
+                    Character = extent.EndColumnNumber - 1
+                }
+            };
+
+            formattedScript = await _analysisService.FormatAsync(
+                scriptFile.Contents,
+                pssaSettings,
+                null);
+            formattedScript = formattedScript ?? scriptFile.Contents;
+
+            return new TextEditContainer(new TextEdit
+            {
+                NewText = formattedScript,
+                Range = editRange
+            });
+        }
+
+        public void SetCapability(DocumentFormattingCapability capability)
+        {
+            _capability = capability;
+        }
+    }
+
+    public class DocumentRangeFormattingHandler : IDocumentRangeFormattingHandler
+    {
+        private readonly DocumentSelector _documentSelector = new DocumentSelector(
+            new DocumentFilter()
+            {
+                Pattern = "**/*.ps*1"
+            }
+        );
+
+        private readonly ILogger _logger;
+        private readonly AnalysisService _analysisService;
+        private readonly ConfigurationService _configurationService;
+        private readonly WorkspaceService _workspaceService;
+        private DocumentRangeFormattingCapability _capability;
+
+        public DocumentRangeFormattingHandler(ILoggerFactory factory, AnalysisService analysisService, ConfigurationService configurationService, WorkspaceService workspaceService)
+        {
+            _logger = factory.CreateLogger<DocumentRangeFormattingHandler>();
+            _analysisService = analysisService;
+            _configurationService = configurationService;
+            _workspaceService = workspaceService;
+        }
+
+        public TextDocumentRegistrationOptions GetRegistrationOptions()
+        {
+            return new TextDocumentRegistrationOptions
+            {
+                DocumentSelector = _documentSelector
+            };
+        }
+
+        public async Task<TextEditContainer> Handle(DocumentRangeFormattingParams request, CancellationToken cancellationToken)
+        {
+            var scriptFile = _workspaceService.GetFile(request.TextDocument.Uri.ToString());
+            var pssaSettings = _configurationService.CurrentSettings.CodeFormatting.GetPSSASettingsHashtable(
+                (int)request.Options.TabSize,
+                request.Options.InsertSpaces);
+
+            // TODO raise an error event in case format returns null;
+            string formattedScript;
+            Range editRange;
+            var extent = scriptFile.ScriptAst.Extent;
+
+            // TODO create an extension for converting range to script extent
+            editRange = new Range
+            {
+                Start = new Position
+                {
+                    Line = extent.StartLineNumber - 1,
+                    Character = extent.StartColumnNumber - 1
+                },
+                End = new Position
+                {
+                    Line = extent.EndLineNumber - 1,
+                    Character = extent.EndColumnNumber - 1
+                }
+            };
+
+            Range range = request.Range;
+            var rangeList = range == null ? null : new int[] {
+                (int)range.Start.Line + 1,
+                (int)range.Start.Character + 1,
+                (int)range.End.Line + 1,
+                (int)range.End.Character + 1};
+
+            formattedScript = await _analysisService.FormatAsync(
+                scriptFile.Contents,
+                pssaSettings,
+                rangeList);
+            formattedScript = formattedScript ?? scriptFile.Contents;
+
+            return new TextEditContainer(new TextEdit
+            {
+                NewText = formattedScript,
+                Range = editRange
+            });
+        }
+
+        public void SetCapability(DocumentRangeFormattingCapability capability)
+        {
+            _capability = capability;
+        }
+    }
+}