microsoft / microsoft/TypeScript
Sort jsdoc parameter suggestions by argument position
オープン
初心者向け
まだ誰も着手していません。
Domain: LS: Completion Lists
Good First Issue
Help Wanted
Suggestion
VS Code Tracked
- 主要言語
- Go
- スター
- 111k
- フォーク
- 14.3k
- 平均マージ
- 2日 4時間
- マージ済み PR(30日)
- 132
説明
From https://github.com/Microsoft/vscode/issues/35124
TypeScript Version: 2.7.0-dev.20171116
Code
For the code:
/**
* @param |
*/
function foo(z, a) {}
Trigger completions at the | after @param
Expected behavior:
z is returned first, followed by a. The sortText can be used for this
Actual behavior:
a and z are returned with sort orders weights:
[Trace - 11:33:07 PM] Sending request: completions (176). Response expected: yes. Current queue length: 0
Arguments: {
"file": "/Users/matb/projects/san/y.ts",
"line": 2,
"offset": 11,
"includeExternalModuleExports": true
}
[Trace - 11:33:07 PM] Response received: completions (176). Request took 2 ms. Success: true
Result: [
{
"name": "a",
"kind": "parameter",
"kindModifiers": "",
"sortText": "0"
},
{
"name": "z",
"kind": "parameter",
"kindModifiers": "",
"sortText": "0"
}
]
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
JSDoc @param の候補に対応する TypeScript language service の補完エントリーポイントから始め、function foo(z, a) の例を再現します。パラメーターが引数の位置に従うように補完の順序を調整し、その後、z が a より前に返され、sortText がこの順序を反映していることを確認します。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- typescript
- 領域
- tooling
- issue の種類
- バグ
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 活発さ
- 活発
- 明瞭さ
- 明確に書かれている
- 初心者へのやさしさ
- 72/100