Support declaring @types as the supported route for typings dependencies in the package.json

未關閉
#38,249 8 則留言 1 個 reaction 已指派 0 人 在 GitHub 檢視

還沒有人認領這個 Issue。

評估

難度
5/5
預估耗時
一週以上
新手友好度
32/100
Issue 類型
功能
描述清晰度
需要釐清
活躍度
停滯
技術堆疊
typescript
領域
tooling

研究方向

先檢查 TypeScript 如何讀取 package.json 中繼資料，以及現有的「no types found」路徑；該 issue 未指定原始碼檔案或測試。設計必須先選擇並明確規定套件如何宣告外部 typings 模組及其支援的 semver 範圍，然後驗證 TypeScript 是否能使用該宣告來引導安裝。

由索引模型根據 Issue 內容生成。

描述

In Discussion Needs Proposal Suggestion

Search Terms

package json types field types types module

Suggestion

Allow libraries written in JavaScript to be able to declare that they have types in DT (or other modules), and that they support a certain version of it.

For example:

Express does not support TypeScript but trusts that the DefinitelyTyped express maintainers know what they are doing generally. They want to declare that DT is the way for TypeScript users to get types out of the box. Today that's not really possible.

Examples

Two potential routes:

  1. Override the "types" parameter to support: "types": "@types/express:^3.0" in a package.json

  2. Recommend a new field in the package.json: "typesModule": "@types/express:^3.0" - then when TypeScript normally offers a 'no types found', then it can offer the command to install with the correct semver range.

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.

/cc @wesleytodd @isaacs @ljharb

主要語言
Go
星號
111k
分支
14.4k
平均合併
1 天 19 小時
30 天內合併 PR
117

貢獻指南

開啟貢獻指南

從這裡開始

  1. 先讀完整個 Issue，再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫，在一個分支上完成修改。
  4. 送出 Pull Request，並在描述裡引用這個 Issue 編號。

microsoft/TypeScript 的其他 Issue

查看 microsoft/TypeScript 的全部 Issue

相似的 Issue

更多 Go Issue

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。