microsoft / microsoft/TypeScript

Refactor to extract a part of type property into a new type

Open
#41,298 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Awaiting More Feedback Suggestion
Dominant language
Go
Stars
111k
Forks
14.3k
Avg merge
2d 4h
Merged PRs (30d)
132

Description

Search Terms

refactor, extract, types, property

Suggestion

It's common to convert a part of properties into new type when we got too many related property.

Could we provide an automatic way to do this?

Examples

//from
interface A {
    /*a*/f1: string
    f2: string/*b*/

    a1: number
}
// to
interface NewType {
    f1: string
    f2: string
}

interface A {
    /*RENAME*/ newProperty: NewType

    a1: number
}


Checklist

My suggestion meets these guidelines:

  • This wouldn't be a breaking change in existing TypeScript/JavaScript code
  • This wouldn't change the runtime behavior of existing JavaScript code
  • This could be implemented without emitting different JS based on the types of the expressions
  • This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, etc.)
  • This feature would agree with the rest of TypeScript's Design Goals.

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

No source files, tests, or entry points are named. Start by reviewing the requested TypeScript interface transformation and existing refactoring capabilities; done would require a defined automatic extraction workflow that produces the illustrated new type and property structure.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
developer-experience, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.