PowerShell / PowerShell/PowerShellEditorServices

Discuss new Framework API structure

Đang mở
#469 12 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Issue-Discussion
Ngôn ngữ chính
C#
Star
767
Fork
266
Merge trung bình
3 ngày 16 giờ
Pull request đã merge (30 ngày)
1

Mô tả

This issue is intended to be a discussion point for the new PowerShell Editor Services API model. The idea here is that Editor Services will now become a framework for adding new capabilities to editors that use it. The overall goal being that most non-core functionality will be enabled through modules that plug into the Editor Services APIs. PSScriptAnalyzer, Plaster, and other modules will add functionality directly through these APIs rather than PSES having to know about them and manage their integration.

Interfaces

All of these interface and method are subject to change as we develop the ideas further.

  • IWorkspace - Provides access to the files in the current workspace and events for when files are opened, closed, changed, or saved
  • ILogger - Writing logs to the Editor Services log. Important for module integrations to log their activities
  • IFileMarkers - Adding markers to files, like those from PSScriptAnalyzer. Also providing quick fixes for these markers
  • IMessageHandlers - Registering message handlers for both Language Server Protocol messages and custom message types
  • ICodeLensProvider - Providing "code lenses" at arbitrary locations in the script which provide information and launch actions at that point
  • IEditorCommands - Registering extension commands in the editor which show up in the command palette
  • ICompletionsProvider - Providing custom completions (and snippets) in addition to the built-in completions and snippets
  • IFileSymbols - Gathering information about symbols in a particular file
  • IWorkspaceSymbols - Gathering information about symbols across the workspace
  • IWindowMessages (?) - Showing messages in the editor window (ShowErrorMessage, etc)
  • IWindowPrompts - Showing prompts natively in the editor's UI, mirrors the prompting functionality in the PSHostUserInterface API
  • IDebuggerCommmands - Provides commands for the debugger, like breaking, stepping, continuing, etc
  • IDebuggerEvents - Exposes events for the debugger, primarily around stopping and resuming
  • IRunspaceEvents - Exposes events for when the active runspace changes, like when a remote session is established
  • ICommandExecution - Commands for executing commands against the current runspace. Also exposes events that give state change information for command execution

TODO: Add more interfaces here

Please feel free to leave comments below to discuss APIs you'd like to see!

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Hướng nghiên cứu

Issue không nêu tệp, kiểm thử hoặc điểm vào nào. Hãy bắt đầu bằng việc xem xét cấu trúc hiện tại của Editor Services API và các đề xuất interface được liệt kê; cuộc thảo luận này chưa hoàn tất cho đến khi phạm vi API cụ thể và mục tiêu triển khai được thống nhất.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
csharp, powershell
Lĩnh vực
api, developer-experience, tooling
Loại issue
Tính năng
Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Cần làm rõ
Mức phù hợp với người mới
20/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.