Microsoft/TypeScript

Support column limit in formatter

Open

#1,988 opened on Feb 9, 2015

View on GitHub
 (7 comments) (0 reactions) (0 assignees)TypeScript (48,455 stars) (6,726 forks)batch import
Help WantedSuggestion

Description

Currently, running the formatter (eg via the compiler API: https://github.com/Microsoft/TypeScript/wiki/Using-the-Compiler-API#pretty-printer-using-the-ls-formatter) produces code which is arbitrarily wide, for statements which are nested, complex, etc.

Our style guide requires a maximum columns, which means the formatter should take a configuration for how wide this is. Line breaks should probably be added at the highest point in the AST on the long line.

Contributor guide

Tech stack
typescript
Domain
tooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
over 1 week
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.
clear
Prerequisites
TypeScript compilerAST understandingformatter codeNode.js environment
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
25
Research direction
Start by examining the formatting code in the TypeScript compiler, specifically in the src/services/formatting/ directory. Understand how the current formatter works by looking at the 'pretty printer' documentation (https://github.com/Microsoft/TypeScript/wiki/Using the Compiler API#pretty printer using the ls formatter). The 7 comments in the issue may provide additional context or rejected approaches. The goal is to add a configuration option for maximum column width and implement line breaking logic at the highest AST node that exceeds the limit.
Support column limit in formatter · Microsoft/TypeScript#1988 | Good First Issue