microsoft / microsoft/TypeScript
Support declaring @types as the supported route for typings dependencies in the package.json
まだ誰も着手していません。
- 主要言語
- Go
- スター
- 111k
- フォーク
- 14.3k
- 平均マージ
- 1日 19時間
- マージ済み PR(30日)
- 117
説明
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:
-
Override the "types" parameter to support:
"types": "@types/express:^3.0"in a package.json -
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
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず、TypeScript が package.json のメタデータをどのように読み取るか、および既存の「no types found」パスを確認してください。この issue ではソースファイルやテストは指定されていません。設計では最初に、パッケージが外部 typings モジュールとそのサポート対象 semver 範囲をどのように宣言するかを決定して明記し、その後、TypeScript がその宣言を使用してインストールを誘導できることを検証する必要があります。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- typescript
- 領域
- tooling
- issue の種類
- 機能追加
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 活発さ
- 停滞
- 明瞭さ
- 説明が足りない
- 初心者へのやさしさ
- 32/100