router-generator: lazy-load Prettier (costs ~300–450ms per build even when formatting is off)

Đang mở Phù hợp với người mới
#8,887 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

@Sheraff đang làm issue này rồi.

Từ ngày 25/10/2026.

  • #8817 của @Sheraff — đang mở
  • #8899 của @EnesKartal — đang mở

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
85/100
Loại issue
Tính năng
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
typescript, vite
Lĩnh vực
build-system, performance

Hướng nghiên cứu

Bắt đầu tại packages/router-generator/src/utils.ts và kiểm tra phần import Prettier ở cấp cao nhất cùng các vị trí gọi format(). Chuyển import vào bên trong format() để tải theo nhu cầu như đề xuất, sau đó chạy các bài kiểm thử của router-generator hoặc các bước kiểm tra build có bao gồm định dạng. Hoàn tất khi các bản build tắt định dạng không còn tải Prettier, còn định dạng vẫn hoạt động khi được bật.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

package: router-generator performance
Which project does this relate to?

Router (@tanstack/router-generator, used by @tanstack/router-plugin and TanStack Start)

Describe the problem

packages/router-generator/src/utils.ts imports Prettier at module top level:

import * as prettier from 'prettier'

Prettier is only used by format(), which runs when enableRouteTreeFormatting is true. Because the import is static, every process that loads the generator pays Prettier's module evaluation, even when formatting is disabled. That includes every vite build and vite dev of a TanStack Start app.

Evidence

V8 CPU profiles (vite build --profile, Vite 8.3.6, @tanstack/[email protected]) of two TanStack Start apps in a large monorepo:

App Build wall time Prettier self time Share
A 13.5s 435ms 3.2%
B 7.7s 282ms 3.6%

Almost all of that time is module evaluation with no JS caller, i.e. it's the import, not formatting work.

Suggested change
  1. Load Prettier lazily inside format():
    async function format(source: string, config: Config) {
      const prettier = await import('prettier')
      // ...
    }
    
    This makes the cost zero when formatting is off, and moves it out of startup when it's on.
  2. Optionally, make formatting pluggable (a formatter option, or a documented stable unformatted output) so projects that format generated files with another tool (oxfmt, Biome, dprint) can turn off Prettier without their committed routeTree.gen.ts churning on every build.

Happy to send a PR for (1) if that direction works for you.

Ngôn ngữ chính
TypeScript
Star
15.3k
Fork
1.9k
Merge trung bình
1 ngày 5 giờ
Pull request đã merge (30 ngày)
46

Chuẩn bị môi trường

Mở trong Codespaces

Khởi chạy dev container của dự án ngay trên trình duyệt, bằng tài khoản GitHub của bạn.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của TanStack/router

Tất cả issue của TanStack/router

Issue tương tự

Thêm issue về TypeScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.