microsoft / microsoft/TypeScript

Allow to specify import sorting.

未关闭
#63,780 6 条评论 10 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

Awaiting More Feedback Suggestion
主要语言
Go
星标
111k
派生
14.3k
平均合并
2 天 4 小时
30 天内合并 PR
132

描述

Typescript has this long running issue full of complaints about how there's no way to prefer certain import paths over others, and in any non-trivially sized application, path aliasing is bound to clash with the various library imports available (hence the practice of having a path alias @/ to get at all first-party application imports).

https://github.com/microsoft/TypeScript/issues/51155

A plugin was suggested multiple times in the above issue, which has a very simple interface to configure around this: https://github.com/tidalhq/ts-plugin-sort-import-suggestions

I think this is something that should be included in tsgo itself, for two reasons:

  • It's not just some fringe preference, everyone at some point will want to prefer certain import path prefixes over others
  • It's an extremely simple thing to implement

I propose being able to add to tsconfig.json a configuration item like this:

{
  "compilerOptions": {
    "importSorting": {
        // Matches `@/`, `../` and `./`, move them up in the suggestions (This is the default config if you leave it empty)
        "moveUpPatterns": ["@/", "\\.{1,2}/"],
        // Move `dist` down in the suggestions, by default it's `[]`
        "moveDownPatterns": ["dist"],
    ]
  },
}

This is a flexible and performant approach that will handle pretty much everyone's needs. I don't know why this was left to be a plugin when it's such a critical piece of an ergonomic Typescript-based development environment.

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

先从链接的 TypeScript issue 和 ts-plugin-sort-import-suggestions 接口开始,然后定位 tsgo 对 import suggestion 的处理以及对 tsconfig.json 选项的解析。完成的标准是:某个编译器选项接受 moveUpPatterns 和 moveDownPatterns,并且 import suggestion 反映这些模式,同时为提议的示例提供覆盖。

由索引模型根据 Issue 内容生成。

评估

技术栈
go, typescript
领域
developer-experience, tooling
Issue 类型
功能
难度
5/5
预计耗时
一周以上
活跃度
停滞
描述清晰度
基本清楚
新手友好度
30/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。