microsoft / microsoft/TypeScript
Allow folding of JSDoc comments
まだ誰も着手していません。
- 主要言語
- Go
- スター
- 111k
- フォーク
- 14.4k
- 平均マージ
- 1日 19時間
- マージ済み PR(30日)
- 117
説明
VsCode version: 1.40.2 (Oct 2019, 2)
OS: Windows 10 v1709 os build 16299.847
TypeScript Version: 3.6.3
Search Terms: vs code fold "app.get" outlining jsdoc comment expressjs folding
Code
/**
* @api {get} /ProjectsList/:projectId/ Get project
*
* @apiDescription Get a project by projectId.
*
* @apiName Get User Projects
* @apiGroup Project
* @apiVersion 1.0.0
*
*/
app.get('/:retailUnit/:language/ProjectsList/:projectId/', retailUnit, (req, res) => {
const projectListController = new ProjectListController();
});
Repro:
- Create file foobar.js, copy paste the code from above.
- Try fold all.
Expected behavior: Comment and method fold
Actual behavior: method fold, comment does not
Expected behavior: I can fold the jsdoc comment above the app.get function
Actual behavior: I cannot fold the jsdoc comment, outlining not available.
Related Issues: Some (incorrectly?) for vs code, but these are the ones I found, but the first one is very similar to this one, but for arrow functions instead:
- https://github.com/microsoft/TypeScript/issues/26014
- https://github.com/Microsoft/vscode/issues/55249
- https://github.com/microsoft/vscode/issues/80186
This is my first report here, I hope it is ok. :-)
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
提供されたJSDocとapp.getの例を使ってfoobar.jsで問題を再現し、その後TypeScript/VS Codeのアウトライン動作を追跡します。Fold Allとコメントの折りたたみコントロールにJSDocブロックが含まれれば完了です。報告では特定のソースファイルもテストも指定されていません。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- javascript, typescript, vscode
- 領域
- tooling
- issue の種類
- 機能追加
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 30/100