GDQuest / GDQuest/GDScript-formatter

Preserve two empty lines when function is commented out

Ouverte
#208 2 commentaires 1 réaction 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Langage dominant
Rust
Étoiles
458
Forks
40
Merge moyen
1 j 15 h
PR mergées (30 j)
4

Description

When you comment out a function in between or after a function, the formatter unnecessarily removes empty lines. Here is an example:

Before:

func f(x: float) -> float:
	return x


func g(x: float) -> float:
	return x


func h(x: float) -> float:
	return x

After commenting out middle function:

func f(x: float) -> float:
	return x

# func g(x: float) -> float:
# 	return x


func h(x: float) -> float:
	return x

This violates the official style guide which says:

Surround functions and class definitions with two blank lines

This also annoyingly bobs functions up and down as you temporarily comment them out, which is not ideal. I assume the problem here is that the formatter treats commented sections following a function as part of the function itself, and thus tries to use a single empty line.

At least on VSCode, comments made with CTRL + / respect the indent level of the commented code. So, it should be possible to detect whether a comment is part of the function or part of a codeblock outside the function using the indent level. However, I am not sure if this convention is universal.

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

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 comportement du formateur avec l’exemple GDScript de l’issue, puis examinez comment les commentaires, l’indentation et les lignes vides sont traités autour des limites des fonctions. Vérifiez si le formateur fait la distinction entre les corps de fonction commentés et les commentaires entre les fonctions. La tâche est terminée lorsque deux lignes vides sont conservées autour de la fonction commentée, tout en maintenant le comportement de formatage existant ailleurs.

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

Évaluation

Stack technique
rust
Domaine
tooling
Type d'issue
Bug
Difficulté
3/5
Temps estimé
1-2 jours
Activité
Calme
Clarté
Plutôt claire
Accessibilité débutants
48/100

Recevez les nouvelles issues par e-mail

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