microsoft / microsoft/TypeScript

Allow files to be excluded from organizeImports

Abierto
#54,090 4 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Awaiting More Feedback Suggestion
Lenguaje dominante
Go
Estrellas
111k
Forks
14.3k
Merge medio
1 d 19 h
PR fusionados (30 d)
117

Descripción

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 organizeImports on save
  • Not edit files that organizeImports will break using VS Code
  • Use sortImports and lose the automated cleanup organizeImports provides

None of these workarounds are ideal.

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Comienza siguiendo la acción source.organizeImports y cómo selecciona los archivos para la ejecución automatizada; después, revisa el comportamiento existente de sortImports y organizeImports. Define un mecanismo de exclusión para los archivos seleccionados y verifica que los archivos excluidos no se modifiquen, mientras que los demás archivos mantengan el comportamiento actual de limpieza.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
typescript
Área
tooling
Tipo de issue
Nueva funcionalidad
Dificultad
4/5
Tiempo estimado
3-5 días
Estado de actividad
Estancado
Claridad
Necesita aclaración
Aptitud para principiantes
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.