withastro/astro

馃悰 BUG: version 2.8.1 removes trailing comma on save

Open

#14665 opened on Mar 29, 2024

View on GitHub
聽(7 comments)聽(0 reactions)聽(0 assignees)TypeScript聽(59,282 stars)聽(3,444 forks)batch import
good first issuepkg: language-tools

Description

Describe the Bug

When I save an astro file, it removes trailing commas from multi-line function calls.

If I downgrade to version 2.8.0 and save, it adds them back again when I save.

I wonder if it is also related to withastro/language-tools#823 - I found another issue that sounded like it was similarly affected, withastro/language-tools#829 - though the specific fix for that one did not address this one.

Steps to Reproduce

  1. Open any .astro file with multi-line function calls. E.g. 
    foo(
  var1,
  var2,
);
  2. save the file
  3. trailing commas are removed. For the above example it would change to: 
    foo(
  var1,
  var2
);

EDIT: After comments, here is a better example, since the above ends up on a single line which does not have trailing comma:

  someReallyLongNAmeThingThatIsReallyLong(
    someReallyLongVarThatISLongAnd,
    SomeOtherReallyLongThing,
  );

Contributor guide

Tech stack
typescriptnodejs
Domain
frontend
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
TypeScriptAstro
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
Investigate the Astro language server formatting logic, specifically in the Prettier plugin or the internal formatter. Look at the referenced issues withastro/language tools#823 and #829 for related context. Focus on how trailing commas are handled in multi line function calls within .astro files. The bug appears to be a regression in version 2.8.1, so compare the formatting code between versions 2.8.0 and 2.8.1.