microsoft / microsoft/vscode-cpptools

[vcFormat] Extra spaces around `=` are removed if `space.aroundAssignmentOperator` is set to `insert`

Aperta
#14,413 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Feature Request Feature: Code Formatting Language Service Visual Studio
Lingua principale
TypeScript
Stelle
6.2k
Fork
1.7k
Merge medio
14h 46m
PR unite (30g)
61

Descrizione

Environment
  • OS and Version: Various (assuming all)
  • VS Code Version: 1.117.0
  • C/C++ Extension Version: 1.31.5
Bug Summary and Steps to Reproduce

Bug Summary:

When C_Cpp.vcFormat.space.aroundAssignmentOperator is set to insert, vcFormat will remove all extra spaces around an assignment operator leaving exactly one space on each side. However, there many times where extra spaces are warranted for the sake of columnar alignment to improve readability.

Therefore, I believe there are two possible solutions to this problem:

  1. Change the behavior of insert so that it only modifies the file by adding a space if no space is present on a side of the assignment operator
  2. Remove the insert and remove options and replace them with the following options (retaining the ignore option):
    • none: Formatter will remove spaces from both sides of the assignment operator
    • one: Formatter will add or remove spaces from both sides of the assignment operator so that the result is one space on each side of the assignment operator
    • oneOrMore: Formatter will only add one space to a side of the assignment operator if zero spaces exist on that side. If one or more spaces exist, the formatter will not make any changes.

Steps to reproduce:

  1. Ensure C_Cpp.vcFormat.space.aroundAssignmentOperator is set to insert
  2. Add the following lines to a .c file:
enum {
    short_name          = 0x00,
    longer_name         = 0x01,
    even_longer_name    = 0x02,
    another_longer_name = 0x04,
    shorter_name        = 0x08,
};
  1. Format the file using vcFormat

Expected behavior:

  • The file should not change

Actual output:

enum {
    short_name = 0x00,
    longer_name = 0x01,
    even_longer_name = 0x02,
    another_longer_name = 0x04,
    shorter_name = 0x08,
};
Configuration and Logs
N/A
Other Extensions

No response

Additional context

No response

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia individuando l'implementazione di vcFormat e i test per C_Cpp.vcFormat.space.aroundAssignmentOperator. Riproduci l'esempio di enum in un file .c con l'impostazione su insert, quindi verifica che il formatter mantenga gli spazi di allineamento esistenti continuando a gestire i lati privi di spazio.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
cpp
Ambito
tooling
Tipo di issue
Bug
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Tranquilla
Chiarezza
Abbastanza chiara
Idoneità per principianti
45/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.