Microsoft/TypeScript

Formatter should convert object literal to multiple lines / one line

Open

#25,771 opened on Jul 18, 2018

View on GitHub
 (4 comments) (1 reaction) (0 assignees)TypeScript (48,455 stars) (6,726 forks)batch import
Domain: FormatterHelp WantedSuggestion

Description

TypeScript Version: 3.1.0-dev.20180717

Code

const o = { a: 0, b: 1, c: 2 };

Expected behavior:

A refactor exists to convert to:

const o = {
    a: 0,
    b: 1,
    c: 2,
};

and back.

Actual behavior:

No such refactor. I have to do a lot of manual editing of whitespace.

Contributor guide

Tech stack
typescript
Domain
developer experience
Issue type
feature
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.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
TypeScript formatter internalsAST transformation
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
Investigate the TypeScript formatter source code (src/services/formatting/) to understand how refactoring actions are implemented. Look for existing similar refactors (e.g., add/remove braces) as a pattern. The issue requests a toggle between single line and multi line object literals. Implement the two refactoring actions: 'Convert object to multi line' and 'Convert object to single line'. Ensure the actions appear in the IDE and work correctly for nested objects.
Formatter should convert object literal to multiple lines / one line · Microsoft/TypeScript#25771 | Good First Issue