rescript-lang/rescript-vscode

Feature request: Code action to convert type to module

Open

#430 opened on May 27, 2022

View on GitHubContributor guide
 (3 comments) (2 reactions) (0 assignees)ReScript (63 forks)github user discovery
enhancementgood first issuehelp wanted

Repository metrics

Stars
 (350 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

It's pretty common in ReScript that you want to add some method to a type and thus want to restructure it into its own submodule.

E.g.

type readState = New | Unread | Read

to

module ReadState = {
  type t = New | Unread | Read
}

I am not sure though, if we should deliberately not allow this action on types named t (which are supposedly already in their own module).

Contributor guide

Research direction
Examine the ReScript language server's AST representation and implement a code action that converts a type declaration into a module containing a type t. Consider the special case when the type is already named t to avoid redundant wrapping.
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.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
GitTypeScriptVSCode extension development
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65