PowerShell / PowerShell/PowerShellEditorServices

Discuss new Framework API structure

Abierto
#469 12 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Issue-Discussion
Lenguaje dominante
C#
Estrellas
767
Forks
266
Merge medio
3 d 16 h
PR fusionados (30 d)
1

Descripción

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!

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

El issue no menciona archivos, pruebas ni puntos de entrada. Empieza revisando la estructura actual de la Editor Services API y las propuestas de interfaz enumeradas; esta discusión no estará completa hasta que se hayan acordado un alcance concreto de la API y un objetivo de implementación.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
csharp, powershell
Área
api, developer-experience, tooling
Tipo de issue
Nueva funcionalidad
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Necesita aclaración
Aptitud para principiantes
20/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.