PowerShell / PowerShell/PowerShellEditorServices
Provide diagnostic marker API in $psEditor
Personne n'a encore pris cette issue.
- Langage dominant
- C#
- Étoiles
- 767
- Forks
- 266
- Merge moyen
- 3 j 16 h
- PR mergées (30 j)
- 1
Description
It would be useful if there was an API to add diagnostic markers to script files so that any editor command could add "squigglies" to arbitrary regions of an open file. Markers would be added in relation to a named "layer" which would allow Editor Services to keep track of a unique set of markers for each module or use case.
The API might look something like this:
$file = $context.CurrentFile
# OR: $file = $psEditor.Workspace.GetFile("filePath.ext")
$file.SetMarkers("MarkerLayerName", markerArray)
We should also provide an API for clearing markers, either for a specific layer or for all layers:
$file.ClearMarkers("MarkerLayerName")
$file.ClearMarkers()
Once this API exists, I'll use it to implement the new integration model for PSScriptAnalyzer in issue #213.
FEEDBACK NEEDED: Is SetMarkers good enough or should it be SetFileMarkers, SetDiagnosticMarkers or something else?
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par examiner l’API de fichiers existante de $psEditor et l’issue #213 afin de comprendre comment les marqueurs de diagnostic seraient consommés. Déterminez la conception de la couche de marqueurs et de la nomenclature, puis définissez le comportement de SetMarkers et ClearMarkers pour des régions de fichier arbitraires et pour chaque couche.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- csharp, powershell
- Domaine
- api, developer-experience
- Type d'issue
- Fonctionnalité
- Difficulté
- 5/5
- Temps estimé
- Plus d'une semaine
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 30/100