microsoft / microsoft/TypeScript
Support go-to-definition on tsconfig mapped paths for non-source files
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Go
- Estrellas
- 111k
- Forks
- 14.4k
- Merge medio
- 1 d 19 h
- PR fusionados (30 d)
- 117
Descripción
Suggestion
The recent change in TypeScript 4.3 to bring go-to-definition support on non-JavaScript file paths is fantastic! I’d love to see this functionality extended to mapped paths defined in tsconfig.json.
🔍 Search Terms
- go-to-definition (and “go to definition”)
- paths
- tsconfig
✅ 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
📃 Motivating Example
As of TypeScript 4.3,
import foo from "../styles/foo.css";
works well when using go-to-definition. This suggestion would make
import bar from "+styles/foo.css";
work just as well, opening up the underlying mapped file.
💻 Use Cases
This would be useful anywhere someone is using mapped paths in their tsconfig.json to shorten relative imports to commonly used directories (like a “styles” directory).
—
Here’s an example of how I imagine this working:
ts-gotodefs-example
├── package.json
├── src
│ ├── css.d.ts
│ └── index.ts
├── styles
│ └── foo.css
├── tsconfig.json
src/index.ts
// go-to-definition works, foo.css opens as of TS 4.3
import foo from "../styles/foo.css";
// this should also open foo.css but as of TS 4.3 it does not
import bar from "+styles/foo.css";
src/css.d.ts
declare module "*.css" {
const classes: { [key: string]: string };
export default classes;
}
tsconfig.json
{
"compilerOptions": {
"rootDir": "src",
"outDir": "lib",
"paths": {
"+styles/*": ["./styles/*"]
}
}
}
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Comienza con el ejemplo de src/index.ts y el mapeo de paths de su tsconfig.json, usando la declaración css.d.ts y el destino styles/foo.css para reproducir el comportamiento actual. Se considera terminado cuando go-to-definition resuelve +styles/foo.css en el archivo mapeado, igual que lo hace con ../styles/foo.css.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- typescript
- Área
- devtools
- Tipo de issue
- Nueva funcionalidad
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Estado de actividad
- Estancado
- Claridad
- Bien especificado
- Aptitud para principiantes
- 35/100