microsoft / microsoft/TypeScript
Allow files to be excluded from organizeImports
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Go
- Sterne
- 111k
- Forks
- 14.4k
- Ø Merge
- 1 T. 19 Std.
- Gemergte PRs (30 T.)
- 117
Beschreibung
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.
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne damit, die Aktion source.organizeImports und ihre Auswahl der Dateien für die automatisierte Ausführung nachzuverfolgen, und überprüfe anschließend das bestehende Verhalten von sortImports und organizeImports. Definiere einen Ausschlussmechanismus für ausgewählte Dateien und stelle sicher, dass ausgeschlossene Dateien unverändert bleiben, während andere Dateien das aktuelle Bereinigungsverhalten beibehalten.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- typescript
- Bereich
- tooling
- Issue-Typ
- Feature
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Muss geklärt werden
- Anfängerfreundlichkeit
- 35/100