microsoft / microsoft/TypeScript

Default values for jsconfig.json override extended values

Đang mở
#36,682 4 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Bug Domain: Something Else
Ngôn ngữ chính
Go
Star
111k
Fork
14.4k
Merge trung bình
1 ngày 19 giờ
Pull request đã merge (30 ngày)
117

Mô tả

TypeScript Version: 3.8.0-dev.20200207

Search Terms: jsconfig extend override defaults

Code

// a/jsconfig.json
{
  "files": ["test.js"],
  "compilerOptions": {
    "maxNodeModuleJsDepth": 0
  }
}
// b/jsconfig.json
{
  "extends": "../a/jsconfig.json"
}
// a/test.js
console.log("hello");

Reproduce

mkdir -p a b
echo '{"files":["test.js"],"compilerOptions":{"maxNodeModuleJsDepth":0}}' > a/jsconfig.json
echo '{"extends":"../a/jsconfig.json"}' > b/jsconfig.json
echo 'console.log("hello");' > a/test.js
npx tsc -p a/jsconfig.json --showConfig
npx tsc -p b/jsconfig.json --showConfig

Expected behavior:
Both implied configs A and B have compilerOptions.maxNodeModuleJsDepth: 0.

Actual behavior:
Implied config A has compilerOptions.maxNodeModuleJsDepth: 0.
Implied config B has compilerOptions.maxNodeModuleJsDepth: 2.
Output:

{
    "compilerOptions": {
        "allowJs": true,
        "maxNodeModuleJsDepth": 0,
        "allowSyntheticDefaultImports": true,
        "skipLibCheck": true,
        "noEmit": true
    },
    "files": [
        "./test.js"
    ]
}
{
    "compilerOptions": {
        "allowJs": true,
        "maxNodeModuleJsDepth": 2,
        "allowSyntheticDefaultImports": true,
        "skipLibCheck": true,
        "noEmit": true
    },
    "files": [
        "../a/test.js"
    ]
}

Implied config B has maxNodeModuleJsDepth: 2 despite it extending config A which explicitly sets maxNodeModuleJsDepth: 0.

Possible cause
This may be caused by the default values for config files named jsconfig.json overriding the values from the extended config. maxNodeModuleJsDepth: 2 is one of the default values. See: /src/compiler/commandLineParser.ts#L2459

Solution
Default values for jsconfig.json config files should not override values explicitly defined by the extended configs.

Workaround
Explicitly set the following values in config files named jsconfig.json that extend other configs with non-default values:

  • allowJs
  • maxNodeModuleJsDepth
  • allowSyntheticDefaultImports
  • skipLibCheck
  • noEmit

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

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.

Hướng nghiên cứu

Bắt đầu trong src/compiler/commandLineParser.ts, tại phần xử lý giá trị mặc định của jsconfig được issue đề cập. Tái hiện vấn đề với hai cấu hình và so sánh npx tsc -p ... --showConfig cho từng cấu hình. Công việc được xem là hoàn tất khi các giá trị được định nghĩa rõ ràng từ một cấu hình được mở rộng được giữ nguyên thay vì bị thay thế bằng các giá trị mặc định của jsconfig.

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

Đánh giá

Công nghệ
javascript, typescript
Lĩnh vực
compilers
Loại issue
Lỗi
Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Đặc tả rõ ràng
Mức phù hợp với người mới
30/100

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.