microsoft / microsoft/TypeScript
Allow files to be excluded from organizeImports
まだ誰も着手していません。
- 主要言語
- Go
- スター
- 111k
- フォーク
- 14.4k
- 平均マージ
- 1日 19時間
- マージ済み PR(30日)
- 117
説明
Suggestion
🔍 Search Terms
- organizeImports
✅ Viability 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, new syntax sugar for JS, etc.)
- This feature would agree with the rest of TypeScript's Design Goals.
⭐ Suggestion
I use source.organizeImports as an automated action on save in VS Code. It works great for 99% of my files. However, for some files, it will break my application due to it being destructive. For the 1% of files it will break, I would like source.organizeImports to ignore them.
Would it be possible to add a feature where there is a way to exclude certain files from source.organizeImports to prevent it from running on files it will break?
Thank you!
📃 Motivating Example
In my web application, I have a main.js file that has imports that are not directly used, but needed by other files. The organizeImports feature removes these imports, which breaks my application.
💻 Use Cases
The only workaround for this is to either
- Not automatically run
organizeImportson save - Not edit files that
organizeImportswill break using VS Code - Use
sortImportsand lose the automated cleanuporganizeImportsprovides
None of these workarounds are ideal.
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず source.organizeImports アクションを追跡し、自動実行の対象ファイルをどのように選択しているかを確認します。次に、既存の sortImports と organizeImports の動作を確認します。選択したファイルの除外メカニズムを定義し、除外されたファイルが変更されず、その他のファイルでは現在のクリーンアップ動作が維持されることを検証します。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- typescript
- 領域
- tooling
- issue の種類
- 機能追加
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 活発さ
- 停滞
- 明瞭さ
- 説明が足りない
- 初心者へのやさしさ
- 35/100