PowerShell / PowerShell/PowerShellEditorServices
Provide diagnostic marker API in $psEditor
Nessuno ha ancora preso questa issue.
- Lingua principale
- C#
- Stelle
- 767
- Fork
- 266
- Merge medio
- 3g 16h
- PR unite (30g)
- 1
Descrizione
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?
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia esaminando l'API dei file esistente di $psEditor e l'issue #213 per capire come verrebbero utilizzati i marcatori diagnostici. Risolvi il design del livello dei marcatori e della denominazione, quindi definisci il comportamento di SetMarkers e ClearMarkers per regioni arbitrarie dei file e per ogni livello.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- csharp, powershell
- Ambito
- api, developer-experience
- Tipo di issue
- Funzionalità
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 30/100