PowerShell / PowerShell/vscode-powershell

Comment-Based Help after function name indents improperly on "Format Document"

Ouverte
#3,926 7 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Area-Code Formatting Issue-Bug
Langage dominant
TypeScript
Étoiles
1.9k
Forks
548
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

Prerequisites
  • I have written a descriptive issue title.
  • I have searched all issues to ensure it has not already been reported.
  • I have read the troubleshooting guide.
  • I am sure this issue is with the extension itself and does not reproduce in a standalone PowerShell instance.
  • I have verified that I am using the latest version of Visual Studio Code and the PowerShell extension.
  • If this is a security issue, I have read the security issue reporting guidance.
Summary

Comment block indents during formatting when it shouldn't. Doesn't occur if block is above the function or if the whole block is already indented.

PowerShell Version
Latest
Visual Studio Code Version
1.67.0-insider
e6d98a13fcd3bf928d0e755eaae873ac200a98bd
x64
Extension Version
ms-vscode.powershell-preview@2022.4.1
Steps to Reproduce
  1. Create Function
  2. Comment based help on same line as function
  3. Format document or format-on-save
Visuals

https://user-images.githubusercontent.com/15258962/163913559-fd6f3949-1f40-433f-820b-6e81e995711c.mp4

Logs

No response

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Reproduisez le problème dans l’extension PowerShell en utilisant un bloc d’aide basé sur des commentaires sur la même ligne qu’une fonction, puis appliquez Format Document et format-on-save. Suivez le comportement de formatage responsable de l’indentation incorrecte et vérifiez que le bloc reste correctement positionné sans provoquer de régression dans les cas décrits dans l’issue.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
powershell, typescript, vscode
Domaine
tooling
Type d'issue
Bug
Difficulté
3/5
Temps estimé
1-2 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.