microsoft / microsoft/TypeScript

Add node flags for blank lines before and after a node

Open
#18,985 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Domain: API In Discussion Suggestion
Dominant language
Go
Stars
111k
Forks
14.3k
Avg merge
2d 4h
Merged PRs (30d)
132

Description

When inserting a node (e.g. during a code fix or refactoring), it would be very helpful if there were a way to say "ensure that there is a blank line following this node", rather than inserting one, since inserting one might result in a pair of blank lines. The determination of whether or not to actually insert a linebreak would be made in the printer.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the printer behavior described in the issue and tracing how nodes are inserted during code fixes or refactoring. The work is done when node-level flags can request a blank line before or after a node and the printer avoids adding duplicate blank lines.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
compilers
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.